Next revision | Previous revision |
adding_documentation [2012/05/23 10:35] – created sfortin | evergreen-docs:adding_documentation [2022/02/10 13:34] (current) – external edit 127.0.0.1 |
---|
==== Adding Local Documentation to the Official Documentation ==== | ==== Adding Local Documentation to the Official Documentation ==== |
| |
- Ordered List ItemAdd proposed or in process documentation to the [[evergreen-docs_2.2:outline|outline]] in blue. | - Add proposed or in process documentation to the [[evergreen-docs:documentation_needs|outline]] in blue. |
- Ordered List ItemComplete your documentation and makes the documentation available to appropriate open-ils mailing lists and (module) content coordinator - Ordered List Item(The contact information for coordinators can be found [[evergreen-docs:digparticipants|here]]). | - Complete your documentation and makes the documentation available to appropriate open-ils mailing lists and (module) content coordinator. (The contact information for coordinators can be found [[evergreen-docs:digparticipants|here]]). |
- Ordered List Item(Module) content coordinator merges the documentation with existing documentation when necessary. | - (Module) content coordinator merges the documentation with existing documentation when necessary. |
- Ordered List Item(Module) content coordinator notifies docBook Conversion Coordinator that documents are ready for inclusion in DIG documentation. | - (Module) content coordinator notifies AsciiDoc Conversion Coordinator that documents are ready for inclusion in DIG documentation. |
- Ordered List ItemDocBook Conversion Coordinator merges the documentation and updates the needed documentation wiki in green to indicate that the documentation is complete. | - AsciiDoc Conversion Coordinator merges the documentation and updates the needed documentation wiki in green to indicate that the documentation is complete. |
| |
| |
==== Adding Release Notes ==== | ==== Adding Release Notes ==== |
| |
- Ordered List ItemCompose summary of new features and add to release notes | - Compose summary of new features and add to release notes |
- Ordered List ItemNotify DIG Release Coordinators and (module) Content Coordinators that release notes have been added | - Notify DIG Release Coordinators and (module) Content Coordinators that release notes have been added |
- Ordered List ItemDIG Release Coordinator contacts DocBook Conversion Coordinator to create a hyperlink between release notes and DIG documentation | - DIG Release Coordinator contacts AsciiDoc Conversion Coordinator to create a hyperlink between release notes and DIG documentation |
- Ordered List ItemDocBook Conversion Coordinator updates wiki to indicate that the process for that section of release notes is complete. | - AsciiDoc Conversion Coordinator updates wiki to indicate that the process for that section of release notes is complete. |