Things to document

Note: I writed down all the things for which documentation could be useful. Marked in bold key documentation.

• SysAdmin
  • Credentials (usernames/passwords/keys/...) for anything we use
    • Status: there already a place for this with month of the credentials
    • Todo: make sure there is no info missing
  • Main sites/services administered/used by p2pu:
    • Information about which sites are installed in which linodes (e.g., where does pad.p2pu.org)
      • Status: Needs to be started
    • Configuration instructions for sites we admin
      • Status: only existing for main site
      • Todo: update documentation for main site and include documentation for others
    • Ways to monitor their status
      • Status: needs to be started
    • Key aspects of their database structure if they are key to generating metrics or updating code that is integrating them to the main site
      • Status: in some cases this documentation is at past lighthouse tickets
      • Todo: move existing information to a good location and include documentation about other sites
  • Release process (lernanta --> p2pu)
    • Things to do during every release -- Started task of writing down steps for the current release as I do them so they can be used as example
      • Status: needs to be started
    • Things to do for specific non-frequent changes (e.g. updating third party dependencies)
      • Status: needs to be started
  • User and Staff support
    • Badges creation
      • Status: there is information about what to ask from the user
      • Todo: Include next steps
    • Challenge set creation
      • Status: needs to be started
    • Handling Spam on the site and mailing lists
      • Status: needs to be started
    • Metrics Reports
      • Status: needs to be started
    • Deleting users in archive.p2pu.org
      • Status: needs to be started
  • Survey news letters setup
• Development
  • Onboarding
    • Setup documentation
      • Status: activelly maintained for Ubuntu
      • Todo: Check it is complete and organize existing github wiki pages
    • Information about sites, tools used for development
      • Status: main resources linked from the home page of the github wiki
      • Todo: check it is complete
    • Testing documentation
      • Status: documented on the github wiki
      • Todo: check it is complete at easy to find
    • Information about communication channels for developers, community and partners
      • Status: main resources linked from the home page of the github wiki
      • Todo: check it is complete
    • Onboarding trello template:
      • Status: first iteration completed
      • Todo: prepare template for future use
  • Documentation of the software
    • Where the main functionality is and tricks to locate specific things in the source code
      • Status: Needs to be started
      • Todo: Include in wiki and existing p2pu challenge
    • General architecture
      • Status: Needs to be started
      • Todo: Include in wiki and existing p2pu challenge
    • Key forks of the project
      • Status: Needs to be started
      • Todo: Include in wiki
  • Internationalization Documentation (currently on a page at the github wiki, need to review to check it is complete)
    • Instructions for translators
    • Instructions for Developers doing the initial setup for a translation
    • Instructions for developers compiling the updated translations
  • Roadmap
    • History of the development of learnanta (past releases)
      • Status: recently updated
    • Where pending work and user requests is documented
      • Status: main resources linked from the home page of the github wiki
      • Todo: check it is complete at easy to find
    • Short term priorities
      • Status: on project pipeline and roadmap
      • Todo: update and clean up

• Others:
  • list of key etherpads to remember (e.g. iframes, metrics, summer projects, ...)
  • list of releated opensource django projects (batucada, betafarm, django-badger, osqa, zamboni)