#15826 Bring in-repo docs to production standard/reduce manual steps
Issue created by
chrisjrn
Following
#15811, currently the in-repo docs are in a proof-of-concept stage with a lot of manual work. These should be automated as we become more familiar with readme's tooling. In particular we should make the code review & merging process a lot more streamlined -- currently Pants' full CI suite runs against PRs with only docs changes, which can be quite slow.
Here are the remaining tasks that I can think of:
• Add continuous deployment step for merged PRs containing docs changes
• Add documentation for how to add a new page to docs
• Add CI process for docs; including rules for excluding code CI steps when only docs have changed
• Document PR review standards for documentation (i.e. when a documentation change should be expected)
• simplify pushing to the correct readme branch/add some small scripts or aliases to make sure that we run the correct
rdme
commands
pantsbuild/pants