Differences

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

--- evergreen-docs:how-to-contribute-documentation [2022/04/04 15:07] – [Automatic build checker] 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://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)
-  - 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]].
   - **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://youtu.be/XiVjO_S0Y-s|in this YouTube video]].
+An alternative of the above workflow using GitHub Desktop is [[https://docs.evergreen-ils.org/eg/docs/latest/shared/how_to_contribute_docs.html|here]]
-===== 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.
@@ Line 60: / Line 61: @@
   - 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?direct&400|}}
+Click on the image below to see a screencast of this process (credit: Jane Sandberg)
+{{:evergreen-docs:built-docs_1_.gif?direct&200|}}