Helyi Git-adattár beállítása dokumentációhoz

A cikk azokat a lépéseket ismerteti, melyekkel beállítható egy Git-tárház a helyi számítógépen a Microsoft dokumentációjának készítésében való közreműködés céljából. A közreműködők egy helyileg klónozott tárház használatával adhatnak hozzá új cikkeket, végezhetnek jelentős módosításokat a meglévő cikkeken, vagy módosíthatják a grafikus elemeket.

Az egyszeri beállítási tevékenységek futtatásával megkezdheti a közreműködést:

• Határozza meg a megfelelő adattárat.
• Tárház elágazása a GitHub-fiókba.
• Válasszon egy helyi mappát a klónozott fájlokhoz.
• Klónozza az adattárat a helyi gépre.
• Konfigurálja a felsőbb rétegbeli távoli értéket.

Fontos

Ha csak kisebb módosításokat végez, nem kell elvégeznie a cikkben szereplő lépéseket. A böngésző szerkesztésével megtudhatja, hogyan végezhet gyorsszerkesztéseket eszközök telepítése nélkül.

Áttekintés

Ha hozzá szeretne járulni a Microsoft Learn dokumentációjához, helyileg készíthet és szerkeszthet Markdown-fájlokat a megfelelő dokumentációs adattár klónozásával. A Microsoft megköveteli, hogy a megfelelő adattárat saját GitHub-fiókjába forgja, hogy olvasási/írási engedélyekkel rendelkezzen a javasolt módosítások tárolásához. Ezután lekéréses kérelmek (PRs) használatával egyesítheti a módosításokat az írásvédett központi megosztott adattárban.

A Microsoft-adattárat felsőbb rétegbeli adattárnak nevezzük. A GitHub felhasználói felületén található elágazási művelettel a felhasználó elágaztathatja a Microsoft-adattárat a saját GitHub-fiókjába. Ezt az elágazást forrásnak nevezzük. A git-klón használatával a felhasználó klónozza az Origint a helyi gépére. Végül a felhasználó a git távoli add upstream használatával csatlakoztatja a helyi klónt a Microsoft felsőbb rétegbeli adattárához.

A tárház meghatározása

A Microsoft Learn dokumentációja a GitHub több adattárában található.

1. Ha nem biztos abban, hogy melyik adattárban található egy cikk, keresse fel a cikket a webböngészővel. A cikk jobb felső sarkában válassza a Szerkesztés hivatkozást (ceruza ikon).

   

2. Ez a művelet a GitHub forrásfájljára viszi. Az adattár neve a lap bal felső sarkában jelenik meg.

   

   Íme néhány népszerű adattár, amelyek nyilvános hozzájárulásokhoz érhetők el:

   • Microsoft Learn közösségi tartalom https://github.com/MicrosoftDocs/community-content/
   • Azure-dokumentáció https://github.com/MicrosoftDocs/azure-docs
   • SQL Server-dokumentáció https://github.com/MicrosoftDocs/sql-docs
   • Visual Studio-dokumentáció https://github.com/MicrosoftDocs/visualstudio-docs
   • .NET-dokumentáció https://github.com/dotnet/docs
   • Az Azure .NET SDK dokumentációja https://github.com/azure/azure-docs-sdk-dotnet
   • A ConfigMgr dokumentációja https://github.com/MicrosoftDocs/SCCMdocs

A tárház elágaztatása

Miután azonosította a megfelelő adattárat, a következő lépés az adattár elágazása a saját GitHub-fiókjába.

Az adattár elágazása azt jelenti, hogy másolatot hoz létre róla a GitHub-fiókjában. Személyes elágazásra azért van szükség, mert a Microsoft dokumentációs adattárai írásvédett hozzáférést biztosítanak, az elágazás azonban írási hozzáférést biztosít a módosítások elvégzéséhez. Az elágazás lehetővé teszi a PRS-ek megnyitását az elágazásból a Microsoft adattárba.

1. A fő adattár GitHub-oldalán válassza a jobb felső sarokban található Elágazzás gombot.

   

2. Az Új elágazás létrehozása képernyőn győződjön meg arról, hogy a Tulajdonos beállítás az Ön felhasználónevére van állítva, és hogy csak a főág másolása van bejelölve. Igény szerint módosítsa az Adattár nevét és a Leírás mezőt.

   

A tárház klónozása

A klónozás azt jelenti, hogy másolatot készít egy adattárról a helyi gépen.

Figyelmeztetés

1. NE klónozza a helyi adattárat a OneDrive által szinkronizált mappákba. Ha kiválasztja azt a mappát, amelybe klónozni fogja az adattárat, kerülje a OneDrive-tal szinkronizált mappákat (például a Dokumentumok mappát). A OneDrive nem kívánt egyesítési ütközéseket okozhat, amikor a módosításokat visszafésüli a főágba. Ehelyett érdemes létrehozni egy rövid fájlútmutatót a C:\ meghajtón (például C:\GitHub).

2. Git a Windowson: Engedélyezze a hosszú elérési utak nevét. A Windows Git alapértelmezés szerint letiltja a hosszú fájlútvonalak támogatását, ami megakadályozza a 255 karakternél hosszabb célútvonallal rendelkező fájlok klónozását. Engedélyezze a hosszú fájlútmutatókat a probléma elkerüléséhez a következő parancs rendszergazdaként való futtatásával:
   git config --global core.longpaths true

