Microsoft Docs-közreműködői útmutató – áttekintés
Üdvözöljük a docs.microsoft.com (Microsoft Docs) közreműködői útmutatójában!
A Microsoft számos dokumentumkészlete nyílt forrású, és a GitHubon elérhető. Nem minden dokumentumkészlet teljesen nyílt forráskód, de sokan rendelkeznek nyilvános adattárral, ahol módosításokat javasolhat lekéréses kérelmeken (PR) keresztül. 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 milyen dokumentumokra van a leginkább szükség.
- Nyílt forráskódú adattárak áttekintése a megnyitáskor, hogy közzétehesse az első kiadásban a legreleánsabb tartalmat.
- A nyílt forráskódú adattárak frissítése a megnyitásban megkönnyíti a tartalom folyamatos fejlesztését.
A Microsoft Docs felhasználói felülete közvetlenül integrálja GitHub munkafolyamatokat, hogy még egyszerűbb legyen. Start menü a megtekintett dokumentum szerkesztésével. 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 docs.microsoft.com felületen közzétevő tárházak mindegyike elfogadta a Microsoft nyílt forráskódra vonatkozó 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, Vegye fel a kapcsolatot opencode@microsoft.com , vagy conduct@dotnetfoundation.org bármilyen kérdése vagy megjegyzése van.
A nyilvános tárházakban publikált dokumentációhoz és kódmintákhoz beküldött kisebb javításokra vagy pontosításokra a docs.microsoft.com használati feltételei vonatkoznak. Az új vagy jelentős módosítások megjegyzést hoznak létre a lekéréses kérelemben, és arra kérik, hogy küldjön be egy online hozzájárulási licencszerződést (CLA), ha Ön nem Microsoft-alkalmazott. 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 javí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 hozhat létre 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.
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ű honosított) gombra kattintva megnyitja a forrásfájlt GitHub.
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 a kód beágyazott dokumentációjából), és szerkeszteni kell őket abban a projektben, amelyhez tartoznak.
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.
Szerkessze a fájlt a webes szerkesztőben. A módosítások formázásának ellenőrzéséhez válassza az Előnézet lapot.
Ha végzett a szerkesztéssel, görgessen a lap aljára. A Módosítások felajánlása területen adja meg a módosítások címét és leírását. 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:
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 az adattárukba. Ez egy úgynevezett "lekéréses kérelem" (PR) használatával történik. Ha a Módosítások felajánlása lehetőséget választja, a következőhöz hasonló új lap jelenik meg:
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 még nem GitHub, további információért tekintse meg a lekéréses kérelmekről szóló témakört.
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. A módosításokat kérő visszajelzéseket kaphat.
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őknek valók, 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, GitHub létrehoz egy új ágat a céladattárban. Az ág neve az alapértelmezett űrlapjavítássaln rendelkezik, a javításág numerikus azonosítójának használatával.
A PRS-eket 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 tárház 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 GitHub keresztüli szerkesztést vagy visszajelzést. Ha visszajelzést szeretne küldeni a honosított tartalomról, használja a aka.ms/DocSiteLocFeedback címen elérhető e-mail-sablont.
Nyitott lekéréses kérelmek áttekintése
A nyilvános lekéréses kérelem várólistájának 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. Nézze meg bármelyik Docs-adattárunkat, és ellenőrizze a nyitott lekéréses kérelmeket, hogy mely területek érdeklik Önt. 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 vagya tartalomra vonatkozó visszajelzéseket hagyva nyomon követheti az adott cikkre jellemző 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 kezdjen hozzá a Microsoft Docs való hatékony közreműködéshez. Ismertetik a Microsoft Docs platformon használt GitHub adattárakkal, Markdown-eszközökkel és bővítményekkel való munkát.