diff --git a/docs/source/excursions.rst b/docs/source/excursions.rst new file mode 100644 index 0000000..6abf4d4 --- /dev/null +++ b/docs/source/excursions.rst @@ -0,0 +1,4 @@ +Ausfahrten +========== + +Diese Seite erklärt die Funktionen der Ausfahrtenverwaltung. diff --git a/docs/source/finance.rst b/docs/source/finance.rst new file mode 100644 index 0000000..a65b73e --- /dev/null +++ b/docs/source/finance.rst @@ -0,0 +1,6 @@ +Finanzen +======== + +Auf dieser Seite wird das Einreichen, Bearbeiten und Abwickeln von Abrechnungen +erklärt. Diese Seite ist für Finanzbeauftragte der Sektion gedacht und daher +für die meisten Benutzer:innen des Kompass unwichtig. diff --git a/docs/source/getstarted.rst b/docs/source/getstarted.rst index 916f04e..5f0491e 100644 --- a/docs/source/getstarted.rst +++ b/docs/source/getstarted.rst @@ -1,4 +1,77 @@ +.. _first-steps: + Erste Schritte ============== -Wenn du das erste Mal den Kompass deiner Sektion benutzt, landest du hier. +Wenn du zum ersten Mal den Kompass deiner Sektion benutzt ist diese +Seite der richtige Einstieg. Wir verfolgen in dieser Anleitung den Jugendleiter +Fritz Walter bei seinen ersten Schritten mit seinem Kompass. Fritz Walter leitet +die Gruppe *Kletterfüchse*. + +Wie finde ich die Teilnehmer:innen meiner Jugendgruppe? +------------------------------------------------------- + +Auf der `Startseite`_ siehst du eine Auflistung der von dir geleiteten Jugendgruppen. +Klickst du auf eine der Gruppen landest du in der `Teilnehmer:innenanzeige`_. + +.. image:: images/members_changelist_filters.png + +Fritz hat die Gruppe *Kletterfüchse* ausgewählt, wie du oben rechts sehen kannst. +Versuche einmal dort bei dir eine andere Gruppe auszuwählen. Falls dir keine Teilnehmer:innen +angezeigt werden liegt das daran, dass deine *Zugriffsrechte* nicht ausreichen. + +Wie ändere ich eine:n Teilnehmer:in meiner Jugendgruppe? +-------------------------------------------------------- + +Fritz möchte das eingetragene Geburtsdatum von *Lisa Lotte* ändern. Dazu klickt +er auf den entsprechenden Eintrag, ändert das Geburtsdatum und klickt auf *Speichern*. + +.. note:: + Nicht alle Einträge in der `Teilnehmer:innenanzeige`_ sind klickbar. Das liegt daran, + dass du manche Teilnehmer:innen zwar sehen, aber nicht ihre Details einsehen kannst. + Manche Einträge wiederum kannst du einsehen, aber nicht bearbeiten. + +Probier doch einmal aus deinen eigenen Eintrag zu ändern. Sicherlich gibt es einige +Felder, die nicht ausgefüllt oder nicht mehr aktuell sind. + +Wie schicke ich eine E-Mail an meine Gruppe? +-------------------------------------------- + +Nachdem Fritz die Daten seiner Gruppe auf den neusten Stand gebracht hat, möchte er nun +eine E-Mail über die bevorstehende Hallenübernachtung an seine Gruppe schreiben. Dazu +geht er zurück auf die `Startseite`_ und wählt `Nachricht verfassen`_ aus. + +Als Empfänger wählt er im Feld *An Gruppe* die *Kletterfüchse* aus. Damit seine +Co-Jugendleiterin Julia auch die Antworten erhält, wählt er im Feld +*Antwort an Teilnehmer* sowohl sich selbst, als auch Julia aus. Schließlich +klickt er auf *Speichern und Email senden*, um die Nachricht zu verschicken. + +.. note:: + Es kann sein, dass über den Kompass verschickte E-Mails nur verzögert ankommen. Das + liegt daran, dass pro Minute stets nur 10 E-Mails verschickt werden um Stau + zu verhindern. + +Probier doch mal aus dir selbst eine Nachricht zu schicken. Wähle einfach im Feld +*An Teilnehmer* dich selbst aus. + +Wie organisiere ich eine Ausfahrt? +---------------------------------- + +Nun da Fritz seine Gruppe zur Hallenübernachtung eingeladen hat, möchte er die +Ausfahrt auch im Kompass anlegen. Dazu navigiert er zurück zur `Startseite`_ und wählt +`Ausfahrten`_ aus. + +Dort wählt er oben rechts *Ausfahrt hinzufügen* aus und füllt die verschiedenen Felder +aus. Im Reiter *Teilnehmer* trägt er bereits Julia und sich selbst ein, die stehen ja +schließlich schon fest. Schließlich speichert er die Ausfahrt mit *Sichern*. + +Wie geht es weiter? +------------------- + +Nun hat Fritz den Bürokratiekram für heute erledigt. Du willst noch mehr wissen? Dann +geh zurück zum :ref:`index`. + +.. _Startseite: https://startpage.com +.. _Teilnehmer:innenanzeige: https://startpage.com +.. _Nachricht verfassen: https://startpage.com +.. _Ausfahrten: https://startpage.com diff --git a/docs/source/images/members_changelist_filters.png b/docs/source/images/members_changelist_filters.png new file mode 100644 index 0000000..a0fcf5c Binary files /dev/null and b/docs/source/images/members_changelist_filters.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index f7fe6c1..ddcb527 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,11 +7,37 @@ Kompass ======= -Kompass ist eine Verwaltungsplattform entwickelt für JDAV Sektionen. +Der Kompass ist dein Kompass in der Jugendarbeit in deiner JDAV Sektion. Wenn du das +erste mal hier bist, schau doch mal :ref:`first-steps` an. + +Was ist der Kompass? +-------------------- + +Der Kompass ist eine Verwaltungsplattform für die tägliche Jugendarbeit in der JDAV. +Die wichtigsten Funktionen sind + +- Verwaltung von Teilnehmer:innen von Jugendgruppen +- Organisation von Ausfahrten +- Abwicklung von Abrechnungen +- Senden von E-Mails + +Neben diesen Funktionen für die tägliche Arbeit, automatisiert der Kompass die +Aufnahme von neuen Mitgliedern und die Pflege der Daten durch + +- Wartelistenverwaltung +- Registrierung neuer Mitglieder +- Rückmeldeverfahren + +.. _index: + +Inhaltsverzeichnis +------------------ .. toctree:: :maxdepth: 2 - :caption: Inhaltsverzeichnis: getstarted members + excursions + waitinglist + finance diff --git a/docs/source/waitinglist.rst b/docs/source/waitinglist.rst new file mode 100644 index 0000000..f2c17ba --- /dev/null +++ b/docs/source/waitinglist.rst @@ -0,0 +1,5 @@ +Warteliste und neue Mitglieder +============================== + +Hier wird die Warteliste erklärt und verschiedene Möglichkeiten erläutert, wie +neue Teilnehmer:innen angelegt werden können.