Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Plone
- Pisarz techniczny:
- Cris
- Nazwa projektu:
- Ulepszenie dokumentacji dotyczącej frontendu „Volto” opartego na Reactzie
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Volto to nowy interfejs oparty na React, przeznaczony do systemów zarządzania treścią w internecie. Dojrzały interfejs REST API umożliwia Volto korzystanie ze wszystkich funkcji Plone, czyli jednego z najbezpieczniejszych, niezawodnych i elastycznych systemów zarządzania treścią w ostatnich 15 latach.
W sezonie Dokumentów Google chcemy usprawnić i udostępnić dokumentację Volto szerszemu gronu programistów. Obecna dokumentacja koncentruje się na informacjach o faktycznych funkcjach, dlatego planujemy ulepszyć ogólną jakość treści, rozszerzając je i zmieniając ich strukturę, aby odpowiadały różnym potrzebom programistów.
Osoby znające React potrzebują informacji o tym, jak uzyskać dostęp do funkcji Plone, aby móc tworzyć bogate w funkcje witryny z ulepszonymi przepływami pracy i uprawnionymi uprawnieniami oraz korzystać z solidnego magazynu i silnika wyszukiwania działających w tle. Deweloperzy, którzy znają już Plone, chcą wykorzystać najnowsze narzędzia JavaScript do tworzenia bardziej nowoczesnych witryn.
Biorąc pod uwagę zróżnicowane, globalne społeczności Plone i Volto, będziemy zwracać szczególną uwagę na unikanie uprzedzeń kulturowych, związanych z płcią i innych, aby stworzyć dokumentację, która będzie dostępna dla jak najszerszego grona deweloperów. Jasny, spójny i zwięzły język ułatwia też pracę wielu programistom Plone i Volto, dla których angielski nie jest pierwszym ani nawet drugim językiem.