RTD Documentation progress

[bjrne]

• Installation

  • [ ] Django-Admin setup for non Python Users (don't use django-admin in Docs!)
  • [ ] General chapter Docker vs. Local Environment
    • [ ] Advantages of docker env
    • [ ] Mounted Directories in Docker mode
  • [ ] Get started (developing, replacement for quick install)
    • [ ] Create Fakeusers (now also in setup script)
  • [ ] Config -> Link to Chapter, one first example
  • [ ] Installation (Production Environment)
    • [ ] Setting up the env files
    • [ ] Mail setup??
      • [ ] Directory files ​​​​​​​​​​​​​​- [ ] SMTP
      • [ ] Async Stuff ​​​​​​​​​​​​​​- [ ] Sendgrid
    • [ ] Initial DB Setup, CMS Imports (we have a script for that now, can be used; do we want to hint to custom configurations here?)
    • [ ] Management Commands for the containers
    • [ ] Common Pitfalls
      • [ ] Permissions
      • [ ] Check if container is restarting
    • [ ] Troubleshooting
      • [ ] Accessing the Logs
      • [ ] JSON Log Format
        • [ ] json-log-viewer
        • [ ] jq
    • [ ] Back-Ups

• Configuration

  • [ ] Environment variables
  • [ ] Model Setup
  • [ ] Page contents
    • [ ] Main Templates
    • [ ] Reuseable
  • [ ] Logging Setup

• Architecture Guide

  • [ ] Quick Anatomy of a Django App
    • [ ] Links zur Django-Doku
    • [ ] Backend Management Commands and their use
    • [ ] System-Checks
  • [ ] Testing ... ?
  • [ ] Data Model Configuration
    • [ ] Also keep in mind: https://github.com/match4everyone/match4everything/issues/80
  • [ ] Handling statics in Production
  • [ ] Docker Environment
  • [ ] Permission System
    • [ ] Add the results from the discussion in #43 to contributing
  • [ ] Mail-Setup
  • [ ] Django-CMS Integration
  • [ ] Javascript&CSS Frontend Components
  • [ ] Production Server Setup
    • [ ] Nginx Reverse Proxy
  • [ ] Design Decisions
    • [ ] Why is Geocoding so fucking hard
    • [ ] Why Webpack
    • [ ] Why Django-CMS, or Wagtail, or ...
    • [ ] Why Sendgrid

• Cookbook

  • [ ] What do I need to do to ....
    • [ ] Create a new page
    • [ ] Modify the model and forms
    • [ ] Introduce a new permission
    • ...???
  • [ ] What we did
    • [ ] PyCharm related stuff? Is there anything?
    • [ ] Pitfalls in VSCode
    • [ ] Are there solutions we wrote for Travis, github Actions, pre-commit, Flake, ... that are worth documenting (not straightforward, exepctionally complicated, no good documentation elsewhere)
    • [ ] "POT-Creation-Date: 1900-01-01 00:00+0000\n" Was für Suchbegriffe haben wir da verwendet? Damit man's auch finden kann :D