Microsoft Learnin sisällön perusteet
Jotkin termit auttavat sinua ymmärtämään ja suorittamaan prosessin loppuun. Ei ole tarpeen tietää kaikkea, mitä kulissien takana tapahtuu, mutta yleinen yleiskatsaus siitä, miten osallistuminen toimii, auttaa sinua ymmärtämään, miksi prosessi toimii niin kuin se toimii.
Microsoft Learnin ja GitHubin perusteet
Microsoft Learn sisältää tuhansia artikkeleita, koulutusmoduuleja, verkkosivuja ja paljon muuta, jotka eri osallistujien on tallennettava ja käytettävä säännöllisesti. Microsoft Learn käyttää GitHubia suuren osan tästä sisällöstä tallentamiseen. GitHub on ympäristö, joka käyttää hajautettua versiontarkistusjärjestelmää Git-järjestelmän avulla projektien tallentamiseen ja yhteistyön helpottamiseen useiden sidosryhmien välillä, joilla on erilaiset projektitavoitteet ja aikataulut. Git- ja GitHub-ohjelmiston avulla voit työskennellä rinnakkain muiden osallistujien kanssa samassa projektissa, mahdollisesti täsmälleen samaa sisältöä, jopa samaan aikaan, joutumatta häiritsemään tahattomasti muiden työtä.
Sisältö tallennetaan Git -säilöihin, (säilöihin), jotka isännöidään GitHubissa. Säilö on tallennusyksikkö, joka sisältää projektin tiedostot ja tiedostoversion historian. Säilöt voivat olla julkisia tai yksityisiä, ja Microsoft Learn koostuu molempien yhdistelmästä. Kuka tahansa voi osallistua julkiseen säilöön, kun hän on määrittänyt GitHub-tilin. Yksityiset säilöt ovat vain Sellaisten osallistujien käytettävissä, jotka ovat Microsoftin työntekijöitä tai joille on myönnetty erityinen käyttöoikeus.
GitHub-säilöön tallennetun Microsoft Learn -sisällön muokkaaminen
Missä tahansa projektissa GitHub isännöi pääsäilöä ja kaikkia haarautuvia haaroja. Haarautuva on kopio pääsäilöstä, jonka osallistuja tekee omaa työtään varten. Haarautuminen on yksi GitHubin tavoista suojata julkaistu sisältö. Sen sijaan, että GitHub muokkaa sisältöä suoraan pääsäilön reaaliaikaisessa, julkaistussa haarassa, se ottaa tilannevedoksen kyseisestä sisällöstä haaraumaan, jotta voit tehdä siihen haluamasi muutokset.
GitHub-säilöt sisältävät yhden tai useamman haaran. Haara on tallennusyksikkö, joka sisältää tiedostot ja kansiot, jotka muodostavat projektin sisältöjoukon. Kaikki säilöt, olipa kyseessä sitten pääsäilö tai haarautuvuus, sisältävät oletushaaran (jonka nimi on yleensä pää) ja yhden tai useamman haaran, jotka on tarkoitus yhdistää takaisin oletushaaraan. Oletushaara toimii nykyisenä versiona ja projektin yksittäisenä totuuden lähteenä. Kaikki muut säilön haarat luodaan päähaarasta.
Dokumentaatioartikkelin muokkaaminen julkisessa säilössä saattaa vaikuttaa siltä, että se alkaa painikkeen kosketuksella, mutta taustalla tapahtuu useita asioita. Kun käynnistät selainpohjaisen muokkausprosessin, säilöstä luodaan haaraosa (jos sinulla ei vielä ole sellaista) ja sitä käytetään muutoksissasi. Muokkaat haaraa haarassa, joka yhdistetään myöhemmin pääsäilön live-haaraan, jotta tekemäsi muutokset ovat kaikkien käytettävissä.
Pull-pyynnön luominen
Miten tämä yhdistäminen tapahtuu? Sinun on kerrottava GitHubille – tarkemmin sanottuna pääsäilön omistajille ja artikkelin tekijöille – että muokkauksesi on viimeistelty ja valmis tarkistettavaksi, julkaistavaksi ja maailmanlaajuiseksi! Voit tehdä tämän luomalla ja lähettämällä pull-pyynnön.
Pull-pyyntö (PR) on ehdotus muutosten yhdistämisestä haarahaarasta, jota työstit reaaliaikaisen säilön oletus pääasialliseen haaraan. Kun työskentelet julkisessa säilössä, ihmistarkastaja tarkistaa pull-pyyntösi aina ennen yhdistämistä. Jotkin automaattiset tarkastukset, kuten yhteensopivuus ja koontiversiovahvistus, saattavat olla myös automaattisia. Kun nämä tarkistukset ja mahdolliset ongelmat on ratkaistu, muutoksesi yhdistetään live-haaraan ja tulevat saataville Microsoft Learniin.
Pienten osallistumisten työnkulku dokumentaatioon
Yhteenvetona seuraat näitä yleisiä vaiheita, kun teet pieniä muutoksia Microsoft-dokumentaatioon GitHubin verkkoeditorilla:
- Kun avaat tiedoston selaimessa muokkausta varten, sinulle luodaan automaattisesti haarautuva haarautuja julkisesta säilöstä. Haarautumaan luodaan myös haara, jota kutsutaan usein korjaushaaraksi.
- Tee muutokset tiedostoon.
- Luo pull-pyyntö, jotta voit ehdottaa muutosten tarkistamista ja yhdistämistä.
- Pull-pyyntösi on ratkaistava mahdolliset ongelmat ja läpäistävä kaikki tarkistukset.
- Pull-pyyntö yhdistetään reaaliaikaisen säilön päähaaraan, ja muutoksesi julkaistaan Microsoft Learnissa.
Seuraavaksi tarkastelemme jokaista vaihetta lähemmin, jotta opimme suorittamaan ne.