Differences

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

--- evergreen-docs:how-to-contribute-documentation [2021/07/08 18:03] – Integrating the Antora build procedure bmagic
+++ evergreen-docs:how-to-contribute-documentation [2022/04/04 14:47] – [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
+  - 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.
-  - If you are creating a new file, click the //plus// symbol that displays to the right of file path.Type in the file name. {{:evergreen-docs:github-create.png}}
   - 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.
        * PREVIEW as HTML: Any file on GitHub with the extension of ".adoc" should auto-display the HTML version of the file when previewed or saved. Then you can proofread your document and look for anything strange.
+       * Note that there is now an automatic checker in github that will build a test copy of your docs.
   - Type a message describing your change
   - Click the "Propose file change" button
   - Click the green "Create pull request" button
   - One of the developers will [[evergreen-docs:github-workflow|review your change]] and send you feedback
+  -
 A variation of this workflow is described [[https://youtu.be/XiVjO_S0Y-s|in this YouTube video]].