Microsoft Docs -sisällöntuottajan oppaan yleiskatsausMicrosoft Docs contributor guide overview

Tervetuloa docs.microsoft.com (Docs) -sisällöntuottajan oppaaseen!Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Suurin osa Microsoftin tuottamasta dokumentaatiosisällöstä on avointa ja saatavilla GitHub-palvelussa.Several of the Microsoft documentation sets are open source and hosted on GitHub. Kaikki dokumentaatiosisältö ei ole täysin avoimen lähdekoodin periaatteen mukaista, mutta joihinkin ohjeisiin liittyy julkisia säilöjä, joissa ehdotettuja muutoksia voi tehdä pull-pyyntöjen avulla.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Tämä avoimen lähdekoodin menettelytapa virtaviivaistaa ja parantaa tuotesuunnittelijoiden, sisältötyöryhmien ja asiakkaiden välistä viestintää, minkä lisäksi siihen liittyy muitakin etuja:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Avoimen lähdekoodin säilöt suunnitellaan avoimesti, jotta saadaan paremmin palautetta tarvittavista asiakirjoista.Open source repos plan in the open to get feedback on what docs are most needed.
  • Avoimen lähdekoodin säilöt tarkistetaan avoimesti, jotta tärkein ohjesisältö voidaan julkaista heti ensimmäisestä versiosta.Open source repos review in the open to publish the most helpful content on our first release.
  • Avoimen lähdekoodin säilöt päivitetään avoimesti, jotta sisällön jatkuva parantaminen on helpompaa.Open source repos update in the open to make it easier to continuously improve the content.

Sivuston docs.microsoft.com käyttöliittymä on integroitu suoraan GitHub-työnkulkuihin, mikä helpottaa työskentelyä entisestään.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Aloita muokkaamalla tarkasteltavaa asiakirjaa.Start by editing the document you are viewing. Voit vaihtoehtoisesti auttaa tarkistamalla uusia aiheita tai ilmoittamalla laatuongelmista.Or, help by reviewing new topics, or create quality issues.

Tärkeä

Kaikki docs.microsoft.comiin julkaisevat säilöt noudattavat joko Microsoft Open Source -toimintasääntöjä tai .NET Foundation -toimintasääntöjä.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Lisätietoja on ohjeaiheessa Toimintasääntöjen usein kysytyt kysymykset.For more information, see the Code of Conduct FAQ. Voit myös ottaa yhteyttä osoitteeseen opencode@microsoft.com tai conduct@dotnetfoundation.org kaikkien kysymysten tai kommenttien osalta.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Pienet korjaukset ja selvennykset dokumentaatioon ja julkisten säilöjen koodiesimerkit ovat docs.microsoft.comin käyttöehtojen alaisia.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Uudet tai merkittävät muutokset luovat pull-pyyntöön kommentin, jossa sinua pyydetään lähettämään osallistujien lisenssisopimus (CLA) verkossa, mikäli et ole Microsoftin työntekijä.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. Verkkolomake on täytettävä ennen kuin pull-pyyntö voidaan tarkastaa ja hyväksyä.We need you to complete the online form before we can review or accept your pull request.

Nopeat muutokset olemassa oleviin asiakirjoihinQuick edits to existing documents

Nopeat muutokset tehostavat ja nopeuttavat raportointiprosessia ja pienten korjausten tekemistä asiakirjoissa.Quick edits streamline the process to report and fix small errors and omissions in documents. Kirjoittajat ovat vain ihmisiä, joten julkaistut asiakirjat voivat sisältää pieniä kielioppi- tai oikeinkirjoitusvirheitä.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Voit raportoida virheistä ilmoittamalla ongelmasta, mutta nopeampi tapa on luoda pull-pyyntö (PR) ongelman korjaamiseksi, jos tällainen vaihtoehto on saatavilla.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. Joidenkin asiakirjojen sivuilla voit tehdä muutoksia suoraan selaimen kautta.Some docs pages allow you to edit content directly in the browser. Jos näin on, näet alla olevan kaltaisen Muokkaa-painikkeen.If so, you'll see an Edit button like the one shown below. Napsauttamalla Muokkaa-painiketta (tai vastaavaa lokalisoitua painiketta) siirryt lähdetiedostoon GitHubissa.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Jos Muokkaa-painiketta ei näy, ohjesivuun ei voi tehdä muutoksia.If the Edit button is missing, that means the documentation page is not available to be changed.

    Muokkaa-linkin sijainti

  2. Voit muokata artikkelia tässä kuvatulla tavalla napsauttamalla kynäkuvaketta.Next, click the pencil icon, to edit the article as shown. Jos kynäkuvake näkyy harmaana, sinun on joko kirjauduttava GitHub-tiliisi tai luotava uusi tili.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Kynäkuvakkeen sijainti

  3. Tee muutokset suoraan verkkoeditorissa.Make your changes in the web editor. Voit tarkistaa muutoksen muotoilun Esikatsele muutoksia -välilehdellä.Click the Preview changes tab to check the formatting of your change.

  4. Kun olet tehnyt tarvittavat muutokset, siirry sivun loppuun.Once you have made your changes, scroll to the bottom of the page. Anna muutoksille otsikko ja kuvaus ja valitse sitten Ehdota tiedoston muutosta, kuten alla olevassa kuvassa:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Ehdota tiedoston muutosta

  5. Kun olet nyt ehdottanut muutosta, sinun on pyydettävä säilön omistajia noutamaan muutoksesi omaan säilöönsä.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Tämä tapahtuu käyttämällä niin sanottua pull-pyyntöä.This is done using something called a "pull request". Kun valitsit Ehdota tiedoston muutosta yllä olevassa kuvassa, siirryit uudelle sivulle, joka näyttää seuraavalta: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:

    luo pull-pyyntö

    Valitse Luo pull-pyyntö, anna pull-pyynnölle nimi ja halutessasi kuvaus ja valitse Luo pull-pyyntö uudelleen.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Jos et ole aiemmin käyttänyt GitHubia, katso lisätietoja kohdasta Tietoja pull-pyynnöistä.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Se oli siinä!That's it! Sisältötyöryhmän jäsenet tarkastavat ja yhdistävät pull-pyyntösi.Content team members will review and merge your PR. Jos olet tehnyt isompia muutoksia tekstiin, voit saada niistä palautetta.You may get some feedback requesting changes if you made larger changes.

