====== Documentation ======

===== Drafts =====

If you want to help, take a look at the [[documentation:paginated_drafts_to_edit|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 [[documentation:organization|Organizing the Documentation]].

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

  * [[documentation:structure:class_handouts|Class Handouts]]
  * [[documentation:structure:tool_usage_guide|Tool Usage Guides]]
  * [[documentation:structure:software_guide|Software Guides]]
  * [[documentation:structure:concept_guide|Concept Guides]]

===== Other Notes =====

  * [[documentation:production_notes|Production Notes]]
  * [[documentation:content_notes|Content Notes]]