evergreen-docs:how-to-contribute-documentation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:how-to-contribute-documentation [2022/04/04 14:47] – [Intermediate workflow] aneiman | evergreen-docs:how-to-contribute-documentation [2022/04/04 15:07] – [Automatic build checker] aneiman | ||
---|---|---|---|
Line 33: | Line 33: | ||
- Find the relevant file in the [[https:// | - Find the relevant file in the [[https:// | ||
* Look around until you find the content (note: the directories are mostly logically similar to the online docs table of contents sections, but may require some searching around) | * Look around until you find the content (note: the directories are mostly logically similar to the online docs table of contents sections, but may require some searching around) | ||
- | - Click the pencil ("Edit this file") icon to edit the file in your browser *OR* If you are creating a new file, click the //plus// symbol that displays to the right of file path. Type in the file name. | + | - Click the pencil ("Edit this file") icon to edit the file in your browser *OR* If you are creating a new file, click the Add File button. Type in the file name. |
- Make your changes, using [[http:// | - Make your changes, using [[http:// | ||
- **Test that your AsciiDoc syntax is correct.** This is not required for simple typo corrections. | - **Test that your AsciiDoc syntax is correct.** This is not required for simple typo corrections. | ||
* PREVIEW as HTML: Any file on GitHub with the extension of " | * PREVIEW as HTML: Any file on GitHub with the extension of " | ||
- | * Note that there is now an automatic checker in github that will build a test copy of your docs. | + | * Note that there is now an automatic checker in github that will build a test copy of your docs. Instructions on that are below. |
- Type a message describing your change | - Type a message describing your change | ||
- Click the " | - Click the " | ||
- Click the green " | - Click the green " | ||
- One of the developers will [[evergreen-docs: | - One of the developers will [[evergreen-docs: | ||
- | |||
- | - | ||
A variation of this workflow is described [[https:// | A variation of this workflow is described [[https:// | ||
+ | |||
+ | ===== Automatic build checker ===== | ||
+ | |||
+ | As of 2021, Evergreen' | ||
+ | |||
+ | To access the test build file: | ||
+ | |||
+ | - Click on an existing pull request | ||
+ | - Select the tab labelled " | ||
+ | - In the upper left, select the dropdown labelled " | ||
+ | - Click the file built-docs to download a zipped copy of the docs build | ||
+ | - Unzip the file and double-click on index.html in the extracted folder. This will open a preview version of the Antora docs pages in your browser. | ||
+ | * On Windows, the address bar will read < | ||
+ | * You can search and navigate around the docs but note that the version dropdown doesn' | ||
+ | - Search for the file(s) you've added or changed, and click around them to make sure everything looks and works as expected. | ||
+ | |||
+ | {{: | ||
evergreen-docs/how-to-contribute-documentation.txt · Last modified: 2023/06/01 12:13 by gmcharlton