evergreen-docs:how-to-contribute-documentation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:how-to-contribute-documentation [2018/09/17 18:53] – [Intermediate workflow] sandbergja | evergreen-docs:how-to-contribute-documentation [2020/10/27 12:53] – aneiman | ||
---|---|---|---|
Line 3: | Line 3: | ||
First of all, you are welcome to email the Documentation Listserv ([[open-ils-documentation@list.georgialibraries.org]]) with problems you find in the documentation. | First of all, you are welcome to email the Documentation Listserv ([[open-ils-documentation@list.georgialibraries.org]]) with problems you find in the documentation. | ||
- | We use [[http:// | + | We use [[http:// |
- | **Note**: Changes to the official repository are processed into HTML, PDF and ePub daily at 1pm and 11pm. (see http:// | + | FIXME is the below statement still accurate? I know the PDF / HTML part is not, but curious about the rebuild timing. |
- | **Note**: | + | **Note**: |
- | * [[http://git.evergreen-ils.org/? | + | |
==== Beginner workflow ==== | ==== Beginner workflow ==== | ||
Line 14: | Line 13: | ||
* Send your documentation changes in any format to the Documentation Interest Group (DIG) email list: < | * Send your documentation changes in any format to the Documentation Interest Group (DIG) email list: < | ||
* **Valuable contributions include:** | * **Valuable contributions include:** | ||
+ | * Telling us about anything that seems wrong | ||
* Corrections of typos | * Corrections of typos | ||
* Corrected step-by-step instructions | * Corrected step-by-step instructions | ||
Line 22: | Line 22: | ||
* URL of the documentation web page that needs to be updated | * 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.) | * 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:// | ||
+ | * Add the tag " | ||
+ | |||
+ | |||
==== Intermediate workflow ==== | ==== Intermediate workflow ==== | ||
Line 67: | Line 74: | ||
- Make changes to files, remove files, add new files | - 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 | + | After you've made your changes, make sure that your documentation is included in the appropriate |
+ | |||
+ | FIXME the test build instructions need to be updated for Antora. | ||
Then **test building the various output formats**. | Then **test building the various output formats**. |
evergreen-docs/how-to-contribute-documentation.txt · Last modified: 2023/06/01 12:13 by gmcharlton