Get SaaS docs started #4224
Merged
Get SaaS docs started #4224
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
✅ Deploy Preview for chef-web-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
IanMadd
commented
Apr 10, 2024
There was a problem hiding this comment.
General review:
- Use the full name when referring to OpsWorks: AWS OpsWorks
- Use proper product names for Chef products
- Review how to write procedures and update procedures to match this guide.
This includes writing headings for procedures, steps in procedures, starting procedures, and conclude them. - Review capitalization rules and update to match https://developers.google.com/style/capitalization
- Review the page output. Some of the procedures aren't rendering correctly.
- Don't use "below" or "above" to refer to commands or code examples in text. Using "following" or "previous".
- Don't create links out of example URLs. Format those as code.
- Filenames and file paths should be formatted as code.
- Use present tense. Only use future tense ("will") or past tense if it's in the future or past from the user's perspective.
- Headings should be in sentence case.
You'll also have to correct the Buildkite failures. It's just incorrectly included characters that should be replaced with plaintext characters. I can walk you through that when the rest is take care of.
IanMadd
commented
May 28, 2024
IanMadd
commented
May 28, 2024
IanMadd
force-pushed
the
im/saas
branch
5 times, most recently
from
211b93a
to
67a286f
Compare
IanMadd
commented
Jun 10, 2024
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: dishanktiwari2501 <dtiwari@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
|
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.
Description
Get started with SaaS docs.
https://chefio.atlassian.net/browse/CHEF-9588
Definition of Done
Issues Resolved
[List any existing issues this PR resolves, or any Discourse or
StackOverflow discussion that's relevant]
Related PRs
Check List