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: Proofreading + general improvements #26442

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

kvanzuijlen
Copy link
Contributor

Changes

I did some proofreading and some miscellaneous improvements (IMO)

Context

I noticed some typos in the docs, so I decided to have a better look at all the files.

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

@kvanzuijlen kvanzuijlen marked this pull request as ready for review December 28, 2023 04:36
Signed-off-by: kvanzuijlen <8818390+kvanzuijlen@users.noreply.github.com>
Signed-off-by: kvanzuijlen <8818390+kvanzuijlen@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually like most of your changes, even though I'm suggesting a lot of changes... 🙃

Please go to the Files changed tab on GitHub, and batch my suggestions. Do not apply my suggestions one by one!

Read the GitHub Docs, to learn how to batch apply suggestions.

Please also make sure to revert the ordered lists to this format:

1. First item
1. Second item
1. Third item
1. And so on

docs/development/branches-commits.md Outdated Show resolved Hide resolved
docs/development/creating-editing-renovate-presets.md Outdated Show resolved Hide resolved
docs/development/creating-editing-renovate-presets.md Outdated Show resolved Hide resolved
docs/development/creating-editing-renovate-presets.md Outdated Show resolved Hide resolved
docs/development/creating-editing-renovate-presets.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/troubleshooting.md Outdated Show resolved Hide resolved
@HonkingGoose
Copy link
Collaborator

Also, please do not force push to this branch. We squash-merge later, so the PR title becomes the final commit message.

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Contributor Author

@kvanzuijlen kvanzuijlen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the in-depth review @HonkingGoose! Some really good points that were great improvements on lines I only checked for grammar, thanks!

docs/usage/config-presets.md Outdated Show resolved Hide resolved
docs/development/design-decisions.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/examples/self-hosting.md Outdated Show resolved Hide resolved
docs/usage/dependency-pinning.md Outdated Show resolved Hide resolved
docs/development/design-decisions.md Show resolved Hide resolved
docs/development/local-development.md Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
Signed-off-by: kvanzuijlen <8818390+kvanzuijlen@users.noreply.github.com>
Signed-off-by: kvanzuijlen <8818390+kvanzuijlen@users.noreply.github.com>
@kvanzuijlen
Copy link
Contributor Author

kvanzuijlen commented Dec 28, 2023

@HonkingGoose I updated all lists to follow the styling guide as added by you in #26445. I also reverted the quotes I edited by mistake.

@kvanzuijlen
Copy link
Contributor Author

Merge-conflict resolved due to an overlapping change in #26478

@kvanzuijlen
Copy link
Contributor Author

@HonkingGoose Can you resolve the conversations that are done/resolved? Might be easier to read for the maintainers that way.

@HonkingGoose
Copy link
Collaborator

@kvanzuijlen I don't have write rights to this repository. So only the maintainers can resolve discussions. 🙂

@viceice
Copy link
Member

viceice commented Jan 3, 2024

@kvanzuijlen you can resolve discussions yourself when they are done

@kvanzuijlen
Copy link
Contributor Author

Completely overlooked that, as well as the fact that there were some more comments... Thanks!

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@astellingwerf
Copy link
Collaborator

Goedemiddag @kvanzuijlen. I see you collapsed a considerable amount of "you are", "they will", and "do not" into "you're", "they'll", and "don't" respectively. Why was that? Renovate aims for a wide audience with a diverse level of proficiency in English. The explicit version may be more accessible.

@kvanzuijlen
Copy link
Contributor Author

Goedemiddag @kvanzuijlen. I see you collapsed a considerable amount of "you are", "they will", and "do not" into "you're", "they'll", and "don't" respectively. Why was that? Renovate aims for a wide audience with a diverse level of proficiency in English. The explicit version may be more accessible.

It makes it easier to read for me personally (sounds more natural), but I can see the other side of things as well, so I'm fine if it should be reverted as well.

@rarkins
Copy link
Collaborator

rarkins commented Jan 11, 2024

@kvanzuijlen yes,
Please revert the contractions changes

@kvanzuijlen
Copy link
Contributor Author

@kvanzuijlen yes, Please revert the contractions changes

Do you also want me to change existing contractions?

@rarkins
Copy link
Collaborator

rarkins commented Jan 11, 2024

@kvanzuijlen yes, Please revert the contractions changes

Do you also want me to change existing contractions?

If you think there are others which could be more "simply" understandable then please go ahead, but otherwise it's not essential if you prefer not. Thanks!

Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requires deconflicting

@rarkins
Copy link
Collaborator

rarkins commented Mar 1, 2024

@HonkingGoose do you approve?

Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nearly ready:

  • Needs maintainer input for some questions
  • Some small typo fixes and style changes

Be sure to expand the large file diffs, because some comments are "hiding" there. 😉

docs/development/local-development.md Show resolved Hide resolved
docs/development/local-development.md Show resolved Hide resolved
docs/development/local-development.md Show resolved Hide resolved
docs/development/minimal-reproductions.md Outdated Show resolved Hide resolved
docs/development/new-package-manager-template.md Outdated Show resolved Hide resolved
docs/usage/examples/self-hosting.md Outdated Show resolved Hide resolved
docs/usage/golang.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/noise-reduction.md Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
@kvanzuijlen
Copy link
Contributor Author

@rarkins can you decide on the questions put forward by @HonkingGoose? I'll deconflict the PR afterward and make the necessary changes!

Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs deconflicting. Please see my comments within the Conversations

rarkins and others added 2 commits May 7, 2024 06:59
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@rarkins
Copy link
Collaborator

rarkins commented May 7, 2024

Needs git conflicts resolved

@kvanzuijlen
Copy link
Contributor Author

Hi,

Sorry for my absence. I'll have a look at this later today.

@kvanzuijlen
Copy link
Contributor Author

It took me a bit longer to look into it, sorry about that. I'm looking into it right now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants