Basisprincipes van bijdragen voor Microsoft Learn
Er zijn enkele termen die u helpen het bijdrageproces te begrijpen en te voltooien. Het is niet nodig om alles te weten wat er onder de motorkap gebeurt, maar een algemeen overzicht van hoe bijdragen werken helpt u te begrijpen waarom het proces werkt zoals het doet.
Basisprincipes van Microsoft Learn en GitHub
Microsoft Learn bevat duizenden artikelen, trainingsmodules, webpagina's en meer, die moeten worden opgeslagen en regelmatig moeten worden geopend door verschillende inzenders. Microsoft Learn gebruikt GitHub om veel van deze inhoud op te slaan. GitHub is een platform dat gebruikmaakt van Git, een gedistribueerd versiebeheersysteem, om projecten op te slaan en samenwerking tussen meerdere belanghebbenden met verschillende projectdoelen en tijdlijnen mogelijk te maken. Met Git- en GitHub-software kunt u parallel met andere inzenders aan hetzelfde project werken, mogelijk exact dezelfde inhoud, zelfs op hetzelfde moment, zonder onbedoeld te verstoren met het werk van anderen.
Inhoud wordt opgeslagen in bestanden in Git-opslagplaatsen (opslagplaatsen ) die worden gehost op GitHub. Een opslagplaats is een opslageenheid die de bestanden en bestandsrevisiegeschiedenis van een project bevat. Opslagplaatsen kunnen openbaar of privé zijn en Microsoft Learn bestaat uit een combinatie van beide. Iedereen kan bijdragen aan een openbare opslagplaats zodra ze een GitHub-account hebben ingesteld. Privéopslagplaatsen zijn alleen beschikbaar voor inzenders die Microsoft-werknemers zijn of die speciale machtigingen hebben gekregen.
Wijzigingen aanbrengen in Microsoft Learn-inhoud die is opgeslagen in een GitHub-opslagplaats
Voor elk project host GitHub de hoofdopslagplaats en eventuele forks. Een fork is een kopie van de hoofdopslagplaats die een inzender maakt voor hun eigen werk. Een fork is een van de manieren waarop GitHub de gepubliceerde inhoud kan beveiligen. In plaats van inhoud rechtstreeks te bewerken in de live, gepubliceerde vertakking van de hoofdopslagplaats, maakt GitHub een momentopname van die inhoud voor uw fork, zodat u daar uw wijzigingen kunt aanbrengen.
GitHub-opslagplaatsen bevatten een of meer vertakkingen. Een vertakking is een opslageenheid die de bestanden en mappen bevat waaruit de inhoudsset van een project bestaat. Alle opslagplaatsen, ongeacht of het de hoofdopslagplaats of een fork is, bevatten een standaardbranch (meestal 'main' genoemd) en een of meer vertakkingen die zijn bestemd om weer te worden samengevoegd in de standaardbranch. De standaardbranch fungeert als de huidige versie en 'één bron van waarheid' voor het project. Alle andere vertakkingen in de opslagplaats worden hiervan afgeleid.
Het bewerken van een documentatieartikel in een openbare opslagplaats lijkt erop dat het begint met het aanraken van een knop, maar er gebeuren verschillende dingen achter de schermen. Wanneer u het bewerkingsproces op basis van de browser start, wordt er een fork van de opslagplaats gemaakt (als u er nog geen hebt) en gebruikt voor uw wijzigingen. U bewerkt in een vertakking van uw fork, die later wordt samengevoegd met de livebranch van de hoofdopslagplaats, zodat uw wijzigingen voor iedereen beschikbaar zijn.
Een pull-aanvraag maken
Hoe gebeurt deze samenvoeging? U moet GitHub vertellen, met name de eigenaren van de hoofdopslagplaats en auteurs van het artikel, dat uw bewerkingen zijn voltooid en gereed zijn voor beoordeling, publicatie en de wereld om te zien. Hiervoor maakt en verzendt u een pull-aanvraag.
Een pull-aanvraag (PR) is een voorstel voor het samenvoegen van uw wijzigingen vanuit de vertakking in uw fork waarmee u werkte in de standaard hoofdbranch van de liveopslagplaats. Wanneer u in een openbare opslagplaats werkt, worden uw pull-aanvragen altijd gecontroleerd door een menselijke revisor voordat deze wordt samengevoegd. Er kunnen ook enkele geautomatiseerde controles zijn, zoals samenvoegcompatibiliteit en buildvalidatie. Zodra deze beoordelingen zijn voltooid en eventuele problemen zijn opgelost, worden uw wijzigingen samengevoegd met de livebranch en worden ze beschikbaar op Microsoft Learn.
Werkstroom voor kleine bijdragen aan documentatie
Kortom, u volgt deze algemene stappen wanneer u kleine wijzigingen aanbrengt in microsoft-documentatie met behulp van de webeditor in GitHub:
- Wanneer u een bestand opent in uw browser om te bewerken, wordt automatisch een fork van de openbare opslagplaats voor u gemaakt. Er wordt ook een vertakking in uw fork gemaakt, ook wel een patchbranch genoemd.
- Breng uw wijzigingen aan in het bestand.
- Maak een pull-aanvraag om aan te stellen dat uw wijzigingen worden gecontroleerd en samengevoegd.
- Uw pull-aanvraag moet eventuele problemen oplossen en alle beoordelingen doorgeven.
- Uw pull-aanvraag wordt samengevoegd met de hoofdbranch van de liveopslagplaats en uw wijzigingen worden gepubliceerd op Microsoft Learn.
Laten we vervolgens elke stap nader bekijken om te leren hoe u ze uitvoert.