Microsoft Docs deltagarguide – översiktMicrosoft Docs contributor guide overview

Välkommen till deltagarguiden för docs.microsoft.com (Docs)!Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Flera av Microsofts dokumentuppsättningar har öppen källkod och finns tillgängliga på GitHub.Several of the Microsoft documentation sets are open source and hosted on GitHub. Vissa dokumentuppsättningar har inte öppen källkod, men många har offentliga lagringsplatser där du kan utföra rekommenderade ändringar via pull-begäranden.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Användningen av öppen källkod effektiviserar och förbättrar kommunikationen mellan produkttekniker, innehållsteam, kunder och erbjuder även andra fördelar:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Planeringar i lagringsplatser med öppen källkod sker öppet för att ge feedback om vilka dokument som behövs mest.Open source repos plan in the open to get feedback on what docs are most needed.
  • Granskningar i lagringsplatser med öppen källkod sker öppet för att det mest användbara innehållet ska publiceras i den första utgåvan.Open source repos review in the open to publish the most helpful content on our first release.
  • Uppdateringar i lagringsplatser med öppen källkod sker öppet för att enklare kunna förbättra innehållet kontinuerligt.Open source repos update in the open to make it easier to continuously improve the content.

Användarupplevelsen på docs.microsoft.com integrerar GitHub-arbetsflödet direkt för att göra det ännu enklare.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Börja med att redigera det dokument du visar.Start by editing the document you are viewing. Eller hjälp till genom att granska nya ämnen eller skapa kvalitetsärenden.Or, help by reviewing new topics, or create quality issues.

Important

Alla informationslager som publicerar till docs.microsoft.com har antagit Microsoft Open Source-uppförandekoden eller .NET Foundation-uppförandekoden.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Mer information finns i vanliga frågor och svar om uppförandekoden.For more information, see the Code of Conduct FAQ. Eller kontakta opencode@microsoft.com, eller conduct@dotnetfoundation.org med frågor eller funderingar.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Mindre korrigeringar eller förklaringar till dokumentation och kodexempel i offentliga databaser hittar du i Användningsvillkor för docs.microsoft.com.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Vid nya eller avsevärda förändringar skapas en kommentar i pull-begäran, där du ombes skicka in ett licensavtal för bidrag online om du inte är anställd inom Microsoft.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Du måste fylla i hela online-formuläret innan vi kan granska eller acceptera din pull-begäran.We need you to complete the online form before we can review or accept your pull request.

Snabbredigeringar i existerande dokumentQuick edits to existing documents

Snabbredigeringar strömlinjeformar processen med att rapportera och korrigera små fel och utelämningar i dokumenten.Quick edits streamline the process to report and fix small errors and omissions in documents. Trots stora ansträngningar händer det att en del mindre grammatiska fel och stavfel smyger sig in i våra publicerade dokument.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Du kan skapa ärenden för att rapportera misstag, men det är snabbare och enklare att skapa en pull-begäran för att lösa problemet när alternativet finns tillgängligt.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. Vissa dokumentsidor låter dig redigera innehåll direkt i webbläsaren.Some docs pages allow you to edit content directly in the browser. Du ser i sådana fall knappen Edit (Redigera) som på bilden nedan.If so, you'll see an Edit button like the one shown below. Om du klickar på knappen Edit (eller motsvarande översättning) kommer du till källfilen på GitHub.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Om knappen Redigera saknas innebär det att dokumentsidan inte kan ändras.If the Edit button is missing, that means the documentation page is not available to be changed.

    Platsen för länken Redigera

  2. Klicka sedan på pennikonen för att redigera artikeln enligt instruktionerna.Next, click the pencil icon, to edit the article as shown. Om pennikonen är nedtonad måste du antingen logga in på ditt GitHub-konto eller skapa ett nytt konto.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Platsen för pennikonen

  3. Gör dina ändringar i webbredigeraren.Make your changes in the web editor. Klicka på fliken Förhandsgranska ändringar för att kontrollera formateringen på din ändring.Click the Preview changes tab to check the formatting of your change.

  4. Då du har gjort ändringarna rullar du längst ner på sidan.Once you have made your changes, scroll to the bottom of the page. Ange titel och beskrivning för dina ändringar och klicka på Föreslå filändring såsom visas i följande figur:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Föreslå filändring

  5. Nu när du har gjort en föreslagen ändring måste du be ägaren av lagringsplatsen att ”dra” dina ändringar in i lagringsplatsen.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Detta görs med någonting som kallas för ”pull-begäran”.This is done using something called a "pull request". När du klickat på Föreslå filändring i figuren ovan ska du ha blivit tagen till en ny sida som ser ut som följande bild:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

    skapa en pull-begäran

    Klicka på Skapa pull-begäran, ange en titel (och, valfritt, en beskrivning) för pull-begäran och klicka sedan igen på Skapa pull-begäran.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Om du är nybörjare på GitHub kan du läsa Om pull-begäranden för mer information.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Klart!That's it! Medlemmar i innehållsteamet kommer att granska och slå samman din pull-begäran.Content team members will review and merge your PR. Du kan få viss feedback som begär ändringar om du gjort större ändringar.You may get some feedback requesting changes if you made larger changes.

