Documentation updates #9460
Merged
Documentation updates #9460
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates based on feedback: 1. Avoid making promises about future releases ... (so) avoid the word "yet." 2. We assume that users are reading the documentation while they use the product, so we write in the present tense. 3. Avoid the "Note" label because it doesn't tell users anything about the content of the note. Users can't tell whether the note will present crucial information or be just a tip. In this case, we could use the "Important" or "Restriction" label instead.
|
This is based on feedback in https://github.com/puppetlabs/osp-docs/pull/353 |
mhashizume
approved these changes
Aug 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates based on feedback:
Avoid making promises about future releases ... (so) avoid the word "yet."
We assume that users are reading the documentation while they use the product, so we write in the present tense.
Avoid the "Note" label because it doesn't tell users anything about the content of the note. Users can't tell whether the note will present crucial information or be just a tip. In this case, we could use the "Important" or "Restriction" label instead.