Protohaven Wiki

User Tools

Site Tools

Trace: • documentation
documentation

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
documentation [2024/10/07 20:44] – pauldocumentation [2024/12/09 03:21] (current) – paul
Line 3: Line 3:
 ===== Drafts ===== ===== Drafts =====
  
-If you want to help, take a look at the {{documentation:paginated_drafts_to_edit}} page, which lists drafts of printable material that need feedback.+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.
  
-Please read FEEDBACK. +If you want to build new documentation, see CONTRIBUTING_TO_DOCS. (Forthcoming)
- +
-If you want to build new documentation, see CONTRIBUTING_TO_DOCS.+
  
 ===== Deployment Plan ===== ===== Deployment Plan =====
Line 17: Line 15:
 Here are the steps we need to take to set up BookStack: Here are the steps we need to take to set up BookStack:
  
-  - Stand up a BookStack instance +  - Stand up a BookStack instance (done) 
-  - Enable and test SSO +  - Enable and test SSO (done) 
-  - Populate BookStack instance with dummy content +  - Populate BookStack instance with dummy content (done) 
-  - Start meta documentation book +  - Start meta documentation book (done) 
-  - Test permissions and access control +  - Test permissions and access control (done) 
-  - Document permissions and access control+  - Document permissions and access control 
   - Make a backup   - Make a backup
   - Document making a backup   - Document making a backup
   - Restore from the test backup and make sure it works   - Restore from the test backup and make sure it works
   - Document restoring from a backup   - Document restoring from a backup
-  - Build out stub shelves for audience types +  - Build out stub shelves for audience types (done) 
-  - Build out stub books for documentation categories+  - Build out stub books for documentation categories (done)
   - Set permissions as appropriate (map members to groups)   - Set permissions as appropriate (map members to groups)
   - Test permissions.   - Test permissions.
Line 34: Line 32:
 ===== Information Architecture ===== ===== Information Architecture =====
  
-TEMPLATES for various Documentation. (link forthcoming)+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]]
  
-ORGANIZATION notes. (link forthcoming)+===== Other Notes =====
  
 +  * [[documentation:production_notes|Production Notes]]
 +  * [[documentation:content_notes|Content Notes]]
  
documentation.1728333847.txt.gz · Last modified: by paul