Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Plone
- Technischer Redakteur:
- Cris
- Projektname:
- Verbesserung der Dokumentation für das React-basierte Frontend „Volto“
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Volto ist ein neues, React-basiertes Front-End für Web-Content-Management-Systeme. Eine ausgereifte REST API verbindet Volto mit allen Funktionen von Plone, einem der sichersten, zuverlässigsten und flexibelsten Content-Management-Systeme der letzten 15 Jahre.
Während der Google Season of Docs möchten wir die Volto-Dokumentation optimieren und für ein viel breiteres Entwicklerpublikum zugänglich machen. Da sich die aktuelle Dokumentation auf sachliche Informationen konzentriert, möchten wir die Inhalte insgesamt verbessern, indem wir sie erweitern und neu strukturieren, um verschiedene Entwicklergruppen anzusprechen.
Nutzer, die mit React vertraut sind, benötigen Informationen dazu, wie sie auf die Funktionen von Plone zugreifen können, um funktionsreiche Websites mit optimierten Workflows und Berechtigungen zu erstellen und die zuverlässige Speicher- und Suchmaschine im Hintergrund zu nutzen. Entwickler, die bereits mit Plone vertraut sind, sollten die neuesten JavaScript-Tools nutzen, um modernere Websites zu erstellen.
In Anbetracht der vielfältigen, globalen Plone- und Volto-Gemeinschaften achten wir besonders darauf, kulturelle, geschlechtliche oder andere Vorurteile zu vermeiden und so eine inklusive und zugängliche Dokumentation für möglichst viele Entwickler zu erstellen. Eine klare, einheitliche und prägnante Sprache hilft auch den vielen Entwicklern von Plone und Volto, für die Englisch nicht die erste oder sogar zweite Sprache ist.