Project Ideas: Season of Docs 2019

For Season of Docs 2019, our goal is to have one streamlined process of documentation. We want to provide projects in 1) tidying GitHub Wikis for every active repo, 2) publish a GitHub page for each active repo with a basic template and 3) creating templates for consistent documentation.

---

Decluttering Data & Pioneering Templates

We need help on consistency of the app development as well as providing clear opportunities and paths for those contributors without a technical background.

[1] Decluttering Data

• Refactor the open source documentation for each active project to have a documentation folder. (1 week for all active projects)
  • Sample Wiki Options: Wiki Template Research
  • GitHub Wiki Example: Mentorship-Android

[2] Pioneering Templates

• Build documentation sites with GitHub pages for each of the active repositories and publish an initial set of basic documents on the site.
  • Sample GitHub Sites: FirstAide-Web, Portal

Sample Template for GitHub Pages:

• Getting started
  • Installation
  • Contributing
    • Rules for contributing
• Tutorial
  • Videos on how to use the application for users.
  • Videos on how to install the project for technical contributors.
• Support or contact
• Project Admin
  • The Problem
  • Contribute
    • (link to slack)
    • Include non-coding contributions

Resources:

• GitHub Repo Documentation
• Documentation folder for Systers Open Source

---

Active Project Repos

1. systers.github.io
2. communities
3. powerup-android
4. powerup-IOS
5. mentorship-backend
6. mentorship-android
7. portal
8. vms
9. slack-ghc
10. slack-systers-opensource
11. slack-systers

Phasing Out

1. automated-testing - Testing is included in the respective repos.
2. DevEnvironments - Dev environments are supposed to be stated on the installation of each GitHub wiki.