evergreen-docs:github-workflow
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
evergreen-docs:github-workflow [2022/02/10 13:34] – external edit 127.0.0.1 | evergreen-docs:github-workflow [2022/05/12 09:23] – review github's built docs, rather than compiling the docs yourself sandbergja | ||
---|---|---|---|
Line 3: | Line 3: | ||
When someone [[evergreen-docs: | When someone [[evergreen-docs: | ||
- | | + | ===== Reviewing the pull request ===== |
- | - If you haven' | + | |
+ | | ||
+ | - Open the pull request in the Github web interface. | ||
+ | - Open the Files Changed tab | ||
+ | - Make sure the asciidoc changes look good | ||
+ | - Open the Checks tab | ||
+ | - Expand the " | ||
+ | - Open the Artifacts menu and select built-docs | ||
+ | - Unzip the artifact and open it in your browser. | ||
+ | - Check to make sure that the expected changes look good in the built docs, and that there are no unexpected changes. | ||
+ | |||
+ | |||
+ | ===== Committing the changes ===== | ||
+ | |||
+ | If everything looks good: | ||
+ | |||
+ | - On the commits tab, note how many new commits are in the pull request -- you will need this information later. | ||
+ | - In your terminal, if you haven' | ||
- '' | - '' | ||
- Update your local master branch to reflect any changes from " | - Update your local master branch to reflect any changes from " | ||
Line 14: | Line 31: | ||
- If more than one: '' | - If more than one: '' | ||
- The '' | - The '' | ||
- | - Test build the changed AsciiDoc file + the nav.adoc file(s) that include it | ||
- | - '' | ||
- | - Check to see if there are any images posted to the Github conversation that have not been committed yet. Add those to '' | ||
- | - Also look for other AsciiDoc warnings or errors | ||
- Make any corrections (via additional commits, if needed) | - Make any corrections (via additional commits, if needed) | ||
- Use '' | - Use '' |
evergreen-docs/github-workflow.txt · Last modified: 2023/12/28 15:54 by aneiman