Jak dołożyć swoje

Każdy może dołożyć coś do tej wiki. Każdy poradnik to plik tekstowy trzymany na GitHubie, darmowej stronie, na której ludzie wspólnie pracują nad plikami. Ty proponujesz zmianę. Opiekun ją sprawdza i publikuje.

Zanim zaczniesz

Potrzebujesz darmowego konta GitHub. Załóż je na github.com/signup. To jedyna konfiguracja.

Trzy słowa, które będziesz często widzieć:

• Fork to twoja własna kopia plików wiki na GitHubie.
• Commit to zapisana zmiana w tych plikach.
• Pull request (albo PR) prosi opiekunów o opublikowanie twojej zmiany.

Napisz nowy poradnik

Wiki ma edytor wizualny. Piszesz w przeglądarce i widzisz podgląd na żywo. Bez pobierania, bez kodu.

1. Kliknij Contribute na górnym pasku. Otworzy się okno z dwiema opcjami.
2. Wybierz Visual editor. Edytor się otworzy.
3. Wypełnij Title, Category i Description.
4. Pisz poradnik po lewej. Prawa strona pokazuje, jak będzie wyglądać opublikowana strona.

Gotowy, żeby to wysłać?

5. Kliknij Contribute w prawym górnym rogu.

6. Edytor może zaproponować linki do innych poradników, które znalazł w twoim tekście. Kliknij te, które chcesz, potem kliknij Continue to GitHub.

7. Otworzy się okno Publish your guide. Ma trzy kroki. Trzymaj tę kartę otwartą, aż skończysz.

8. Wpisz swoją nazwę użytkownika GitHub w polu. Przyciski poniżej używają jej, żeby znaleźć twojego forka.

9. Kliknij Fork on GitHub. GitHub otworzy stronę Create a new fork. Kliknij zielony przycisk Create fork. To tworzy twoją własną kopię wiki. Robisz to tylko raz. Masz już forka? Pomiń ten krok.

   

10. Wróć do karty z wiki. Kliknij Create the file on GitHub.

    

11. GitHub otworzy nowy plik w twoim forku z wypełnionym poradnikiem. Sprawdź nazwę pliku i tekst. Potem kliknij zielony przycisk Commit changes... w prawym górnym rogu.

    

12. Otworzy się małe okno. Zostaw pierwszą opcję, Commit directly to the main branch. Kliknij Commit changes.

    

13. Wróć do karty z wiki. Kliknij Open the pull request on GitHub.

    

14. GitHub pokaże twoje zmiany i formularz. Wypełnij formularz. Zostaw zaznaczone Allow edits by maintainers. Kliknij Create pull request.

    

To wszystko. Opiekun sprawdza twój poradnik i publikuje go. Twój poradnik używał obrazków? Jeszcze jeden krok: zobacz Dodaj obrazki poniżej.

Edytuj istniejący poradnik

1. Otwórz poradnik, który chcesz zmienić.
2. Zjedź na sam dół. Kliknij Edit on GitHub. Edytor wizualny otworzy się z wczytanym poradnikiem.
3. Wprowadź zmiany.
4. Kliknij Contribute.
5. Kliknij Copy MDX. GitHub nie potrafi wstępnie wypełnić edycji, więc wklejasz je sam.
6. Kliknij Open guide on GitHub.
7. Kliknij ikonę ołówka w prawym górnym rogu pliku.
8. Zaznacz cały stary tekst. Wklej na niego swoją kopię.
9. Kliknij Commit changes..., potem Propose changes, potem Create pull request.

Dodaj obrazki

W edytorze kliknij Upload image, żeby wstawić obrazek do poradnika. Obrazek od razu pojawia się w podglądzie. Ale plik obrazka nie jedzie na GitHuba razem z tekstem. Wgrywasz go sam, po zacommitowaniu poradnika.

Wgraj obrazki po zacommitowaniu

Kiedy twój draft używa obrazków, okno Contribute wypisuje dokładne nazwy plików do wgrania. Miej tę listę pod ręką.

1. Najpierw zacommituj poradnik (kroki powyżej), żeby twój pull request istniał.
2. Wróć do karty z wiki. W oknie Contribute kliknij Upload on GitHub. Otworzy się folder z obrazkami twojego forka.
3. Przeciągnij do niego obrazki. Zachowaj nazwy plików dokładnie takie, jakich używa twój poradnik.
4. Kliknij Commit changes. Zostaw pierwszą opcję, commit do main.

Obrazki same dołączają do twojego pull requesta. Pokazują się na wiki, gdy twój pull request zostanie zmergowany.

Zasady dla obrazków

• Używaj małych liter w nazwach plików z myślnikami: moj-screenshot.png, nie Moj Screenshot.png.
• Daj każdemu obrazkowi alt text, który go opisuje. Opiekunowie to sprawdzają.
• Trzymaj każdy plik poniżej 500 KB. Większe pliki spowalniają stronę.
• Używaj PNG do screenshotów, JPG do zdjęć. WebP też działa.

Co się dzieje po otwarciu pull requesta

1. Jako komentarz do twojego pull requesta pojawia się link do podglądu. Otwórz go, żeby zobaczyć swoją zmianę na żywo.
2. Opiekun sprawdza twój tekst, linki i obrazki. Może poprosić o drobne zmiany.
3. Po zatwierdzeniu twoja zmiana zostaje zmergowana. Wchodzi na wiki w ciągu kilku minut.

Pracuj na swoim komputerze (zaawansowane)

Przy nowych kategoriach, dużych przeróbkach albo wielu plikach naraz pracuj lokalnie. Potrzebujesz Node 22+, Gita i edytora kodu.

git clone https://github.com/<your-username>/divine-wiki.git
cd divine-wiki
npm install
npm run dev

Najpierw zforkuj repo na github.com/DivineSkins/divine-wiki, potem sklonuj swojego forka. Otwórz http://localhost:3000, żeby sprawdzić, czy strona się wczytuje. Zrób brancha, zmieniaj pliki w content/docs/en/lol/, wrzucaj obrazki do public/wiki-images/, potem zrób push i otwórz pull request do main.

Potrzebujesz pomocy?

• Utknąłeś na GitHubie albo w edytorze? Zapytaj na #wiki-feedback na Discordzie.
• Planujesz dużą zmianę, jak nowa kategoria czy restrukturyzacja? Napisz najpierw na #wiki-proposals. To uchroni cię przed robotą, która zostanie odrzucona.