GitHubin editointikäyttöliittymä vastaa käyttäjän säilön oikeuksia.The GitHub editing UI responds to your permissions on the repository. Edellä olevat kuvat ovat esimerkkejä sellaisten osallistujien näkymästä, joilla ei ole kohdesäilön kirjoitusoikeuksia.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub luo automaattisesti haarauman tilisi kohdesäilöstä.GitHub automatically creates a fork of the target repository in your account. Jos sinulla on kohdesäilön kirjoitusoikeudet, GitHub luo siihen uuden haaran.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Haaran nimi on muodossa <GitHubId>-patch-n, jossa on GitHub-tunnisteesi sekä haaran numeerinen tunnus.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Pull-pyyntöjä käytetään kaikissa muutoksissa riippumatta siitä, onko osallistujalla kirjoitusoikeuksia.We use pull requests for all changes, even for contributors that have write-access. Haara master on suojattu useimmissa säilöissä, jolloin päivitykset on lähetettävä pull-pyyntöinä.Most repositories have the master branch protected so that updates must be submitted as pull requests.

Ainoastaan pienempiä muutoksia kannattaa tehdä suoraan selaimessa.The in-browser editing experience is best for minor or infrequent changes. Jos lisäät paljon sisältöä tai käytät edistyneitä Git-ominaisuuksia (kuten haaranhallintaa tai edistynyttä ristiriitojen ratkaisumenetelmää), sinun on luotava säilöön haarauma ja työskenneltävä paikallisesti.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.

Huomautus

Jos ominaisuus on käytössä, voit muokata artikkelia millä tahansa kielellä. Muokkauksen tyypin mukaan tapahtuu seuraavaa:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. jokainen hyväksytty lingvistinen muutos auttaa myös parantamaan konekäännösohjelmaammeany linguistic change that is approved, will also help improve our Machine Translation engine
  2. mikä tahansa artikkelin sisältöä merkittävästi muuttava muokkaus käsitellään sisäisesti, jotta muutos voidaan lisätä myös samaan englanninkieliseen artikkeliin. Näin se hyväksytyksi tullessaan lokalisoidaan kaikille kielille.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. Ehdottamasi parannukset eivät siis vaikuta positiivisesti vain artikkeleihin, jotka on kirjoitettu omalla kielelläsi, vaan myös muunkielisiin artikkeleihin.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Avointen pull-pyyntöjen tarkastaminenReview open PRs

Voit tarkastella uusia aiheita ennen niiden julkaisua hakemalla avoimia pull-pyyntöjä.You can read new topics before they are published by checking the currently open PRs. Tarkastukset noudattavat GitHub-työnkulun prosessia.Reviews follow the GitHub flow process. Julkisissa säilöissä voit tarkastella ehdotettuja päivityksiä ja uusia artikkeleita.You can see proposed updates or new articles in public repositories. Tarkasta ne ja jätä tarvittaessa kommentteja.Review them and add your comments. Tarkastele mitä tahansa asiakirjasäilöämme ja tutustu sinua kiinnostaviin avoimiin pull-pyyntöihin.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Yhteisön palaute ehdotetuista päivityksistä auttaa koko yhteisöä.Community feedback on proposed updates helps the entire community.

Laatuongelmista ilmoittaminenCreate quality issues

Työstämme jatkuvasti dokumentaatiotamme.Our docs are a continuous work in progress. Ongelmista ilmoittaminen auttaa meitä keskittymään yhteisön kannalta tärkeimpiin ongelmiin.Good issues help us focus our efforts on the highest priorities for the community. Mitä enemmän tietoja voit antaa, sitä helpommin voimme korjata ongelman.The more detail you can provide, the more helpful the issue. Kerro, mitä tietoja hait.Tell us what information you sought. Kerro meille käyttämäsi hakuehdot.Tell us the search terms you used. Jos et pääse alkuun, kerro meille miten haluaisit aloittaa vieraaseen tekniikkaan tutustumisen.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Microsoftin sisältösivujen alaosassa on usein Palaute-osio, jonka kautta voit lähettää palautetta tuotteista tai palautetta sisällöstä, jotka liittyvät kyseiseen artikkeliin.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.

Ongelmista ilmoittaminen synnyttää keskustelua tarvittavista toimista.Issues start the conversation about what's needed. Sisältötyöryhmä voi reagoida ongelmiin ideoilla siitä, mitä voimme lisätä, ja kysyä yhteisön mielipiteitä.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Luodessamme luonnosta voimme pyytää sinua tarkastamaan pull-pyynnön.When we create a draft, we'll ask you to review the PR.

Yhteisön osallistaminenGet more involved

Muut aiheet auttavat Microsoft Docs -sisällön tuottamiseen osallistuvia. Niissä käydään läpi GitHub-säilöissä työskentely, Markdown-työkalut ja Microsoft Docs -ympäristössä käytetyt laajennukset.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.