Documentation

If you want to help, take a look at the Printed Docs to Edit page, which lists drafts of printable material that need feedback.

If you want to build new documentation, see CONTRIBUTING_TO_DOCS. (Forthcoming)

The website is purposed for offering all public information.

We will set up a BookStack instance to handle member-facing documentation.

Here are the steps we need to take to set up BookStack:

1. Stand up a BookStack instance
2. Enable and test SSO
3. Populate BookStack instance with dummy content
4. Start meta documentation book
5. Test permissions and access control
6. Document permissions and access control
7. Make a backup
8. Document making a backup
9. Restore from the test backup and make sure it works
10. Document restoring from a backup
11. Build out stub shelves for audience types
12. Build out stub books for documentation categories
13. Set permissions as appropriate (map members to groups)
14. Test permissions.

Notes on Organizing the Documentation.

Notes on the content, structure, and templates for various document types:

• Class Handouts
• Tool Usage Guides
• Software Guides
• Concept Guides

• Production Notes
• Content Notes