Användargränssnittet för GitHub-redigering tar hänsyn till vilka behörigheter du har för lagringsplatsen.The GitHub editing UI responds to your permissions on the repository. Följande bilder är korrekta för deltagare som inte har skrivbehörigheter till mållagringsplatsen.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub skapar automatiskt en förgrening för mållagringsplatsen i ditt konto.GitHub automatically creates a fork of the target repository in your account. Om du har skrivåtkomst till mållagringsplatsen skapar GitHub en ny gren på mållagringsplatsen.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Grennamnet har formatet <GitHubId>-patch-n och använder ditt GitHub-ID och en numerisk identifierare för korrigeringsgrenen.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Vi använder pull-begäranden för alla ändringar, även för deltagare som har skrivåtkomst.We use pull requests for all changes, even for contributors that have write-access. De flesta lagringsplatser har master-grenen skyddad så att uppdateringar måste skickas som pull-begäranden.Most repositories have the master branch protected so that updates must be submitted as pull requests.

Redigeringsupplevelsen i webbläsaren är bäst för mindre eller inte ofta förekommande ändringar.The in-browser editing experience is best for minor or infrequent changes. Om du gör stora bidrag eller använder avancerade Git-funktioner (till exempel förgreningshantering eller avancerad kopplingskonfliktlösning) behöver du förgrena lagringsplatsen och arbeta lokalt.If you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Note

Om det är aktiverat kan du redigera en artikel på alla språk och baserat på ändringsstypen händer följande:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. Lingvistiska ändringar som godkänns hjälper oss förbättra vår maskinöversättning.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. Alla ändringar som avsevärt ändrar innehållet i artikeln hanteras internt för att skicka en ändring till samma artikel på engelska, så att den lokaliseras till alla språk om den godkänns.any edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. Dina föreslagna förbättringar har inte bara positiv effekt på artiklarna på sitt eget språk, utan för alla tillgängliga språk.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Granska öppna pull-begärandenReview open PRs

Du kan läsa nya ämnen innan de publiceras genom att kontrollera de pull-begäranden som är öppna för tillfället.You can read new topics before they are published by checking the currently open PRs. Granska följande process för GitHub-flöde.Reviews follow the GitHub flow process. Du kan se föreslagna uppdateringar eller nya artiklar i de offentliga lagringsplatserna.You can see proposed updates or new articles in public repositories. Granska dem och lägg till dina kommentarer.Review them and add your comments. Titta på någon av våra dokumentdatabaser och kontrollera de öppna pull-begärandena för områden som intresserar dig.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Community-feedback för föreslagna uppdateringar hjälper hela communityn.Community feedback on proposed updates helps the entire community.

Skapa kvalitetsärendenCreate quality issues

Våra dokument är under ständigt pågående arbete.Our docs are a continuous work in progress. Bra ärenden hjälper oss att fokusera våra ansträngningar med högsta prioritet för communityn.Good issues help us focus our efforts on the highest priorities for the community. Ju fler detaljer du kan lämna, desto bättre.The more detail you can provide, the more helpful the issue. Berätta för oss vilken information du sökte efter.Tell us what information you sought. Berätta vilka söktermer du använde.Tell us the search terms you used. Om du inte kan komma igång, berätta för oss hur du vill börja utforska okänd teknik.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Många av Microsofts dokumentsidor har avsnittet Feedback längst ner på sidan där du kan klicka för att lämna Produktfeedback eller Innehållsfeedback för att spåra problem som är specifika för den artikeln.Many of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

Ärenden påbörjar konversationen om vad som behövs.Issues start the conversation about what's needed. Innehållsteamet kommer att svara på dessa ärenden med idéer om vad vi kan lägga till och be om dina åsikter.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Vi kan skapa en skiss och vi kommer att be dig att granska pull-begärandet.When we create a draft, we'll ask you to review the PR.

Bli mer involveradGet more involved

Andra ämnen hjälper dig att komma igång produktivt och bidra till Microsoft Docs. De förklarar hur du arbetar med GitHub-lagringsplatser, Markdown-verktyg och tillägg som används i Microsoft Docs-plattformen.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.