Tworzenie dokumentacji
Dokumentacja jest dla programistów punktem wyjścia do nauki tworzenia udanych witryn internetowych, relacji, reklam i dynamicznych wiadomości e-maile za pomocą AMP. Główny zespół dokumentacji AMP jest niewielki, ale ciąży na nas duża odpowiedzialność. Cenimy Twoją pomoc! Współpracownicy mogą poprawiać literówki, korygować nieaktualne informacje i pisać zupełnie nowe dokumenty! Użyj tej strony, aby dowiedzieć się więcej o tym, jak zostać autorem dokumentacji.
Dziękujemy za zainteresowanie udziałem w projekcie AMP, zapraszamy do zespołu!
Rozpoczęcie pracy
Hostem naszej dokumentacji jest amp.dev, a zespół AMP współpracuje na GitHub. Postępuj zgodnie z README repozytorium amp.dev, aby uruchomić amp.dev na komputerze lokalnym. Ma to zasadnicze znaczenie dla zapewnienia prawidłowego renderowania i formatowania zasobów. W przypadku prostych poprawek, takich jak literówki, można natomiast edytować plik bezpośrednio na GitHub.
Dołącz do grupy roboczej ds. współpracy zewnętrznej AMP Project Slack i daj nam znać, nad czym pracujesz!
Dokumentację można dostarczyć do amp.dev na kilka sposobów. Na początek przedstawiliśmy kilka z nich. Jeśli chcesz przyczynić się w inny sposób, skontaktuj się z nami i zapytaj, czy możemy to zaakceptować!
Dobre pierwsze kwestie
Nasz malutki (acz potężny) zespół jest zajęty wyławianiem naszych problemów dużych i małych. Jeśli chcesz wnieść swój wkład, ale nie wiesz, od czego zacząć, sprawdź nasze problemy i przefiltruj je według etykiety good first issues. Są to proste poprawki, które pozwolą Ci zaznajomić się z amp.dev i procesem zespołowego tworzenia.
Edycja dokumentacji
Jeśli zobaczysz nieaktualne, źle umiejscowione lub nieprawidłowe informacje, możesz to naprawić! Przyjmujemy poprawki jako prośby o ściągnięcie, ale jesteśmy równie wdzięczni, jeśli tylko zgłosisz problem. Otrzymasz punkty bonusowe, jeśli zgłosisz problem i przypiszesz go do siebie. Pozwala to na śledzenie nakładu pracy i uniknięcie jej powielania.
Pisanie dokumentacji
Chcesz mieć przewodnik lub samouczek, ale nie widzisz go na amp.dev? Możesz go napisać! Zacznij od sprawdzenia typów dokumentacji, które przyjmujemy i złożenia propozycji dokumentacji. Po zaakceptowaniu propozycji zapoznaj się z przewodnikiem terminologicznym AMP i wytycznymi dotyczącymi formatowania dokumentacji. Informacje na temat przykładów udziału w projekcie znajdziesz tutaj.
-