Grunderna för bidrag för Microsoft Learn
Det finns vissa termer att veta som hjälper dig att förstå och slutföra bidragsprocessen. Det är inte nödvändigt att veta allt som händer under huven, men en allmän översikt över hur bidrag fungerar hjälper dig att förstå varför processen fungerar som den gör.
Grunderna i Microsoft Learn och GitHub
Microsoft Learn innehåller tusentals artiklar, utbildningsmoduler, webbsidor med mera, som måste lagras och användas regelbundet av olika deltagare. Microsoft Learn använder GitHub för att lagra mycket av det här innehållet. GitHub är en plattform som använder Git, ett distribuerat versionskontrollsystem, för att lagra projekt och underlätta samarbete mellan flera intressenter med olika projektmål och tidslinjer. Med Git- och GitHub-programvara kan du arbeta parallellt med andra deltagare i samma projekt, eventuellt exakt samma innehåll, även samtidigt, utan att oavsiktligt störa andras arbete.
Innehållet lagras i filer i Git-lagringsplatser (lagringsplatser) som finns på GitHub. En lagringsplats är en lagringsenhet som innehåller ett projekts filer och filrevisionshistorik. Lagringsplatser kan vara offentliga eller privata och Microsoft Learn består av en blandning av båda. Vem som helst kan bidra till en offentlig lagringsplats när de har konfigurerat ett GitHub-konto. Privata lagringsplatser är endast tillgängliga för deltagare som är Microsoft-anställda eller som har fått särskilt tillstånd.
Göra ändringar i Microsoft Learn-innehåll som lagras på en GitHub-lagringsplats
För alla projekt är GitHub värd för huvudlagringsplatsen och eventuella förgreningar. En förgrening är en kopia av huvudplatsen som en deltagare skapar för sitt eget arbete. En förgrening är ett av GitHubs sätt att skydda det publicerade innehållet. I stället för att redigera innehåll direkt i huvudlagringsplatsens live-, publicerade gren, tar GitHub en ögonblicksbild av innehållet för din förgrening så att du kan göra dina ändringar där.
GitHub-lagringsplatser innehåller en eller flera grenar. En gren är en lagringsenhet som innehåller de filer och mappar som utgör ett projekts innehållsuppsättning. Alla lagringsplatser, oavsett om det är huvudlagringsplatsen eller en förgrening, innehåller en standardgren (vanligtvis kallad main) och en eller flera grenar som ska sammanfogas tillbaka till standardgrenen. Standardgrenen fungerar som den aktuella versionen och "enskild sanningskälla" för projektet. Den är den överordnade grenen från vilken alla andra grenar i lagringsplatsen skapas.
Att redigera en dokumentationsartikel på en offentlig lagringsplats kan verka som om den börjar med en knapptryckning, men det finns flera saker som händer bakom kulisserna. När du startar den webbläsarbaserade redigeringsprocessen skapas en förgrening av lagringsplatsen (om du inte redan har en) och används för dina ändringar. Du redigerar i en gren av din förgrening, som senare sammanfogas till live-grenen av huvudlagringsplatsen så att dina ändringar är tillgängliga för alla.
Skapa en pull-begäran
Hur sker den här sammanslagning? Du måste berätta för GitHub – särskilt huvudlagringsplatsens ägare och artikelns författare – att dina redigeringar är slutförda och redo för granskning, publicering och världen att se! Det gör du genom att skapa och skicka en pull-begäran.
En pull-begäran (PR) är ett förslag på att dina ändringar ska sammanfogas från grenen i din förgrening som du arbetade i till den aktiva lagringsplatsens standardgren. När du arbetar på en offentlig lagringsplats granskas alltid dina pull-begäranden av en mänsklig granskare innan de sammanfogas. Det kan också finnas vissa automatiserade kontroller, till exempel sammanslagningskompatibilitet och byggverifiering. När dessa granskningar har slutförts och eventuella problem har lösts sammanfogas dina ändringar till live-grenen och blir tillgängliga på Microsoft Learn!
Arbetsflöde för mindre bidrag till dokumentationen
Sammanfattningsvis följer du dessa allmänna steg när du gör små ändringar i Microsoft-dokumentationen med hjälp av webbredigeraren i GitHub:
- När du öppnar en fil i webbläsaren för redigering skapas automatiskt en förgrening av den offentliga lagringsplatsen åt dig. En gren i din förgrening skapas också, ofta kallad en korrigeringsgren.
- Gör dina ändringar i filen.
- Skapa en pull-begäran för att föreslå att ändringarna granskas och sammanfogas.
- Din pr måste lösa eventuella problem och klara alla granskningar.
- Din pr sammanfogas till huvudgrenen för den aktiva lagringsplatsen och dina ändringar publiceras på Microsoft Learn.
Nu ska vi titta närmare på varje steg för att lära oss hur du utför dem.