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/11/09 10:06] – [Beginner workflow] rjs7 | evergreen-docs:how-to-contribute-documentation [2021/07/08 14:14] – aneiman | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== How to Contribute Documentation to the Repository ===== | ===== 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. | + | First of all, you are welcome to email the Documentation Listserv ([[evergreen-documentation@list.evergreen-ils.org]]) with problems you find in the documentation. |
We use [[http:// | We use [[http:// | ||
+ | |||
+ | 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:// | **Note**: Changes to the official repository are processed into HTML, PDF and ePub daily at 1pm and 11pm. (see http:// | ||
Line 9: | Line 11: | ||
==== Beginner workflow ==== | ==== 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:** | * **Valuable contributions include:** | ||
* Telling us about anything that seems wrong | * Telling us about anything that seems wrong | ||
Line 20: | 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 41: | Line 50: | ||
==== Advanced workflow ==== | ==== 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 < | + | 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 < |
=== Command line version === | === Command line version === | ||
Line 65: | 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