User Tools

Site Tools


evergreen-docs:documentation_needs

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
evergreen-docs:documentation_needs [2019/04/11 10:48] – [High level workflow for documenting new EG features] rjs7evergreen-docs:documentation_needs [2019/04/11 11:07] – [Other Documentation Tasks] rjs7
Line 3: Line 3:
 ==== 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 ====
Line 81: Line 58:
  
  
-<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:
evergreen-docs/documentation_needs.txt · Last modified: 2024/06/06 14:27 by jpringle

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.