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

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

Viaceré skupiny dokumentácií spoločnosti Microsoft sú typu open-source a sú hosťované v službe 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. 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:

  • Odkladacie priestory open-source podporujú otvorené plánovanie, aby sa pomocou pripomienok zistilo, ktoré dokumenty sú potrebné najviac.
  • Odkladacie priestory open-source vytvárajú priestor pre otvorené recenzie, aby prvé uvedenie obsahovalo ten najužitočnejší obsah.
  • Odkladacie priestory open-source sa otvorene aktualizujú, aby bol proces vylepšovania obsahu čo najjednoduchší.

Používateľské prostredie na lokalite docs.microsoft.com priamo integruje pracovné postupy služby GitHub, aby bolo ešte jednoduchšie. Začnite tým, že upravíte dokument, ktorý si prezeráte. Prípadne pomôžte s recenziou nových tém alebo vytváraním problémov s kvalitou.

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. Ďalšie informácie nájdete v téme Najčastejšie otázky pre pravidlá správania. Ak máte akékoľvek otázky alebo komentáre, obráťte sa na adresu opencode@microsoft.com alebo conduct@dotnetfoundation.org.

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. 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). Pred prijatím či recenziou žiadosti o prijatie zmien budete musieť vyplniť online formulár.

Rýchle úpravy existujúcich dokumentov

Rýchle úpravy zjednodušia proces nahlasovania a odstraňovania drobných chýb či vynechaných informácií v dokumentoch. Akokoľvek sa človek snaží, do publikovaných dokumentov sa vždy prešmyknú drobné gramatické a pravopisné chyby. 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).

  1. Niektoré stránky v službe Docs umožňujú upravovať obsah priamo v prehliadači. V takom prípade uvidíte tlačidlo Upraviť, ako je zobrazené na obrázku nižšie. Kliknutím na tlačidlo Upraviť (alebo na lokalizovaný ekvivalent) prejdete na zdrojový súbor v službe GitHub. Ak tlačidlo Upraviť chýba, znamená to, že stránka dokumentácie sa nedá zmeniť.

    Umiestnenie položky Upraviť prepojenie

    Ak sa tlačidlo Upraviť nezobrazuje, znamená to, že obsah nie je otvorený pre verejné príspevky.

  2. Ak chcete upraviť článok, vyberte ikonu ceruzky. Ak je ikona ceruzky sivá, prihláste sa do svojho konta GitHub alebo si vytvorte nové konto.

    Umiestnenie ikony ceruzky

  3. Vykonajte zmeny vo webovom editore. Výsledné formátovanie po zmene skontrolujete kliknutím na tlačidlo Zobraziť ukážku zmien.

  4. Akonáhle ste spokojní so zmenami, presuňte sa na spodok stránky. Zadajte názov a popis zmien a kliknite na položku Navrhnúť zmenu súboru, ako je zobrazené na nasledujúcom obrázku:

    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. Tento proces sa vykonáva pomocou žiadosti o prijatie zmien. Keď vyberiete možnosť Navrhnúť zmenu súboru, zobrazí sa nová stránka podobná nasledujúcej:

    vytvorenie žiadosti o prijatie zmien

    Vyberte položku Vytvoriť žiadosť o vyžiadanie, zadajte názov a prípadne popis žiadosti o vyžiadanie a potom vyberte položku Vytvoriť žiadosť o vyžiadanie. Ak ste v GitHube ešte noví, ďalšie informácie nájdete v téme Žiadosti o ťahanie.

  6. To je všetko! Členovia tímu obsahu skontrolovať a zlúčiť vaše PR, keď bude schválené. Môžete získať spätnú väzbu požadujúce zmeny.

Používateľské rozhranie služby GitHub na vykonávanie zmien reaguje na vaše povolenia na odkladacom priestore. Predchádzajúce obrázky platia pre prispievateľov, ktorí nemajú povolenia na zápis do cieľového odkladacieho priestoru. GitHub na vašom konte automaticky vytvára fork cieľového odkladacieho priestoru. Ak máte prístup na zápis do cieľového odkladacieho priestoru, GitHub v ňom vytvorí novú vetvu. Názov vetvy má formu <GitHubId>-patch-n, ktorá obsahuje vaše GitHub ID a číselný identifikátor vetvy opráv.

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. Väčšina úložísk má predvolenú vetvu chránenú tak, že aktualizácie musia byť odoslané ako žiadosti o ťahanie.

Vykonávanie zmien v prehliadači je vhodné najmä na malé či občasné zmeny. 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.

Poznámka

Väčšina lokalizovanej dokumentácie neponúka možnosť upravovať ani poskytovať spätnú väzbu prostredníctvom služby GitHub. Ak chcete poskytnúť spätnú väzbu na lokalizovaný obsah, použite šablónu e-mailu dostupnú na aka.ms/DocSiteLocFeedback. Existuje jedna výnimka pre dokumentáciu Azure. K dispozícii sú verejné lokalizované úložiská GitHub pre azúrové dokumenty, ktoré sú otvorené pre príspevok komunity pre 6 jazykov: zjednodušenú čínštinu, francúzštinu, nemčinu, japončinu, kórejčinu a španielčinu. Pre všetky ostatné jazyky a množiny obsahu použite šablónu e-mailu,ktorá prijíma váš vstup v akomkoľvek jazyku, na nahlásenie problémov s prekladom alebo na poskytnutie technickej spätnej väzby.

Recenzia otvorených žiadostí o prijatie zmien

Kontrolou momentálne otvorených žiadostí môžete získať prístup k novým témam ešte predtým, než sú publikované. Recenzie sa riadia procesom postupu GitHub. Na verejných odkladacích priestoroch môžete nájsť navrhované aktualizácie či nové články. Vytvorte na nich recenziu a pridajte k nim komentáre. 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ú. Pripomienky komunity k navrhovaným zmenám pomáhajú všetkým jej členom.

Vytváranie problémov s kvalitou

Na našich dokumentoch neustále pracujeme. Vďaka dobrým problémom sa dokážeme sústrediť na tie najvyššie priority pre našu komunitu. Čím viac detailov nám poskytnete, tým viac nám pomôže váš problém. Povedzte nám, aké informácie ste hľadali. Poskytnite nám hľadané výrazy, ktoré ste zadali. Ak sa vám nedarí začať, povedzte nám, ako plánujete skúmať nové technológie.

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.

Vďaka problémom sa môžeme rozprávať o tom, čo je skutočne potrebné. Obsahový tím na tieto problémy zareaguje nápadmi na zlepšenie a bude ich zaujímať váš názor. Akonáhle vytvoríme koncept, požiadame vás o recenziu žiadosti o prijatie zmien.

Zapojte sa viac

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.