Microsoft Docs-közreműködői útmutató – áttekintés

Üdvözöljük a Microsoft Docs közreműködői útmutatójában!

Ha megosztja a szakértelmét másokkal a Microsoft Learnben, azzal mindenki többet érhet el. Az útmutatóban található információk alapján új cikket tehet közzé a Microsoft Learnben, vagy frissíthet egy meglévő közzétett cikket.

Ha megosztja a tudását másokkal a Learnről, azzal mindenki többet érhet el. Az útmutatóban található információk alapján közzétehet egy új cikket, learn.microsoft.com vagy frissíthet egy már közzétett cikket.

A Microsoft számos dokumentumkészlete nyílt forrású, és a GitHubon elérhető. Nem minden dokumentumkészlet nyílt forráskód teljesen, de sok olyan nyilvános adattárral rendelkezik, ahol módosításokat javasolhat lekéréses kérelmekkel (PR). Ez a nyílt forráskódú megközelítés leegyszerűsíti és javítja a termékmérnökök, a tartalomért felelős csapatok és az ügyfelek közötti kommunikációt, és más előnyökkel is rendelkezik:

  • A nyílt forráskódú adattárak nyílt forráskódú csomagjában visszajelzést kaphat arról, hogy mely dokumentumokra van a leginkább szükség.
  • Nyílt forráskódú adattárak felülvizsgálata a nyílt, hogy tegye közzé a legrelehetõbb tartalmat az első kiadás.
  • A nyílt forráskódú adattárak nyílt környezetben frissülnek , hogy megkönnyítse a tartalom folyamatos fejlesztését.

A Microsoft Learn felhasználói felülete közvetlenül integrálja a GitHub-munkafolyamatokat , hogy még egyszerűbb legyen. Először szerkessze a megtekintett dokumentumot. Vagy segítséget kaphat új témakörök áttekintésével vagy minőségi problémák létrehozásával.

Fontos

A Microsoft Learnben közzétevő összes adattár elfogadta a Microsoft nyílt forráskódú viselkedési szabályzatát vagy a .NET Foundation viselkedési szabályzatát. További információkért keresse fel a Viselkedési szabályzattal kapcsolatos gyakori kérdések oldalát, conduct@dotnetfoundation.org Lépjen kapcsolatba opencode@microsoft.com vagy bármilyen kérdésével vagy megjegyzésével.

A nyilvános adattárakban található dokumentációk és kódpéldák kisebb javításait és pontosításait a learn.microsoft.com Használati feltételek ismertetik. Az új vagy jelentős módosítások megjegyzést hoznak létre a lekéréses kérelemben, amely arra kéri, hogy ha Ön nem Microsoft-alkalmazott, küldjön be egy online közreműködői licencszerződést (CLA). A lekéréses kérelem elbírálása vagy elfogadása előtt ki kell töltenie az online űrlapot.

A dokumentáció gyors szerkesztése

A gyors módosítások leegyszerűsítik a dokumentációban szereplő kisebb hibák és kihagyások jelentésének és kijavításának folyamatát. Minden erőfeszítés ellenére kisebb nyelvtani vagy helyesírási hibák előfordulhatnak a közzétett dokumentumokban. Bár problémákat is létrehozhat a hibák jelentéséhez, gyorsabban és egyszerűbben hozhat létre lekéréses kérelmet a probléma megoldásához, ha elérhető a lehetőség.

  1. Egyes dokumentumok oldalán lehetőség van közvetlenül a böngészőben is a tartalom szerkesztésére. Ilyen esetben az alábbi képen láthatóhoz hasonló Szerkesztés gomb is megjelenik az oldalon. A Szerkesztés (vagy ezzel egyenértékűen honosított) gombra kattintva megnyitja a Forrásfájlt a GitHubon.

    A cikk szerkesztésére szolgáló hivatkozás helye.

    Ha a Szerkesztés gomb nem jelenik meg, az azt jelenti, hogy a tartalom nem érhető el nyilvános hozzájárulások számára. Egyes oldalak létrejönnek (például kódba ágyazott dokumentációból), és szerkeszteni kell őket abban a projektben, amelyhez tartoznak.

  2. A cikk szerkesztéséhez válassza a ceruza ikont. Ha a ceruza ikon kiszürkítve látható, akkor jelentkezzen be a GitHub-fiókjába, vagy hozzon létre egy új fiókot.

    Az elágazás helye és a ceruza szerkesztése ikon.

  3. Szerkessze a fájlt a webszerkesztőben. A módosítások formázásának ellenőrzéséhez válassza az Előnézet lapot.

  4. Ha végzett a szerkesztéssel, görgessen a lap aljára. A Javaslat a módosításokra területen adjon meg egy címet, és szükség esetén adjon leírást a módosításokhoz. A cím lesz a véglegesítési üzenet első sora. Válassza a Módosítások felajánlása lehetőséget a módosítások véglegesítéséhez:

    Fájlmódosítások javasolása és véglegesítése.

  5. Most, hogy javasolta és véglegesítette a módosításokat, meg kell kérnie az adattár tulajdonosait, hogy "húzzák le" a módosításokat a saját adattárukba. Ez egy úgynevezett "lekéréses kérelem" (PR) használatával történik. Ha a Javasolt módosítások lehetőséget választja, az alábbihoz hasonló új lap jelenik meg:

    Hasonlítsa össze a módosításokat, és hozzon létre lekéréses kérelmet.

    Válassza a Lekéréses kérelem létrehozása lehetőséget. Ezután adja meg a lekéréses kérelem címét és leírását, majd válassza a Lekéréses kérelem létrehozása lehetőséget. Ha most ismerkedik a GitHubbal, további információért tekintse meg a lekéréses kérelmekről szóló témakört.

  6. Ennyi az egész! A tartalomért felelős csapat tagjai áttekintik a lekéréses kérelmet, és a jóváhagyásukkor egyesítik azt. Előfordulhat, hogy visszajelzést kap, amely módosításokat kér.

