A Microsoft Learn dokumentációjának szerkesztési áttekintése
Köszönjük, hogy érdeklődik a Microsoft Learn dokumentációjának szerkesztése iránt! Az Ön közreműködése segít nekünk abban, hogy dokumentációnk megfelelően meg legyen írva, naprakész és pontos legyen. Az ezen az oldalon található információk segítenek eldönteni, hogy melyik módszer a legjobb az Ön számára.
Előfeltétel
Mielőtt hozzákezd, győződjön meg arról, hogy bejelentkezett a GitHub-fiókjába. Ha nem rendelkezik GitHub-fiókkal, lépjen https://github.com/join egy gyors és ingyenes regisztrációs folyamathoz.
A dokumentáció kisebb módosításai
A kisebb módosítások gyorsak és egyszerűek. Néhány példa kisebb módosításokra:
- Elírások javítása
- Egyetlen cikk felülvizsgálata
- Szakasz hozzáadása egy cikkhez
- Hiba kijavítása
- Hibás hivatkozások frissítése
Ha kisebb módosításokat végez, csak egy GitHub-fiókra van szüksége!
Kisebb módosításhoz válassza a Dokumentum szerkesztése ceruza ikont a cikk tetején. Ez a művelet a GitHub forrásfájljához nyitja meg, ahol elvégezheti a módosításokat. Ha végzett, a rendszer kérni fogja, hogy hozzon létre egy lekéréses kérelmet (PR) a módosítások javaslatához. Ennek a folyamatnak a teljes ismertetését lásd : Dokumentáció szerkesztése a böngészőben.
A dokumentáció főbb változásai
A jelentős változások több időt és energiát igényelnek. A főbb változások közé tartoznak például a következők:
- Összetett módosítások, amelyek több napig is eltarthatnak
- Több olyan cikk korrektúrái, amelyeket együtt szeretne elküldeni
- Új cikk létrehozása
- Gyakran közreműködik
Ha jelentős módosításokat végez, le kell töltenie és telepítenie kell néhány eszközt, hogy megkönnyítse a munkát. A kezdéshez hajtsa végre az alábbi lépéseket:
- Telepítse a Git- és Markdown-eszközöket.
- Állítson be egy helyi Git-adattárat.
- Módosítsa a dokumentációt.
- Pr létrehozása.
Folyamat áttekintése
Az alábbi folyamat a kisebb és nagyobb módosítások első lépéseit mutatja be. Figyelje meg, hogy egyes elemek egyszeri lépések, míg mások minden alkalommal előfordulnak, amikor új hozzájárulást kezd.
A kép a következő döntési ponttal kezdődik: Ez az első alkalom, hogy hozzájárul? Ha igen, a következő lépés a GitHub-fiók beállítása. Ha nem, a következő lépés a kisebb módosítás másik döntési pontja? Ha igen, a következő lépés a böngészőben történő szerkesztés. Ha nem, a következő lépések magukban foglalják a szerzői eszközök telepítését, az adattár elágaztatását és klónozását, a módosítások megtételét, a lekéréses kérelem megnyitását, valamint a lekéréses kérelem áttekintését és kijelentkezését.
A képzési modulok változásai
A közreműködők nem szerkeszthetik és nem javasolhatják a képzési modulok módosítását. Jelenleg csak a nyilvános adattárakban tárolt Microsoft Learn-dokumentáció érhető el nyilvános hozzájárulásokra.