Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: drop weasel words #22165

Merged
merged 8 commits into from
May 29, 2023
Merged

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented May 13, 2023

Changes

  • Drop weasel words like easy, painless, straightforward, trivial, simple and just
  • Rewrite some sentences where needed

Context

Our docs should not imply that something is easy or simple. If we need docs to explain something, it's certainly not easy.

I kept the "weasel words" in direct quotes and user stories, to stay true to the author's voice.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

docs/development/minimal-reproductions.md Outdated Show resolved Hide resolved
docs/development/best-practices.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Show resolved Hide resolved
docs/usage/configuration-options.md Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
docs/usage/examples/self-hosting.md Outdated Show resolved Hide resolved
docs/usage/getting-started/private-packages.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
lib/modules/manager/regex/readme.md Outdated Show resolved Hide resolved
@HonkingGoose HonkingGoose requested a review from rarkins May 13, 2023 13:46
docs/development/best-practices.md Outdated Show resolved Hide resolved
docs/development/minimal-reproductions.md Outdated Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@HonkingGoose
Copy link
Collaborator Author

@rarkins I still need some help from you with some review comments. 😉

lib/modules/manager/regex/readme.md Outdated Show resolved Hide resolved
lib/modules/manager/regex/readme.md Outdated Show resolved Hide resolved
@rarkins rarkins marked this pull request as ready for review May 29, 2023 04:09
@rarkins rarkins enabled auto-merge May 29, 2023 04:10
rarkins
rarkins previously approved these changes May 29, 2023
auto-merge was automatically disabled May 29, 2023 07:58

Head branch was pushed to by a user without write access

@rarkins rarkins enabled auto-merge May 29, 2023 07:59
@rarkins rarkins added this pull request to the merge queue May 29, 2023
Merged via the queue into renovatebot:main with commit b08fa0c May 29, 2023
11 checks passed
@HonkingGoose HonkingGoose deleted the docs/drop-weasel-words branch May 29, 2023 08:58
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 35.105.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants