Differences

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

--- evergreen-docs:how-to-contribute-documentation [2019/04/24 15:39] – [Beginner workflow] katiegmartin
+++ evergreen-docs:how-to-contribute-documentation [2021/07/08 14:14] – aneiman
@@ Line 1: / Line 1: @@
 ===== How to Contribute Documentation to the Repository =====
-First of all, you are welcome to email the Documentation Listserv ([[open-ils-documentation@list.georgialibraries.org]]) with problems you find in the documentation.  However, we welcome you to participate in the process of improving things.  Below are various ways you can contribute your time and skills.
+First of all, you are welcome to email the Documentation Listserv ([[evergreen-documentation@list.evergreen-ils.org]]) with problems you find in the documentation.  However, we welcome you to participate in the process of improving things.  Below are various ways you can contribute your time and skills.
 We use [[http://git-scm.com/|Git]] for version control on documentation. The official repository is housed on the Evergreen git server [[http://git.evergreen-ils.org/?p=Evergreen.git;a=tree;f=docs;hb=HEAD|git.evergreen-ils.org]].
+FIXME is the below statement still accurate? I know the PDF / HTML part is not, but curious about the rebuild timing.
 **Note**: Changes to the official repository are processed into HTML, PDF and ePub daily at 1pm and 11pm. (see http://docs.evergreen-ils.org/)
@@ Line 9: / Line 11: @@
 ==== Beginner workflow ====
-  * Send your documentation changes in any format to the Documentation Interest Group (DIG) email list: <open-ils-documentation@list.georgialibraries.org>
+  * Send your documentation changes in any format to the Documentation Interest Group (DIG) email list: <evergreen-documentation@list.evergreen-ils.org>
   * **Valuable contributions include:**
     * Telling us about anything that seems wrong
@@ Line 48: / Line 50: @@
 ==== Advanced workflow ====
-This workflow is primarily for the few DIG members with permission to push to the master repository. If you do not have permission yet, you can start the request process by contacting the Git Admins group <gitadmin@evergreen-ils.org>. You can also push to another public repository, such as the Evergreen working repository or another host such as GitHub.  Then email the DIG email list <open-ils-documentation@list.georgialibraries.org> with the location of your repository so they can pull your changes into master.
+This workflow is primarily for the few DIG members with permission to push to the master repository. If you do not have permission yet, you can start the request process by contacting the Git Admins group <gitadmin@evergreen-ils.org>. You can also push to another public repository, such as the Evergreen working repository or another host such as GitHub.  Then email the DIG email list <evergreen-documentation@list.evergreen-ils.org> with the location of your repository so they can pull your changes into master.
 === Command line version ===
@@ Line 72: / Line 74: @@
   - Make changes to files, remove files, add new files
-After you've made your changes, make sure that your documentation is included in the appropriate manual(s).  To do this, make sure that there is a ''include::path/to/documentation.adoc[]'' statement in the appropriate ''root_*.adoc'' file (e.g. ''root_circulation.adoc'' for the circulation manual).
+After you've made your changes, make sure that your documentation is included in the appropriate module(s).  To do this, make sure that there is a cross reference statement like ''%%**%% xref:acquisitions:acquisitions_search.adoc[Acquisitions Search]'' in the appropriate ''nav.adoc'' file (e.g. ''docs/modules/acquisitions/nav.adoc'' for the Acquisitions module).
+FIXME the test build instructions need to be updated for Antora.
 Then **test building the various output formats**.  The following examples use the Circulation manual, but you will want the filename ''root_circulation.adoc'' to match the manual you are trying to test.