Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
evergreen-docs:documentation_needs [2019/04/11 10:48] – [High level workflow for documenting new EG features] rjs7 | evergreen-docs:documentation_needs [2019/04/24 13:49] – [EASY Tasks for New Contributors] katiegmartin |
---|
==== High level workflow for documenting new EG features ==== | ==== High level workflow for documenting new EG features ==== |
| |
These are the high-level steps we take to document new features: | ^ **1. Choose a Task** ^ **2. Read Release Notes** ^ **3. Update the Docs** ^ |
- Look at the task list below and add your name next to a task | | \\ - Look at the task list below and add your name next to a task\\ - Need a wiki account? [[docs@evergreen-ils.org|Just ask]]. | \\ - Review the release notes entry for the feature (and/or the Launchpad bug)\\ - It may need a new section in one or more of the [[http://docs.evergreen-ils.org|official manuals]]\\ - It may fit within an existing section\\ - It may only need updated screenshots\\ - You may be able to simply copy the release note into the appropriate section | \\ - Make corrections in any\\ format (perhaps by editing\\ on GitHub) and share with the [[open-ils-documentation@list.georgialibraries.org|email list]]\\ - Learn more about [[evergreen-docs:how-to-contribute-documentation|ways to contribute your changes]] | |
- Need a wiki account? Just email [[docs@evergreen-ils.org]] for access. | |
- Review the release notes entry for the feature (or the details on the Launchpad bug, if applicable) | |
- It may need a new section in one or more of the official manuals (http://docs.evergreen-ils.org) | |
- It may fit within an existing section | |
- It may only require updating a screenshot | |
- You may be able to simply copy the release note into the appropriate section | |
- Make corrections in any format (perhaps by editing on GitHub) and share with the community (via the [[open-ils-documentation@list.georgialibraries.org|email list]]) | |
- You may want to read the [[evergreen-docs:how-to-contribute-documentation|detailed steps for contributing your docs changes]] | |
| |
| |
<html><style> | |
.tasknumber { | |
/* font-size: 200%; | |
float: left;*/ | |
font-size: 150%; | |
} | |
.taskname { | |
font-size: 150%; | |
} | |
</style></html> | |
| |
| **1. Choose a Task** | **2. Read Release Notes.................** | **3. Update the Docs** | | |
| \\ * Look at the task list below and add your name next to a task\\ * Need a wiki account? [[docs@evergreen-ils.org|Just ask]]. | \\ * Review the release notes entry for the feature (and/or the Launchpad bug)\\ * It may need a new section in one or more of the [[http://docs.evergreen-ils.org|official manuals]]\\ * It may fit within an existing section\\ * It may only need updated screenshots\\ * You may be able to simply copy the release note into the appropriate section | \\ * Make corrections in any format (perhaps by editing on GitHub) and share with the [[open-ils-documentation@list.georgialibraries.org|email list]]\\ * Learn more about [[evergreen-docs:how-to-contribute-documentation|ways to contribute your changes]] | | |
| |
==== Style Guide ==== | ==== Style Guide ==== |
**Bitesize (simple) documentation bugs on [[https://bugs.launchpad.net/evergreen/?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.tag=bitesize-doc+&field.tags_combinator=ANY|Launchpad]]**: | **Bitesize (simple) documentation bugs on [[https://bugs.launchpad.net/evergreen/?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.tag=bitesize-doc+&field.tags_combinator=ANY|Launchpad]]**: |
| |
* **"Delete record" option missing from OPAC view** | * **"Delete record" option missing from OPAC view** <html><span style="color:blue;font-weight:bold">Derek from OhioNet</span></html> |
* [[https://bugs.launchpad.net/evergreen/+bug/1803415|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_working_with_the_marc_editor.html|Current Docs]] (no mention of Delete yet) - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/cataloging/MARC_Editor.adoc|Edit on GitHub]] | * [[https://bugs.launchpad.net/evergreen/+bug/1803415|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_working_with_the_marc_editor.html|Current Docs]] (no mention of Delete yet) - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/cataloging/MARC_Editor.adoc|Edit on GitHub]] |
* Possible places to link to the new section: | * Possible places to link to the new section: |
| |
| |
<html><div style="background:#FFCC00; padding:0.3em"> | <html><div style="background:#FFDDDD; padding:0.3em"> |
<h3>TIPS</h3> | <h3>TIPS</h3> |
Check Sitka's documentation, especially when documenting older features: | Check Sitka's documentation, especially when documenting older features: |