docs: add documentation contribution instructions #6294
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6294 +/- ##
============================================
- Coverage 80.38% 76.53% -3.85%
============================================
Files 202 248 +46
Lines 19620 25943 +6323
Branches 1176 1449 +273
============================================
+ Hits 15771 19855 +4084
- Misses 3821 6058 +2237
- Partials 28 30 +2 |
This comment was marked as off-topic.
This comment was marked as off-topic.
|
LGTM! 🚀 |
| @@ -229,6 +229,20 @@ Run script to download dashboards to `./dashboards` folder | |||
| node scripts/download_dashboards.mjs | |||
| ``` | |||
|
|
|||
| ## Contributing to Documentation | |||
|
|
|||
| When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. For first time documentation contributors, install the python dependencies with `yarn docs:install`. Build the documentation locally with `yarn docs:build` and serve with `yarn docs:serve` | |||
There was a problem hiding this comment.
to clarify yarn docs:build just builds part of the docs, namely the CLI references, if there are no updates to those I don't think this step is required. It also copies some files over to docs dir, so has to be run at least once. Might be fine how we documented it here though.
yarn docs:serve will watch for changes and hot reload the UI
There was a problem hiding this comment.
Might be fine how we documented it here though.
Yea I agree. Just high level description here in CONTRIBUTING.md. For details of command usage, contributors will need to look deeper.
There was a problem hiding this comment.
@nflaig I think its a nice to have for those that do not know there are generated sections. Perhaps a comment that it only needs to be run once but having it noted seems important to me.
There was a problem hiding this comment.
I think it's always better to include too much than too little, even if one step is not always required, executing it won't hurt, it'll just be redundant, but it covers all cases if they just do it every time.
* add documentation contribution instructions * docs contribution to include cmd and wordlist * spell check documentation * add wordlist check script * word list correction * incorporate feedback
|
🎉 This PR is included in v1.15.0 🎉 |
Motivation
This PR is to persist the instructions for building docs locally for revision before submission.
Description
This PR modifies contribution.md to include the reference details for future contributors.