1. Hozzon létre egy GitHub mappát a helyi gépen. Például: C:\GitHub. (Ne klónozza OneDrive szinkronizálási app mappába.)

2. Egy böngészőben nyissa meg a GitHub.com , és jelentkezzen be.

3. A gitHubon a jobb felső sarokban, a profil legördülő menüjében válassza az Ön adattárait. Az adattárak lap az elágazott adattárak listájával jelenik meg.

4. Válassza ki a klónozni kívánt adattárat. Megjelenik az elágazás adattárlapja.

   Győződjön meg arról, hogy az elágazás adattároldalán van, nem pedig az éles adattár oldalán. Az URL-cím ellenőrzésével ellenőrizheti, hogy az elágazás az elágazással van-e megadva: a GitHub-felhasználónevét kell megjelenítenie, nem pedig a Microsoft-szervezetnek (például https://github.com/nancydavolio/azure-docsNEMhttps://github.com/MicrosoftDocs/azure-docs). Emellett a bal felső sarokban láthatja a nevét, és megjelenik egy megjegyzés, amely azt jelzi , hogy elágazás, majd a fő adattár neve.

   

5. Válassza a <> Lap bal felső részén található Kód fület.

6. A jobb oldalon, a Kód legördülő listában másolja az URL-címet a HTTPS beállítás alá.

   

Fontos

A klón URL-címét a GitHub felhasználói felületén másolta. A többi lépést a VS Code Terminálban kell végrehajtani.

Klónozás a Visual Studio Code-ból

1. Nyissa meg a Visual Studio Code-ot.

2. A felső navigációs menüben válassza a Nézet , majd a Terminál lehetőséget. A terminálnézet a Visual Studio Code képernyő alján jelenik meg.

3. A Terminál nézetben futtassa a parancsot a könyvtár (cd) módosításához a GitHub meghajtón lévő adattárakhoz létrehozott mappára az adattár klónozása szakasz 1. lépésében.

   Példa:

    cd C:\GitHub
   

   Ha hibaüzenet jelenik meg, előfordulhat, hogy egyszerre egy mappát kell módosítania.

4. Futtassa a következő parancsot az adattár klónozásához:

   git clone <paste the clone URL you copied via the GitHub UI>
   

   Példa:

   git clone https://github.com/nancydavolio/azure-docs.git
   

5. Amikor a rendszer kéri a böngészőn keresztüli hitelesítést, válassza a "Bejelentkezés a böngészővel" gombot, és fejezze be a folyamatot. Mindenképpen töltse le a Git legújabb verzióját, amely támogatja a böngészőfunkciókon keresztüli hitelesítést. Ha személyes GitHub-hozzáférési jogkivonatot használ, az alábbi utasítások egyikét hozhatja létre: Személyes hozzáférési jogkivonat létrehozása.

   A klónozási parancs letölti az adattárfájlokat az elágazásból egy új mappába a 3. lépésben kiválasztott helyen. Az új mappa az aktuális mappán belül jön létre. A művelet akár néhány percig is eltarthat, a tárház méretétől függően. A mappa felfedezése után megtekintheti a struktúrát.

Távoli eszközök beállítása

Miután klónozta a tárházat, állítson be egy csak olvasható távoli kapcsolatot a fő tárházhoz upstream néven. A távoli objektumok olyan aliasok, amelyek távoli adattárakra hivatkoznak. Az Origin az elágazásra, a felsőbb réteg pedig az éles adattárra hivatkozik. A Git a parancs futtatásakor automatikusan létrehozta origin a clone távoli elemet. Az upstream URL segítségével biztosíthatja, hogy a mások által végrehajtott módosítások mindig szinkronizálva legyenek a saját helyi tárházában is.

Futtassa a következő parancsokat a Git Bashben vagy a VS Code Terminalban.

1. Módosítsa a könyvtárat (cd) a parancs által létrehozott adattármappára clone . Példa:

   cd repo-name
   

2. Futtassa a következő parancsot egy olyan távoli név upstream hozzáadásához, amely az éles adattárra mutat. Az adattár URL-címe például upstream nem https://github.com/nancydavolio/azure-docs.git.https://github.com/MicrosoftDocs/azure-docs.git

   git remote add upstream <the clone URL of the main repo>
   

   Példa:

   git remote add upstream https://github.com/MicrosoftDocs/azure-docs.git
   

3. Futtassa a következő parancsot, hogy meggyőződjön arról, hogy a távvezérlők helyesek:

   git remote -v
   

   Példa a kimenetre:

   origin  https://github.com/nancydavolio/azure-docs.git (fetch)
   origin  https://github.com/nancydavolio/azure-docs.git (push)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (fetch)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (push)
   

4. Ha hibát követett el, távolítsa el a távolit, és ismételje meg a lépést a hozzáadáshoz. Az eltávolításhoz upstreamfuttassa a következő parancsot:

   git remote remove upstream
   

Következő lépések

• Most, hogy beállította a helyi klónt, itt az ideje, hogy jelentős módosításokat hajtson végre.