Differences

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

--- evergreen-docs:how-to-contribute-documentation [2018/11/09 10:06] – [Beginner workflow] rjs7
+++ evergreen-docs:how-to-contribute-documentation [2020/10/27 12:53] – aneiman
@@ Line 4: / Line 4: @@
 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 20: / Line 22: @@
     * URL of the documentation web page that needs to be updated
     * The part of the web page you are referring to (e.g. section heading, paragraph number, a nearby phrase, etc.)
+==== Beginner workflow with Launchpad ====
+  * You may use Launchpad to report any errors or missing items you find in the documentation.
+    * Go to https://bugs.launchpad.net/evergreen/+filebug to sign up for a Launchpad account and report the problem.
+    * Add the tag "documentation" to your report.
 ==== Intermediate workflow ====
@@ Line 65: / 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.