Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a brigade member, I want to know where to go for information about how to do any given brigade-related task #252

Open
1 of 13 tasks
theecrit opened this issue Feb 11, 2022 · 0 comments
Labels
content update: new/improvement documentation maintaining or creating documentation about the project enhancement New feature or request needs definition Issue needs more details to be ready for implementation

Comments

@theecrit
Copy link
Collaborator

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

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.
@theecrit theecrit added content update: new/improvement documentation maintaining or creating documentation about the project enhancement New feature or request needs definition Issue needs more details to be ready for implementation labels Feb 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content update: new/improvement documentation maintaining or creating documentation about the project enhancement New feature or request needs definition Issue needs more details to be ready for implementation
Projects
None yet
Development

No branches or pull requests

1 participant