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: improve Docker documentation #7925

Merged
merged 33 commits into from Dec 12, 2020
Merged

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Dec 9, 2020

Changes:

Big:

  • Rewrite to use simpler version number where possible
  • Use myimage instead of node for version number examples
  • Use latest SHA256 digest for Node 14.15.1 in examples
  • Rewrite some sections to be more clear and use simpler language
  • Bigger rewrites to improve clarity and simplicity

Smaller:

  • Capitalize noun SemVer
  • Fix white-space in list items, use 1.'s to number items
  • Always use word files at end of list item
  • Mention docker-compose.yml by name in list item
  • Use active voice style for list items
  • Use American English spelling for word behavior
  • Fix typos
  • Change h5 headings to h3 level headings

Context:

Helps with issue #7626.

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 tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • Unit tests + ran on a real repository

@HonkingGoose HonkingGoose mentioned this pull request Dec 9, 2020
52 tasks
docs/usage/docker.md Outdated Show resolved Hide resolved
@HonkingGoose

This comment has been minimized.

docs/usage/docker.md Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
docs/usage/docker.md Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
@HonkingGoose HonkingGoose marked this pull request as ready for review December 11, 2020 13:57
@HonkingGoose
Copy link
Collaborator Author

@rarkins This is ready for another round of review. 😄 Can you check my work with the version numbers, and see if it makes sense to you?

I've also rewritten the confusing section that mentioned why you should switch from major only tags to major.minor.patch tags, so that you can see what the Renovate PR is going to change. I'm looking forward to your feedback/suggestions to make this text better if needed.

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.

Use myimage instead of node in examples. Any similar name would suffice too - let's just use one that is not known to the user already and is clearly a "dummy" name

docs/usage/docker.md Outdated Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
docs/usage/docker.md Outdated Show resolved Hide resolved
@HonkingGoose
Copy link
Collaborator Author

Use myimage instead of node in examples. Any similar name would suffice too - let's just use one that is not known to the user already and is clearly a "dummy" name

That was a really good idea, it's way clearer now. Thanks! 😄

@HonkingGoose
Copy link
Collaborator Author

HonkingGoose commented Dec 12, 2020

I'll go fix the merge conflict 😄.


Edit: it's fixed now.

@rarkins rarkins merged commit 40a75d6 into renovatebot:master Dec 12, 2020
@HonkingGoose HonkingGoose deleted the docs/docker branch December 12, 2020 19:58
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 24.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 13, 2021
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

4 participants