Prehľad príručky prispievateľa do služby Microsoft DocsMicrosoft Docs contributor guide overview

Víta vás príručka prispievateľa do lokality docs.microsoft.com (Docs)!Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Viaceré skupiny dokumentácií spoločnosti Microsoft sú typu open-source a sú hosťované v službe GitHub.Several of the Microsoft documentation sets are open source and hosted on GitHub. Niektoré skupiny dokumentov nie sú úplne open-source, ale mnohé majú verejné odkladacie priestory, kde môžete prostredníctvom žiadostí o prijatie zmien vykonávať navrhované zmeny.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Tento open-source prístup zjednodušuje a vylepšuje komunikáciu medzi produktovými inžiniermi, tímami zodpovednými za obsah a zákazníkmi a tiež prináša ďalšie výhody:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Odkladacie priestory open-source podporujú otvorené plánovanie, aby sa pomocou pripomienok zistilo, ktoré dokumenty sú potrebné najviac.Open source repos plan in the open to get feedback on what docs are most needed.
  • Odkladacie priestory open-source vytvárajú priestor pre otvorené recenzie, aby prvé uvedenie obsahovalo ten najužitočnejší obsah.Open source repos review in the open to publish the most helpful content on our first release.
  • Odkladacie priestory open-source sa otvorene aktualizujú, aby bol proces vylepšovania obsahu čo najjednoduchší.Open source repos update in the open to make it easier to continuously improve the content.

Používateľské prostredie na lokalite docs.microsoft.com priamo integruje pracovné postupy služby GitHub, aby bolo ešte jednoduchšie.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Začnite tým, že upravíte dokument, ktorý si prezeráte.Start by editing the document you are viewing. Prípadne pomôžte s recenziou nových tém alebo vytváraním problémov s kvalitou.Or, help by reviewing new topics, or create quality issues.

Dôležité

Všetky odkladacie priestory, ktoré sa publikujú na lokalite docs.microsoft.com, prijali pravidlá správania pre Microsoft Open Source alebo pravidlá správania organizácie .NET Foundation.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Ďalšie informácie nájdete v téme Najčastejšie otázky pre pravidlá správania.For more information, see the Code of Conduct FAQ. Ak máte akékoľvek otázky alebo komentáre, obráťte sa na adresu opencode@microsoft.com alebo conduct@dotnetfoundation.org.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Drobné opravy alebo objasnenia k dokumentácii a príklady kódov vo verejných odkladacích priestoroch sú uvedené v podmienkach používania lokality 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. Nové alebo významné zmeny budú mať za následok vygenerovanie komentára v žiadosti o prijatie zmien. Ak nie ste zamestnancom spoločnosti Microsoft, zobrazí sa žiadosť o odoslanie online licenčnej zmluvy na poskytovanie príspevkov (CLA).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. Pred prijatím či recenziou žiadosti o prijatie zmien budete musieť vyplniť online formulár.We need you to complete the online form before we can review or accept your pull request.

Rýchle úpravy existujúcich dokumentovQuick edits to existing documents

Rýchle úpravy zjednodušia proces nahlasovania a odstraňovania drobných chýb či vynechaných informácií v dokumentoch.Quick edits streamline the process to report and fix small errors and omissions in documents. Akokoľvek sa človek snaží, do publikovaných dokumentov sa vždy prešmyknú drobné gramatické a pravopisné chyby.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Chyby je možné nahlásiť vytvorením problému. Problém sa však vyrieši rýchlejšie a jednoduchšie pomocou žiadosti o prijatie zmien (ak je táto možnosť k dispozícii).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. Niektoré stránky v službe Docs umožňujú upravovať obsah priamo v prehliadači.Some docs pages allow you to edit content directly in the browser. V takom prípade uvidíte tlačidlo Upraviť, ako je zobrazené na obrázku nižšie.If so, you'll see an Edit button like the one shown below. Kliknutím na tlačidlo Upraviť (alebo na lokalizovaný ekvivalent) prejdete na zdrojový súbor v službe GitHub.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Ak tlačidlo Upraviť chýba, znamená to, že stránka dokumentácie sa nedá zmeniť.If the Edit button is missing, that means the documentation page is not available to be changed.

    Umiestnenie položky Upraviť prepojenie

  2. Ak chcete článok upraviť, kliknite na ikonu ceruzky.Next, click the pencil icon, to edit the article as shown. Ak je ikona ceruzky sivá, prihláste sa do svojho konta GitHub alebo si vytvorte nové konto.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Umiestnenie ikony ceruzky

  3. Vykonajte zmeny vo webovom editore.Make your changes in the web editor. Výsledné formátovanie po zmene skontrolujete kliknutím na tlačidlo Zobraziť ukážku zmien.Click the Preview changes tab to check the formatting of your change.

  4. Akonáhle ste spokojní so zmenami, presuňte sa na spodok stránky.Once you have made your changes, scroll to the bottom of the page. Zadajte názov a popis zmien a kliknite na položku Navrhnúť zmenu súboru, ako je zobrazené na nasledujúcom obrázku:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Navrhnúť zmenu súboru

  5. Teraz, keď ste už navrhli zmenu, musíte požiadať vlastníka odkladacieho priestoru, aby prijal vaše zmeny do svojho odkladacieho priestoru.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Tento proces sa vykonáva pomocou žiadosti o prijatie zmien.This is done using something called a "pull request". Keď kliknete na tlačidlo Navrhnúť zmenu súboru, ktoré je na obrázku vyššie, mali by ste prejsť na novú stránku, ktorá vyzerá nasledovne: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:

    vytvorenie žiadosti o prijatie zmien

    Kliknite na tlačidlo Vytvoriť žiadosť o prijatie zmien, zadajte názov (voliteľne aj popis) žiadosti o prijatie zmien a potom znova kliknite na tlačidlo Vytvoriť žiadosť o prijatie zmien.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Ak ste novým používateľom služby GitHub, ďalšie informácie nájdete v téme Informácie o žiadostiach o prijatie zmien.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. To je všetko!That's it! Členovia obsahového tímu zrevidujú a zlúčia vašu žiadosť o prijatie zmien.Content team members will review and merge your PR. Ak ste vykonali zásadnejšie zmeny, môžete dostať pripomienky so žiadosťami o zmeny.You may get some feedback requesting changes if you made larger changes.

