User Tools

Site Tools


evergreen-docs:how-to-contribute-documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
evergreen-docs:how-to-contribute-documentation [2022/04/04 15:06] aneimanevergreen-docs:how-to-contribute-documentation [2022/04/04 15:18] – [Intermediate workflow] aneiman
Line 33: Line 33:
   - Find the relevant file in the [[https://github.com/evergreen-library-system/Evergreen/tree/master/docs|GitHub repository]]   - Find the relevant file in the [[https://github.com/evergreen-library-system/Evergreen/tree/master/docs|GitHub repository]]
     * 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 **OR** If you are creating a new file, click the Add File button. Type in the file name. Make sure you are in the correct directory.
   - Make your changes, using [[http://powerman.name/doc/asciidoc|correct AsciiDoc format]].   - Make your changes, using [[http://powerman.name/doc/asciidoc|correct AsciiDoc format]].
   - **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 45: Line 45:
 A variation of this workflow is described [[https://youtu.be/XiVjO_S0Y-s|in this YouTube video]]. A variation of this workflow is described [[https://youtu.be/XiVjO_S0Y-s|in this YouTube video]].
  
-==== Automatic build checker ====+=== Automatic build checker ===
  
 As of 2021, Evergreen's github repository contains a tool that will build a full Antora-ized copy of the docs whenever someone opens a github pulllrequest that includes documentation changes. You can download this copy and view it in your browser to make sure things like image files and internal links are operating correctly. As of 2021, Evergreen's github repository contains a tool that will build a full Antora-ized copy of the docs whenever someone opens a github pulllrequest that includes documentation changes. You can download this copy and view it in your browser to make sure things like image files and internal links are operating correctly.
Line 60: Line 60:
   - 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.
  
-{{:evergreen-docs:built-docs_1_.gif?400|}} +Click on the image below to see a screencast of this process (credit: Jane Sandberg) 
- + 
 +{{:evergreen-docs:built-docs_1_.gif?direct&200|}}
  
  
evergreen-docs/how-to-contribute-documentation.txt · Last modified: 2023/06/01 12:13 by gmcharlton

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.