documentation
Table of Contents
Documentation
Drafts
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)
Deployment Plan
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:
- Stand up a BookStack instance
- Enable and test SSO
- Populate BookStack instance with dummy content
- Start meta documentation book
- Test permissions and access control
- Document permissions and access control
- Make a backup
- Document making a backup
- Restore from the test backup and make sure it works
- Document restoring from a backup
- Build out stub shelves for audience types
- Build out stub books for documentation categories
- Set permissions as appropriate (map members to groups)
- Test permissions.
Information Architecture
Notes on Organizing the Documentation.
Notes on the content, structure, and templates for various document types:
Other Notes
documentation.txt · Last modified: 2024/10/07 23:28 by paul