Používateľské rozhranie služby GitHub na vykonávanie zmien reaguje na vaše povolenia na odkladacom priestore.The GitHub editing UI responds to your permissions on the repository. Predchádzajúce obrázky platia pre prispievateľov, ktorí nemajú povolenia na zápis do cieľového odkladacieho priestoru.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub na vašom konte automaticky vytvára fork cieľového odkladacieho priestoru.GitHub automatically creates a fork of the target repository in your account. Ak máte prístup na zápis do cieľového odkladacieho priestoru, GitHub v ňom vytvorí novú vetvu.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Názov vetvy má formu <GitHubId>-patch-n, ktorá obsahuje vaše GitHub ID a číselný identifikátor vetvy opráv.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Pri všetkých zmenách využívame žiadosti o prijatie zmien, a to aj v prípade prispievateľov s prístupom na zapisovanie.We use pull requests for all changes, even for contributors that have write-access. Vo väčšine odkladacích priestorov je vetva master chránená, preto je aktualizácie potrebné odosielať v podobe žiadostí o prijatie zmien.Most repositories have the master branch protected so that updates must be submitted as pull requests.

Vykonávanie zmien v prehliadači je vhodné najmä na malé či občasné zmeny.The in-browser editing experience is best for minor or infrequent changes. Ak potrebujete vykonať veľké zmeny alebo využiť pokročilé funkcie služby Git (napríklad riadenie pobočky alebo rozšírené korešpondencie konfliktov), vytvorte fork odkladacieho priestoru a pracujte lokálne.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.

Poznámka

Ak je to povolené, môžete upraviť článok v akomkoľvek jazyku. V závislosti od druhu úpravy sa stane nasledovné:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. každá lingvistická zmena, ktorá je schválená, pomôže vylepšiť náš nástroj strojového prekladu;any linguistic change that is approved, will also help improve our Machine Translation engine
  2. každá úprava, ktorá významne pozmení obsah článku, sa bude spracovávať interne a zaznamená sa v tom istom článku v angličtine, čím sa lokalizuje vo všetkých jazykoch, ak to bude schválené.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. Vami navrhované vylepšenia nebudú pozitívne pôsobiť len na články vo vašom jazyku, ale aj vo všetkých dostupných jazykoch.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Recenzia otvorených žiadostí o prijatie zmienReview open PRs

Kontrolou momentálne otvorených žiadostí môžete získať prístup k novým témam ešte predtým, než sú publikované.You can read new topics before they are published by checking the currently open PRs. Recenzie sa riadia procesom postupu GitHub.Reviews follow the GitHub flow process. Na verejných odkladacích priestoroch môžete nájsť navrhované aktualizácie či nové články.You can see proposed updates or new articles in public repositories. Vytvorte na nich recenziu a pridajte k nim komentáre.Review them and add your comments. Pozrite sa na niektorý z našich odkladacích priestorov dokumentov a skontrolujte otvorené žiadosti o prijatie zmien (PR) v oblastiach, ktoré vás zaujímajú.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Pripomienky komunity k navrhovaným zmenám pomáhajú všetkým jej členom.Community feedback on proposed updates helps the entire community.

Vytváranie problémov s kvalitouCreate quality issues

Na našich dokumentoch neustále pracujeme.Our docs are a continuous work in progress. Vďaka dobrým problémom sa dokážeme sústrediť na tie najvyššie priority pre našu komunitu.Good issues help us focus our efforts on the highest priorities for the community. Čím viac detailov nám poskytnete, tým viac nám pomôže váš problém.The more detail you can provide, the more helpful the issue. Povedzte nám, aké informácie ste hľadali.Tell us what information you sought. Poskytnite nám hľadané výrazy, ktoré ste zadali.Tell us the search terms you used. Ak sa vám nedarí začať, povedzte nám, ako plánujete skúmať nové technológie.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Súčasťou mnohých dokumentačných stránok spoločnosti Microsoft je sekcia Pripomienky v dolnej časti stránky, kam môžete kliknúť a odoslať pripomienky k produktu alebo pripomienky k obsahu a sledovať tak problémy špecifické pre daný článok.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.

Vďaka problémom sa môžeme rozprávať o tom, čo je skutočne potrebné.Issues start the conversation about what's needed. Obsahový tím na tieto problémy zareaguje nápadmi na zlepšenie a bude ich zaujímať váš názor.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Akonáhle vytvoríme koncept, požiadame vás o recenziu žiadosti o prijatie zmien.When we create a draft, we'll ask you to review the PR.

Zapojte sa viacGet more involved

Na lokalitu Microsoft Docs vám pomôžu začať produktívne prispievať aj ďalšie témy. Vysvetľujú, ako sa pracuje s odkladacími priestormi služby GitHub, nástrojmi Markdown a príponami súboru, ktoré sa používajú naprieč celou platformou Microsoft Docs.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.