Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Creative Commons
- Pisarz techniczny:
- JackieBinya
- Nazwa projektu:
- Przewodnik po wykorzystaniu motywu podstawowego WordPressa
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Podczas fazy zgłaszania do programu GSOD-2020 dla autorów tekstu technicznego kilka razy współpracowałem(-am) z Hugo Solarem, który jest mentorem projektu dokumentacji Creative Commons WordPress.
Podczas pierwszego kontaktu z nim szukałem pomocy w zrozumieniu zasad stworzenia podręcznika użytkowania podstawowego WordPressa. Przedstawiciel był bardzo przydatny i szybko dołączył do projektu. Późniejsze interakcje były związane z ulepszaniem celów dokumentacji CC WordPress Base.
Po przejściu do etapu rozumiełem(-am) wymagania i cele projektu. Przygotowałem wtedy wersję roboczą pakietu dotyczącego korzystania z motywu podstawowego WordPress.
Propozycja została utworzona przy użyciu oficjalnego szablonu Creative Commons dla zgłoszeń stażystów. Znajdziesz w nim informacje na temat streszczenia projektu, proponowanej struktury projektu i układu nowej dokumentacji motywu podstawowego WordPress, a także informacje o harmonogramach i materiałach dostarczanych na etapie tworzenia dokumentu.
Hugo Solar sprawdził moją wersję roboczą propozycji i przekazał mi opinie, żeby wprowadzić w niej ulepszenia. W czasie tego procesu zawsze był dostępny i odpowiadał na pytania dotyczące projektu.
Wykorzystałem(-am) przesłaną opinię, a moja ostateczna propozycja dotycząca plakietek D&I jest dostępna pod poniższym linkiem jako dokument Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Oto krótkie podsumowanie mojej propozycji, które znajduje się poniżej:
Creative Commons – Przewodnik po wykorzystaniu podstawowego motywu WordPress Wniosek przygotowany przez Jacqueline Binya, 28 czerwca 2020 r.
Opis projektu Ostatecznym celem tego projektu jest stworzenie bogatej, intuicyjnej, wciągającej i pięknie przedstawiającej dokumentację dla społeczności na temat podstawowego motywu WordPress.
Plan projektu Problem Obecnie motyw bazujący na licencji Creative Commons nie jest dokumentowany, co stanowi przeszkodę dla efektywnego wykorzystania tego motywu w społeczności. Moim celem jest stworzenie pełnego przewodnika po motywie, a także wdrożenie abstrakcji w bieżącej bazie kodu motywu podstawowego WP, aby ułatwić korzystanie z niego.
Rozwiązanie Twórz futurystyczne dokumenty przy użyciu nowoczesnych platform, takich jak Gatsby. Gatsby zawiera polecenia inicjujące, których możemy użyć do uruchomienia dokumentacji nowego motywu podstawowego WordPress. Przykładowym poleceniem inicjującym jest gatsby-gitbook-starter, który po wyjęciu z pudełka obsługuje optymalizację witryn pod kątem wyszukiwarek (SEO), Markdown i Algolia ( narzędzie do integracji wyszukiwania w witrynach statycznych). Poza tym każdą witrynę wygenerowaną przez Gatsby można łatwo zoptymalizować pod kątem internacjonalizacji i ułatwienia dostępu. Podczas tworzenia dokumentacji staram się, aby była ona jak najbardziej intuicyjna: – dołączając do dokumentacji ilustracje graficzne i multimedia z myślą o pomocy wizualnej w nauce. – na przykładach pokazujących, jak wykonywać typowe zadania, np.dostosowywać.
Mam nadzieję, że te abstrakcje będą polegały na zagwarantowaniu, że większość kluczowych funkcji motywu WP Base, takich jak haki, będzie wykorzystywana przez użytkowników z poziomu panelu administracyjnego WordPress. Dodatkowo chcę w osobnym repozytorium utworzyć początkowy motyw podrzędny dla motywu podstawowego WP. Użycie początkowego motywu podrzędnego zapewni płynniejsze i szybsze wprowadzenie nowego użytkownika. Po przygotowaniu i zatwierdzeniu dokumentacji opublikujemy ją i będzie ona przechowywać online.
Proponowana struktura Przewodnika użycia motywu CC WordPress Base – Proponowana dokumentacja zostanie podzielona na różne sekcje wymienione poniżej. Pod każdą proponowaną sekcją znajdziesz bardziej szczegółowe informacje o treściach, które znajdą się w poszczególnych sekcjach.
Sekcja Omówienie – Przedstaw definicję, intencje i funkcje motywu podstawowego WordPressa Creative Commons(CC). * Definicja: krótko opisz motyw podstawowy CC WP. * Intencje: opisanie celów i intencji motywu podstawowego CC WP. * Funkcje: omówienie funkcji motywu podstawowego CC WP.
Sekcja Pierwsze kroki – Wymagania * Opisanie wymagań dotyczących instalacji motywu WordPress Base CC, np. – wersji WordPressa, – wersji PHP, – narzędzia Composer itp., – Przewodnika instalacji. * Wyjaśnienie, jak użytkownicy mogą zainstalować motyw CC za pomocą zip. * Określ, jak użytkownicy mogą rozpocząć instalację, kopiując podstawowy motyw WP z GitHuba. * Określ, jak użytkownicy mogą instalować zależności w projekcie. * Wyjaśnij, jak użytkownicy mogą skonfigurować Queulat zależności. * Wyjaśnij, jak użytkownicy mogą aktywować motyw w swoim lokalnym środowisku programistycznym WordPress.
Przewodnik użycia – omówienie * Objaśnienie terminu „motyw podrzędny” * Przedstaw zalety używania motywu podrzędnego. * Poinformuj użytkowników, że zalecanym sposobem edytowania motywu podstawowego WP jest użycie motywu podrzędnego. * Podkreśl, że aby użytkownicy mogli utworzyć motyw podrzędny, trzeba zainstalować i aktywować motyw podstawowy WP.
Używanie motywu podrzędnego – Wyjaśnij, jak użytkownicy mogą utworzyć motyw podrzędny motywu podstawowego WP, używając polecenia inicjującego. Użyj filmu, aby wyjaśnić, jak użytkownicy mogą utworzyć motyw podrzędny od samego początku.
Dostosowywanie W podsekcjach wymienionych poniżej opisujemy, jak użytkownicy mogą wprowadzać zmiany za pomocą modułu dostosowania WordPress i panelu administracyjnego WordPress. Uwzględnimy też ilustracje graficzne, aby opisy były bardziej intuicyjne. – Dostosuj opis witryny lub slogan. – Niestandardowe menu nawigacyjne - Dostosuj CSS - Dodawanie stron - Dodawanie postów - Widżety
Sekcja zaawansowanych dostosowań – Dostosowywanie sekcji CSS * Opisz komponenty, które składają się na styl motywu: – Słownictwo CC; – Bulma; – Sass. * Wyjaśnij, jak wygląda konfiguracja Sass w projekcie. Wyjaśnienie powinno zawierać te informacje: (i) lokalizacja plików sass w strukturze projektu, (ii) skrypty npm, których można użyć do kompilowania i oglądania sass; * wyjaśnienie, jak użytkownicy mogą dostosowywać style sass w motywie podrzędnym, na przykład przez instalację określonych zależności npm. * Wyjaśnienie sposobu użycia klasy komponentu (class-component.php)
- Sekcja haczyków
Opis
- Wyjaśnij termin „haki”
- Wyjaśnij, dlaczego użytkownicy powinni korzystać z przyciągania uwagi.
- Wymień dostępne rodzaje zaczepów.
Korzystanie z akcji
- Wymień działania dostępne w motywie podstawowym WP i jego umiejscowienie
- Wyjaśnij, jak te działania można zrealizować.
*Korzystanie z filtrów – Wymień filtry dostępne w motywie i wyjaśnij, jak można je zaimplementować
Sekcja dotycząca aktualizowania motywu – wyjaśnij, jak użytkownicy mogą aktualizować motyw.
Sekcja dotycząca licencjonowania * Wyjaśnienie licencjonowania projektu i jego znaczenie dla osób, które mogą chcieć używać motywu CC WP Base w swoich prywatnych projektach.
Sekcja, na której należy dołączyć * Dodaj szczegółowy przewodnik * Przedstaw Kodeks postępowania * Społeczność: podaj informacje o kanałach społeczności Creative Commons oraz o tym, jak współtwórcy mogą uczestniczyć w wydarzeniu itp.