A GitHub szerkesztői felülete az adattárhoz tartozó engedélyeknek megfelelő választ ad. Az előző képek olyan közreműködők számára készültek, akik nem rendelkeznek írási engedéllyel a céladattárhoz. A GitHub automatikusan létrehoz egy adattármásolatot a céladattárról az Ön fiókjában. Az újonnan létrehozott elágazás neve alapértelmezés szerint az űrlappal GitHubUsername/RepositoryName rendelkezik. Ha írási hozzáféréssel rendelkezik a céladattárhoz, például az elágazáshoz, a GitHub létrehoz egy új ágat a céladattárban. Az ág neve az alapértelmezett űrlapjavítássaln rendelkezik, amely numerikus azonosítót használ a javításághoz.

A lekéréses kérelmeket minden módosításhoz használjuk, még az írási hozzáféréssel rendelkező közreműködők esetében is. A legtöbb adattár védi az alapértelmezett ágat, így a frissítéseket lekéréses kérelemként kell elküldeni.

A böngészőn belüli szerkesztési környezet kisebb vagy ritka módosítások esetén a legjobb. Ha nagyobb terjedelmű szövegeket ír, vagy speciális Git-funkciókat (például ágkezelést vagy fejlett egyesítéskori ütközésfeloldást) használ, akkor adattármásolatot kell készítenie, és a helyi számítógépen kell dolgoznia.

Megjegyzés

A legtöbb honosított dokumentáció nem teszi lehetővé a GitHubon keresztüli szerkesztést és visszajelzést. Ha visszajelzést szeretne küldeni a honosított tartalomról, használja az aka.ms/DocSiteLocFeedback webhelyen elérhető e-mail-sablont.

Nyitott lekéréses kérelmek áttekintése

A megnyitott pr-üzenetsor ellenőrzésével elolvashatja az új témaköröket a közzétételük előtt. Az áttekintések a GitHub-folyamatot követik. Megtekintheti a javasolt frissítéseket és az új cikkeket a nyilvános adattárakban. Tekintse át őket, és fűzzön hozzájuk megjegyzéseket. Tekintse meg bármelyik Microsoft Learn-adattárunkat, és tekintse meg a nyitott lekéréses kérelmeket az Önt érdeklő területekért. A javasolt frissítéseket illető közösségi visszajelzések az egész közösséget segítik.

Minőségi problémák jelzése

Dokumentumainkat folyamatosan fejlesztjük. A jelzett problémák segítenek, hogy erőfeszítéseinket a közösség számára legfontosabb dolgokra összpontosítsuk. Minél több részletet meg tud adni, annál nagyobb segítségünkre lesz a probléma. Mondja el, milyen információt keresett. Írja le a használt keresési kifejezéseket. Ha nem tudta megtenni az első lépéseket, mondja el, hogyan szeretné elkezdeni egy új technológia felfedezését.

A Microsoft számos dokumentációs oldalán található egy Visszajelzés szakasz a lap alján, ahol a termékre vagy a tartalomra vonatkozó visszajelzést hagyva nyomon követheti az adott cikkhez kapcsolódó problémákat.

A problémák jelzésével elindul a párbeszéd arról, hogy mire van szükség. A tartalomcsapat ezekre a jelzett problémákra a dokumentáció bővítésére vonatkozó ötletekkel fog válaszolni, és megkérdezi a véleményét. Vázlat létrehozásakor megkérjük, hogy tekintse át a lekéréses kérelmet.

Vegyen részt még több mindenben

Az útmutató további témakörei segítenek abban, hogy hatékonyan járuljon hozzá a Microsoft Learn használatához. Ismertetik a Microsoft Learn-tartalmakban használt GitHub-adattárak, Markdown-eszközök és bővítmények használatát.