-
Notifications
You must be signed in to change notification settings - Fork 19
Open
Labels
content update: new/improvementdocumentationmaintaining or creating documentation about the projectmaintaining or creating documentation about the projectenhancementNew feature or requestNew feature or requestneeds definitionIssue needs more details to be ready for implementationIssue needs more details to be ready for implementation
Description
What are you submitting?
Place an x in the appropriate bracket:
- Bug (something's broken)
- Feature request or improvement
- Content update
- Question
- Other
Description
While we have a growing /resources page that includes some BrigadeOps support, members don't have easy access to various "how-tos" for doing anything from getting account access to running a meeting to fundraising, etc. Docs are scattered in a shared Google Drive with ongoing permissions constraints, and many people don't know what exists or where things live.
Proposed solution
We've been slowly compiling a BrigadeOps Handbook meant to serve as one-stop-shop for running OO. It would be great to move this content online so it's not also trapped in yet another hidden Google Doc.
Code for SF has created a Notion-based wikithat is a good example of what we'd like to do (though also poses its own challenges).
Requirements
- Allow members to contribute to changes without too much technical know-how.
- Be integrated into openoakland.org in some way.
- Adhere to a clear and uncomplicated content model to make content creation easier.
- Have a logical, browseable architecture/table of contents/navigation scheme.
- Each entry should be a self-contained topic that clearly addresses how to do one thing.
- Include documentation for how to maintain, edit and add to the handbook.
- Bonus: Surface "related content" (potentially based on other content in the section).
- Bonus: Offer a keyword search capability.
Potential approaches
- (Preferred) Third-party CMS hosted at an OO subdomain (e.g. operations.openoakland.org)
- Create a full content model within the existing jekyll build
- ???
Potential platforms
- Read the Docs
- Notion
- ???
Thank you!
- Please document your design and tech decisions in your pull request so others can follow along and understand why we've made the decisions we have.
- If you'd like feedback, input, or help, share your thoughts or question in this issue's comments.
Metadata
Metadata
Assignees
Labels
content update: new/improvementdocumentationmaintaining or creating documentation about the projectmaintaining or creating documentation about the projectenhancementNew feature or requestNew feature or requestneeds definitionIssue needs more details to be ready for implementationIssue needs more details to be ready for implementation