Een documentatieartikel bewerken in uw browser

  • 5 minuten

Nu u een overzicht hebt van de algemene hulpprogramma's en het verplaatsen van onderdelen achter de schermen van een bijdrage, gaan we kijken naar de specifieke stappen om een kleine bijdrage te leveren aan de Microsoft-documentatie. Als u een kleine wijziging wilt aanbrengen in een artikel, moet u eerst de juiste hulpprogramma's instellen. Vervolgens bent u klaar om uw kennis te bewerken en te delen met andere leden van de Microsoft Learn-community.

Stap 1: Uw GitHub-account instellen

Omdat Microsoft Learn GitHub-werkstromen integreert om inhoud bij te werken, hebt u een GitHub-account nodig om een bijdrage te leveren. Als u al een GitHub-account hebt, controleert u of u bent aangemeld.

Als u nog geen GitHub-account hebt, gebruikt u de volgende stappen om er een te maken:

  1. Ga naar www.github.com
  2. Selecteer Registreren.
  3. Volg de aanwijzingen om uw account in te stellen.

Stap 2: Breng uw wijzigingen aan

Vergeet niet dat niet alle Microsoft Learn-inhoud wordt opgeslagen in een openbare opslagplaats. Voordat u wijzigingen aanbrengt, moet u eerst controleren of de inhoud waaraan u wilt bijdragen beschikbaar is voor openbare bijdrage. Zo ja, dan kunt u rechtstreeks wijzigingen aanbrengen in uw browser.

  1. Navigeer naar het documentatieartikel over learn.microsoft.com dat u wilt bewerken. Controleer of het artikel is opgeslagen in een openbare opslagplaats door het potloodvormige bewerkingspictogram boven aan het artikel te zoeken. Als u het pictogram ziet, komt het in aanmerking voor openbare bijdrage!

  2. Selecteer het potloodpictogram Bewerken. Hiermee gaat u naar het bronbestand in de openbare GitHub-opslagplaats waarin het artikel is opgeslagen.

    Screenshot of a Microsoft Learn documentation article with the pencil Edit icon highlighted.

  3. Selecteer het potloodpictogram boven aan de pagina van het GitHub-bestand. Dit pictogram heeft het label Dit bestand bewerken in uw fork van dit project of fork van deze opslagplaats en bewerk het bestand , afhankelijk van of u de opslagplaats waar het bestand is opgeslagen al hebt gesplitst.

    U moet op dit moment zijn aangemeld bij uw GitHub-account om dit pictogram Bewerken te selecteren. Als u niet bent aangemeld, is deze optie niet beschikbaar.

    Screenshot of the GitHub source file for a documentation article. The Edit file pencil icon is highlighted.

    Bovenaan het artikel ziet u de metagegevens van het artikel. Metagegevens worden toegepast op artikelen voor rapportage, vindbaarheid via zoeken en het stimuleren van aspecten van de site-ervaring. Als u kleine updates aanbrengt in een gepubliceerd artikel, hoeft u waarschijnlijk de metagegevens niet te wijzigen.

  4. Als dit de eerste keer is dat u in deze opslagplaats werkt, wordt u gevraagd om de opslagplaats te splitsen voordat u wijzigingen voorstelt. Als dit het volgende is, selecteert u Fork deze opslagplaats.

  5. U ziet de bewerkingsinterface of het deelvenster Bewerken in uw browser. U kunt het artikel zien dat is geschreven in Markdown, een syntaxis voor opmaak. Breng uw wijzigingen aan in het deelvenster.

    Screenshot of a browser with a documentation article written in Markdown syntax, which can be edited in the Edit pane.

  6. Selecteer bovenaan het bewerkingsvenster het tabblad Voorbeeld . Hiermee kunt u uw wijzigingen valideren door ze te bekijken in hun gepubliceerde formulier.

Stap 3: Uw pull-aanvraag maken

Wanneer u klaar bent met het maken en bekijken van uw wijzigingen, is het tijd om uw pull-aanvraag (PR) te maken. Houd er rekening mee dat een pull-aanvraag uw manier is om te voorstellen dat uw wijzigingen worden samengevoegd met de hoofdbranch van de liveopslagplaats om zichtbaar te worden in Microsoft Learn. Een pull-aanvraag maakt het samenwerkingsmodel van GitHub mogelijk door te vragen om de wijzigingen van uw werkbranch op te halen en samen te voegen in een andere vertakking. In de meeste gevallen is deze andere vertakking de standaardbranch in de hoofdopslagplaats.

  1. Zoek en selecteer de knop Wijzigingen doorvoeren of Knop Wijzigingen voorstellen, meestal boven aan de pagina.

  2. Voeg een doorvoerbericht toe. Dit wordt de titel van uw pull-aanvraag. Het doorvoerbericht moet een korte samenvatting van uw wijzigingen zijn. Voeg desgewenst een uitgebreide beschrijving toe om meer informatie over uw wijzigingen te geven.

    Screenshot of the pop up box with two fields to create a Commit message and add an extended description of the changes.

  3. Selecteer Wijzigingen voorstellen.

  4. Op de volgende pagina wordt u gevraagd te controleren waar u de wijzigingen wilt samenvoegen, de basisnaam. Controleer of de basis is main.

    Screenshot of the webpage where contributors should verify the destination repository and branch they want to merge changes to. Main is selected as the Base.

  5. Selecteer Pull-aanvraag maken.

  6. Bekijk een voorbeeld van uw pull-aanvraag. Breng eventuele wijzigingen aan in de titel- of beschrijvingsvelden.

  7. Selecteer de knop Pull-aanvraag maken. Hiermee opent u uw pull-aanvraag.

Uw pull-aanvraag is gemaakt, maar deze is nog niet ingediend. In de volgende stap voert u de laatste verificatiestappen in uw pull-aanvraag uit om deze samen te voegen.

Scenario: Een Azure-app s Service-artikel bewerken

U bent een software-engineer met speciale expertise in Azure-app Service. Wanneer u een documentatieartikel over App Service bekijkt, ziet u een detail die u wilt toevoegen, zodat anderen de service kunnen gebruiken. U besluit uw kennis te delen door uw eerste bijdrage te leveren aan Microsoft Learn. Nadat u zich hebt aangemeld bij uw GitHub-account, begint u met het bijdrageproces: