Konfigurera en lokal Git-lagringsplats för dokumentation

Den här artikeln beskriver stegen för att ställa in en Git-lagringsplats på din lokala dator, i syfte att bidra till Microsoft-dokumentationen. Deltagare kan använda en lokalt klonad lagringsplats för att lägga till nya artiklar, utföra större ändringar i befintliga artiklar eller ändra bilder.

Du kör de här engångskonfigurationsaktiviteterna för att börja bidra:

Översikt

Om du vill bidra till dokumentationen på Microsoft Learn kan du skapa och redigera Markdown-filer lokalt genom att klona motsvarande dokumentationslagringsplats. Microsoft kräver att du förgrenar lämplig lagringsplats till ditt eget GitHub-konto så att du har läs- och skrivbehörighet för att lagra dina föreslagna ändringar. Sedan använder du pull-begäranden (PR) för att sammanfoga ändringar till den skrivskyddade centrala delade lagringsplatsen.

Fastställ lagringsplatsen

Dokumentation som finns på Microsoft Learn finns på flera lagringsplatser på GitHub.

1. Om du är osäker på vilken lagringsplats en artikel finns i kan du gå till artikeln med hjälp av webbläsaren. Välj länken Redigera (pennikonen) i det övre högra hörnet av artikeln.

   

2. Den här åtgärden tar dig till källfilen på GitHub. Lagringsplatsens namn visas i det övre vänstra hörnet på sidan.

   

   Här är några populära lagringsplatser som är tillgängliga för offentliga bidrag:

   • Communityinnehåll för Microsoft Learn https://github.com/MicrosoftDocs/community-content/
   • Azure-dokumentation https://github.com/MicrosoftDocs/azure-docs
   • Dokumentation om SQL Server https://github.com/MicrosoftDocs/sql-docs
   • Visual Studio-dokumentation https://github.com/MicrosoftDocs/visualstudio-docs
   • .NET-dokumentation https://github.com/dotnet/docs
   • Dokumentation om Azure .NET SDK https://github.com/azure/azure-docs-sdk-dotnet
   • ConfigMgr-dokumentation https://github.com/MicrosoftDocs/SCCMdocs

Förgrena lagringsplatsen

När du har identifierat rätt lagringsplats är nästa steg att förgrena lagringsplatsen till ditt eget GitHub-konto.

Att förgrena en lagringsplats innebär att skapa en kopia av den i ditt GitHub-konto. En personlig förgrening krävs eftersom alla Microsoft-dokumentationslagringsplatser ger skrivskyddad åtkomst, men din förgrening ger dig skrivbehörighet för att göra dina ändringar. Med förgreningen kan du öppna PRs från din förgrening till Microsoft-lagringsplatsen.

1. På github-sidan för huvudlagringsplatsen väljer du knappen Förgrening i det övre högra hörnet.

   

2. På skärmen Skapa en ny förgrening kontrollerar du att Ägaren är inställd på ditt användarnamn och att Kopiera endast huvudgrenen är markerad. Du kan också ändra fälten Lagringsplatsnamn och Beskrivning .

   

Klona lagringsplatsen

Klon innebär att skapa en kopia av en lagringsplats på den lokala datorn.

1. Skapa en GitHub mapp på den lokala datorn. Till exempel C:\GitHub. (Klona inte till en OneDrive-synkronisering mapp.)

2. I en webbläsare går du till GitHub.com och loggar in.

3. I GitHub längst upp till höger går du till listrutan profil och väljer Dina lagringsplatser. Sidan lagringsplatser visas med en lista över dina förgrenade lagringsplatser.

4. Välj den lagringsplats som du vill klona. Lagringsplatsens sida för Din förgrening visas.

   Kontrollera att du är på lagringsplatsens sida för din förgrening, inte sidan för produktionslagringsplatsen. Du kan bekräfta att lagringsplatsen du använder är din förgrening genom att kontrollera URL:en: den bör visa ditt GitHub-användarnamn, inte Microsoft-organisationen (till exempel https://github.com/nancydavolio/azure-docs och INTE https://github.com/MicrosoftDocs/azure-docs). Dessutom visas ditt namn i det övre vänstra hörnet, och du ser en anteckning som säger förgrening följt av namnet på huvudlagringsplatsen.

   

5. Välj fliken <> Kod längst upp till vänster på sidan.

6. Till höger i listrutan Kod kopierar du URL:en under HTTPS-alternativet .

   

Klona från Visual Studio Code

1. Öppna Visual Studio Code.

2. Välj Visa i den övre navigeringsmenyn och välj sedan Terminal. Terminalvyn visas längst ned på Visual Studio Code-skärmen.

3. I terminalvyn kör du kommandot för att ändra katalogen (cd) till mappen GitHub som du skapade för lagringsplatser på enheten i steg 1 i avsnittet Klona en lagringsplats.

   Exempel:

    cd C:\GitHub
   

   Om du får ett fel kan du behöva ändra katalog en mapp i taget.

4. Kör följande kommando för att klona lagringsplatsen:

   git clone <paste the clone URL you copied via the GitHub UI>
   

   Till exempel:

   git clone https://github.com/nancydavolio/azure-docs.git
   

5. När du uppmanas att autentisera via webbläsaren väljer du knappen "Logga in med webbläsaren" och slutför processen. Se till att ladda ned den senaste versionen av Git, som stöder autentisering via webbläsarfunktioner. Om du väljer att använda en personlig Åtkomsttoken för GitHub kan du generera en enligt dessa instruktioner: Skapa en personlig åtkomsttoken.

   Klonkommandot laddar ned lagringsplatsens filer från din förgrening till en ny mapp på den plats som du valde i steg 3. En ny mapp skapas i den aktuella mappen. Det kan ta några minuter, beroende på lagringsplatsens storlek. Du kan utforska mappen för att se strukturen när den är klar.

Konfigurera fjärranslutningar

När du har klonat lagringsplatsen konfigurerar du en skrivskyddad anslutning till huvudlagret med namnet upstream. Fjärranslutningar är alias som refererar till fjärranslutna lagringsplatser. Origin refererar till din förgrening och uppströms refererar till produktionslagringsplatsen. Git skapade origin automatiskt fjärren när du körde clone kommandot. Du använder denna uppströms-URL för att synkronisera din lokala lagringsplats med de senaste uppdateringarna som andra deltagare har gjort.

Kör följande kommandon i git bash- eller VS-kodterminalen.

1. Ändra katalogen (cd) till den lagringsplatsmapp som clone kommandot skapade. Till exempel:

   cd repo-name
   

2. Kör följande kommando för att lägga till en fjärranslutning med namnet upstream som pekar på produktionslagringsplatsen. Till exempel är https://github.com/MicrosoftDocs/azure-docs.git lagringsplatsens upstream URL i stället https://github.com/nancydavolio/azure-docs.gitför .

   git remote add upstream <the clone URL of the main repo>
   

   Till exempel:

   git remote add upstream https://github.com/MicrosoftDocs/azure-docs.git
   

3. Kör följande kommando för att kontrollera att fjärrdatorerna är korrekta:

   git remote -v
   

   Exempel på utdata:

   origin  https://github.com/nancydavolio/azure-docs.git (fetch)
   origin  https://github.com/nancydavolio/azure-docs.git (push)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (fetch)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (push)
   

4. Om du har gjort ett misstag tar du bort fjärren och upprepar steget för att lägga till den. Om du vill ta bort upstreamkör du kommandot:

   git remote remove upstream
   

Nästa steg

• Nu när du har konfigurerat din lokala klon är det dags att göra större ändringar.