Dokumentationsproblem melden

Vielen Dank, dass Sie sich die Zeit nehmen, uns auf Probleme in unserer Dokumentation hinzuweisen. Ihre Rückmeldung ist uns sehr wichtig, um die Qualität und Verständlichkeit der InGrid-Dokumentation kontinuierlich zu verbessern.

Bevor Sie beginnen¶

Bitte überprüfen Sie, ob der Fehler nicht bereits gemeldet wurde. Suchen Sie dazu in den bestehenden Issues auf GitHub. Wenn Sie den Fehler dort finden, können Sie Ihre Beobachtungen einfach zu dem vorhandenen Issue hinzufügen.

Wie man ein gutes Dokumentations-Issue schreibt¶

Je mehr Details Sie uns geben, desto schneller können wir das Problem beheben. Bitte füllen Sie die folgenden Abschnitte so detailliert wie möglich aus.

1. Kurze Zusammenfassung¶

Eine kurze Beschreibung, worum es in dem Problem geht.

2. Fundstelle¶

Link: Der URL-Link zu der Seite, auf der das Problem auftritt.
Abschnitt: Der Titel des Abschnitts oder der Unterüberschrift, in dem sich das Problem befindet.
Textpassage: Die genaue Textpassage, die fehlerhaft, unklar oder unvollständig ist.

3. Beschreibung des Problems¶

Was ist falsch? Beschreiben Sie, warum der aktuelle Text irreführend, falsch oder unvollständig ist.
Was sollte dort stehen? Schlagen Sie eine alternative Formulierung oder die fehlende Information vor.
Beispiel:
- Falsch: "InGrid unterstützt nur OGC WMS."
- Richtig: "InGrid unterstützt OGC WMS, OGC WMTS und OGC WFS."

4. Wichtigkeit¶

Kritisch: Die Information ist grundlegend falsch und führt zu schwerwiegenden Fehlern bei der Nutzung.
Hoch: Die Information ist unklar oder verwirrend und kann zu Missverständnissen führen.
Mittel: Ein kleinerer Tippfehler oder ein Grammatikfehler, der aber behoben werden sollte.
Niedrig: Ein kosmetisches Problem, das die Lesbarkeit leicht beeinträchtigt.

5. Ihre Umgebung¶

Browser: (z.B. Chrome 120, Firefox 121)
Betriebssystem: (z.B. Windows 11, macOS 14.2)
Anmerkungen: Fügen Sie hier weitere relevante Informationen hinzu.

Zusätzlicher Hinweis¶

Wenn Sie die Änderung selbst vornehmen möchten, können Sie auch einen Pull Request mit dem Vorschlag für die Korrektur erstellen.