Projekt GenPipes

Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.

Podsumowanie projektu

Organizacja open source:
GenPipes
Pisarz techniczny:
shaloo
Nazwa projektu:
Konfigurowanie dokumentów GenPipes na stronie „Read The Docs”
Długość projektu:
Standardowa długość (3 miesiące)

Opis projektu

Proponuję 3-etapowy plan, którego celem jest skonfigurowanie dokumentacji GenPipes w sekcji „Read the Docs”.

Krok 1. Osoba kontaktowa

  • Przejrzyj dotychczasową dokumentację GenPipes jako nowy użytkownik / badacz

    • Rozpoznawanie brakujących i nieścisłości
    • Proponowanie nowych tematów dokumentów (w razie potrzeby)
    • Wersja robocza mapy architektury informacji skierowana do docelowych odbiorców z naciskiem na nowych użytkowników.

    Uwaga: w tym kroku możemy też potrzebować danych od mentorów z GenPipes dotyczących nowej konfiguracji repozytorium GitHub, w której mogą być hostowane dokumenty genpipes na potrzeby RTD. Tego repozytorium GitHub można używać do importowania wszystkich dokumentów w potokach kompilacji RTD. Może to wymagać wglądu w reguły repozytorium GenPipes i wytyczne dotyczące zarządzania źródłem dokumentów. W przeciwnym razie można użyć standardowych funkcji – afaik. Mogę też zaprezentować konfigurację repozytorium RTD, używając mojego konta GitHuba – np.https://gpdocs.readthedocs.io/en/latest/ – to jest próbka utworzona na potrzeby tej oferty pakietowej.

  • Na podstawie analizy i analizy z poprzedniego kroku utwórz szkielet proponowanej struktury / indeksu dokumentacji GenPipes i umieść go w witrynie RTD.

    • Wymaga to utworzenia repozytorium GitHub (np. narzędzia Sphinx) i podstawowych plików dokumentacji.
    • Wiąże się to również z tworzeniem nowego spisu treści, które uwzględnia zarówno nowych użytkowników, jak i sezonowe zastosowania różnych sekcji lub przepływów informacji.

  • Przegląd i uzyskiwanie zatwierdzenia na temat szkieletu szkieletu barebones

    Na etapie oceny GenPipes GSoD próbowałem utworzyć wartość dla GenPipes za pomocą tego przykładowego hostowanego w RTD. Pamiętaj, że jest to link tylko do celów demonstracyjnych i nie jest jeszcze dostępny publicznie w RTD. Niezależnie od tego, czy dostanę się na listę, ta wersja demonstracyjna może pomóc w szybszym rozpoczęciu pracy nad rozwiązaniem GenPipes RTD. Sprawdziłem już źródła w repozytorium c3g/GenPipes na GitHubie. Mentorom, Rola i Hektorowi spodobała się funkcja „Udostępnianie ekranu” w Skype, więc pomyślałam, że warto ją zobaczyć. Na razie to bezwładny szkielet, ale zamierzam go zaktualizować do 30 lipca.

https://genpipes.readthedocs.io/en/latest/

Krok 2. Tworzenie zbioru dokumentów GenPipes Doc w wersji 0.9

  • Określ, które bieżące i istniejące dokumenty GenPipes można zaimportować, połączyć lub przekonwertować na dokumentację typu Sphinx/pierwszą na potrzeby hostowania w ramach RTD z uwzględnieniem terminów GSoD

  • W razie potrzeby przekonwertuj zidentyfikowane dokumenty na pierwszy format. W razie potrzeby utwórz nowe dokumenty i wykorzystuj je w miarę możliwości.

    • Zaimportuj ten początkowy zestaw dokumentów do ReadTheDokumentacja jako materiał Proof of Concept, a następnie przechowuj go w chronionym repozytorium. Umieść na początku notatkę zachęcającą nowych użytkowników do przejścia do oryginalnej dokumentacji GenPipes do czasu, aż zostanie ona sprawdzona/formalna.

  • Przegląd/korekta/aktualizacja

Krok 3. Ulepsz, sprawdź i opublikuj pierwszą wersję roboczą na RTD

  • Uzupełnij szczegóły proponowanej struktury nowego dokumentu GenPipes w TOC GenPipes – dodaj kolejne dokumenty oprócz kilku pierwszych (GenPipes Readme), Concepts, tutorials itp.

  • Dodaj jasny podział w TOC, aby odnieść się do nowych użytkowników, doświadczonych użytkowników GenPipes, programistów GenPipes itp.

  • Zasugeruj, aby przedyskutować proces pracy z częściową automatyzacją za pomocą RTD (wersji sfinksa), aby dowiedzieć się, jak użytkownicy mogą obsługiwać zestaw dokumentów GenPipes, edytować je i czy C3G zezwala na to zewnętrznym współtwórcom dokumentów. Może to wymagać opracowania wytycznych dotyczących aktualizacji dokumentów podobnych do wytycznych dotyczących kodowania. Może to wymagać wykonania dodatkowych czynności. Możesz na przykład zautomatyzować sprawdzanie pisowni w dokumentach GenPipes przed zatwierdzeniem przez PR.

Zgłoś

Na koniec utwórz raport dotyczący GSoD na podstawie doświadczeń, dzienników i opinii mentorów.

Inne uwagi

W przyszłości (po 3 miesiącach) w razie potrzeby mogę pomóc w dłuższej perspektywie czasowej na ten temat w przypadku GenPipes. Możesz też przeszkolić do tego inne osoby. To wyznaczymy na podstawie wyników tych pierwszych 3 miesięcy.

Proponuję też dodatkowe pomysły na projekt – stworzenie streszczenia strony GenPipes 3, które ułatwi rozpoczęcie pracy. Obecnie nowy użytkownik musi przejść wiele kwestii, zanim będzie mógł zacząć korzystać z generatywnej AI, ponieważ dokumentacja jest dobra, ale rozproszona i nie przyciąga nowych użytkowników. Nie wiem, czy da się to zrobić w ciągu 3 miesięcy, ale chcę spróbować.

Tę samą propozycję i informacje o jej powstaniu (historię) można również wyświetlić na stronie https://drive.google.com/file/d/1oKVp_7ZeYGMxhynfc97qUUcGNh2CNbX0/view?usp=sharing.