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 revisionLast revisionBoth sides next revision | ||
evergreen-docs:how-to-contribute-documentation [2022/04/04 15:02] – [Intermediate workflow] aneiman | evergreen-docs:how-to-contribute-documentation [2022/04/04 15:22] – [Intermediate workflow] 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 Add File button. Type in the file name. | + | - Click the pencil ("Edit this file") icon to edit the file in your browser |
- 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. | ||
Line 44: | Line 44: | ||
A variation of this workflow is described [[https:// | A variation of this workflow is described [[https:// | ||
+ | An alternative of the above workflow using GitHub Desktop is [[https:// | ||
- | ==== Automatic build checker | + | === Automatic build checker === |
As of 2021, Evergreen' | As of 2021, Evergreen' | ||
Line 56: | Line 57: | ||
- Click the file built-docs to download a zipped copy of the docs build | - 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. | - 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 "file:/// | + | * On Windows, the address bar will read < |
* You can search and navigate around the docs but note that the version dropdown doesn' | * 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. | - Search for the file(s) you've added or changed, and click around them to make sure everything looks and works as expected. | ||
- | {{: | + | Click on the image below to see a screencast of this process (credit: Jane Sandberg) |
- | + | ||
+ | {{: | ||
evergreen-docs/how-to-contribute-documentation.txt · Last modified: 2023/06/01 12:13 by gmcharlton