A Microsoft Learn hozzájárulási alapjai
Vannak olyan kifejezések, amelyek segítenek a hozzájárulási folyamat megértésében és befejezésében. Nem szükséges mindent tudni, ami a motorháztető alatt történik, de a hozzájárulási munka általános áttekintése segít megérteni, hogy a folyamat miért működik úgy, ahogy.
A Microsoft Learn és a GitHub alapjai
A Microsoft Learn több ezer cikket, képzési modult, weblapot és egyebeket tartalmaz, amelyeket különböző közreműködőknek kell tárolniuk és rendszeresen elérnie. A Microsoft Learn a GitHub használatával tárolja a tartalom nagy részét. A GitHub egy olyan platform, amely a Gitet, egy elosztott verziókövetési rendszert használ a projektek tárolására és a különböző projektcélokkal és ütemtervekkel rendelkező több érdekelt fél közötti együttműködés elősegítésére. A Git és a GitHub szoftver lehetővé teszi, hogy párhuzamosan dolgozzon más közreműködőkkel ugyanazon a projekten, akár ugyanabban az időben is pontosan ugyanazzal a tartalommal, anélkül, hogy véletlenül megzavarja mások munkáját.
A tartalom a GitHubon üzemeltetett Git-adattárakban (adattárakban) tárolt fájlokban van tárolva. Az adattár egy olyan tárolóegység, amely egy projekt fájljait és fájlváltozat-előzményeit tartalmazza. Az adattárak lehetnek nyilvánosak vagy privátak, a Microsoft Learn pedig mindkettőből áll. A GitHub-fiók beállítása után bárki közreműködhet egy nyilvános adattárban. A privát adattárak csak olyan közreműködők számára érhetők el, akik Microsoft-alkalmazottak, vagy akik különleges engedélyt kaptak.
A GitHub-adattárban tárolt Microsoft Learn-tartalmak szerkesztése
Minden projekt esetében a GitHub üzemelteti a fő adattárat és az esetleges elágazzásokat. Az elágazás annak a fő adattárnak a másolata, amelyet a közreműködő a saját munkájához készít. Az elágaztatás a GitHub egyik módszere a közzétett tartalom védelmére. A GitHub ahelyett, hogy közvetlenül szerkeszti a tartalmat a fő adattár élő, közzétett ágában, pillanatképet készít erről a tartalomról az elágaztatáshoz, így ott végezheti el a módosításokat.
A GitHub-adattárak egy vagy több ágat tartalmaznak. Az ág egy tárolóegység, amely tartalmazza a projekt tartalomkészletét alkotó fájlokat és mappákat. Minden adattár, legyen az a fő adattár vagy egy elágazás, tartalmaz egy alapértelmezett ágat (általában "main" néven), és egy vagy több ágat, amelyeket vissza szeretne vonni az alapértelmezett ágba. Az alapértelmezett ág a projekt aktuális verziójaként és "egyetlen igazságforrásként" szolgál. Ez a tárházban létrehozott összes további ág szülője.
Úgy tűnhet, hogy egy dokumentációs cikk szerkesztése egy nyilvános adattárban gombnyomással kezdődik, de a színfalak mögött számos dolog történik. Amikor elindítja a böngészőalapú szerkesztési folyamatot, létrejön az adattár elágazása (ha még nem volt ilyen), és a módosításokhoz használatos. Az elágaztatás egy ágán belül szerkeszt, amelyet később egyesít a fő adattár élő ágával, így a módosítások mindenki számára elérhetők lesznek.
Lekéréses kérelem létrehozása
Hogyan történik ez az egyesítés? Meg kell mondania a GitHubnak - különösen a fő adattár tulajdonosainak és a cikk szerzőinek -, hogy a szerkesztései véglegesítve vannak, és készen állnak a felülvizsgálatra, a közzétételre és a világ megtekintésére! Ehhez létre kell hoznia és be kell küldenie egy lekéréses kérelmet.
A lekéréses kérelem (PR) azt a javaslatot adja, hogy a módosítások egyesítve legyenek az elágaztatásban lévő ágból, amelyen az élő adattár alapértelmezett "fő" ágába dolgozott. Amikor nyilvános adattárban dolgozik, a lekéréses kérelmeket mindig egy emberi felülvizsgáló fogja áttekinteni, mielőtt egyesítené őket. Lehetnek automatizált ellenőrzések is, például az egyesítés kompatibilitása és a buildérvényesítés. A felülvizsgálatok befejezése és a problémák megoldása után a módosítások egyesítve lesznek az élő ágban, és elérhetővé válnak a Microsoft Learnben!
Munkafolyamat a dokumentációban való kisebb közreműködéshez
Összefoglalva, az alábbi általános lépéseket fogja követni, amikor a GitHub webszerkesztőjével kis módosításokat hajt végre a Microsoft dokumentációjában:
- Amikor megnyit egy fájlt a böngészőben szerkesztésre, a rendszer automatikusan létrehozza a nyilvános adattár elágazását. Létrejön egy ág is az elágazóban, amelyet gyakran javításágnak is neveznek.
- Módosítsa a fájlt.
- Hozzon létre egy lekéréses kérelmet, amely javasolja a módosítások felülvizsgálatát és egyesítése.
- A lekéréses kérelemnek meg kell oldania a problémákat, és át kell adnia az összes felülvizsgálatot.
- A lekéréses kérelem az élő adattár fő ágába lesz egyesítve, és a módosítások a Microsoft Learnben lesznek közzétéve.
Ezután nézzük meg közelebbről az egyes lépéseket, hogy megtudjuk, hogyan hajthatja végre őket.