[docs] Add detailed documentation guidelines#3433
[docs] Add detailed documentation guidelines#3433colleenmcginnis merged 9 commits intoelastic:mainfrom
Conversation
|
@bmorelli25 do you want to take a first look and then tag in others who should review? |
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
🤖 GitHub commentsTo re-run your PR in the CI, just comment with:
|
🌐 Coverage report
|
bmorelli25
left a comment
There was a problem hiding this comment.
I think this document does a great job outlining the structure you came up with for https://github.com/elastic/observability-docs/issues/1019.
Like DeDe mentioned in today's meeting, and once the dev team weighs in, it'd be great to eventually automate the creation of a readme template. In the meantime, it might help to add a complete template to these docs that can easily be copy/pasted.
jsoriano
left a comment
There was a problem hiding this comment.
Nice, thanks!
Added some comments about the use of "data types" terms.
|
@jamiehynds can you please take a look at these proposed guidelines? Thanks! |
update generated docs
* first draft of system integration edits wording * update changelog, update manifest, build README * clean up changelog.yml * address feedback from @bmorelli25 * align with guidelines in #3433
* first draft of aws integration edits * update changelog, update manifest, build README * actually build READMEs * address feedback from @bmorelli25 * remove relative links * updated generated READMEs * address feedback on build errors * align with guidelines in #3433 update generated docs * address feedback from @kaiyan-sheng
* first draft of windows integration edits * update changelog, update manifest, build README * address initial feedback * address feedback from @andrewkroh * align with guidelines in #3433
* first draft of linux metrics integration edits * Update packages/linux/changelog.yml * align with guidelines in #3433
|
Thanks for your comments @jamiehynds! There are a few remaining comments to be resolved, but I don't have enough context to propose general language/guidelines for them. Do you want to continue iterating here or accept the current guidelines and open issues to track the remaining comments? |
Sorry for the delay here @colleenmcginnis. I think I've responded to the outstanding comments. If you prefer to close this issue and open issues to track any remaining comments, totally fine with me. |
|
@bmorelli25 @jamiehynds @jsoriano do you have any other thoughts or suggestions? If not, can someone please give me an official ✅ ? I opened three issues to track follow-up work: |
bmorelli25
left a comment
There was a problem hiding this comment.
This is fantastic! Great work, @colleenmcginnis.
|
/test |
* first draft of nginx integration edits * add pr link * align with guidelines in #3433 * address feedback from @ishleenk17
What does this PR do?
From https://github.com/elastic/observability-docs/issues/1019:
This PR proposes updated and more detailed documentation guidelines based on my experience adding context to the top five integrations in #3306, #3352, #3308, #3359, and #3393.
Guidelines like this can help standardize the structure and language across integrations, which may reduce friction for users who are interested in using more than one integration. But, they are also just guidelines and can be altered on a case-by-case basis as needed.
For the reviewer
Checklist
changelog.ymlfile.Author's Checklist
Related issues