Differences

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

--- documentation [2024/10/07 15:09] – created paul
+++ documentation [2024/12/09 03:21] (current) – paul
@@ Line 1: / Line 1: @@
-Stub for the documentation effort
+====== 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 (done)
+  - Enable and test SSO (done)
+  - Populate BookStack instance with dummy content (done)
+  - Start meta documentation book (done)
+  - Test permissions and access control (done)
+  - 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 (done)
+  - Build out stub books for documentation categories (done)
+  - 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:
+Full documents:
+  * [[documentation:structure:class_handouts|Class Handouts]]
+  * Shop Binders
+Partial documents for inclusion as parts of full documents:
+  * [[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]]