Nastavenie lokálneho odkladacieho priestoru v službe Git na dokumentáciu
Tento článok popisuje kroky na nastavenie odkladacieho priestoru Git na lokálnom počítači s úmyslom prispievať do dokumentácie spoločnosti Microsoft. Prispievatelia môžu používať lokálne klonovaný odkladací priestor a pridávať nové články, vykonávať dôležité úpravy v existujúcich článkoch alebo meniť grafiku.
Tieto jednorazové aktivity nastavenia sa spúšťajú, ak chcete začať prispievať:
- Určte vhodný odkladací priestor.
- Rozdeľte odkladací priestor na vaše konto v službe GitHub.
- Vyberte lokálny priečinok pre klonované súbory.
- Naklonujte odkladací priestor na lokálny počítač.
- Nakonfigurujte vzdialenú hodnotu upstreamu.
Dôležité
Ak robíte len drobné zmeny, nie je potrebné vykonať kroky v tomto článku. Ďalšie informácie o rýchlych úpravách bez inštalácie akýchkoľvek nástrojov nájdete v téme Úprava v prehliadači .
Prehľad
Ak chcete prispievať do dokumentácie v službe Microsoft Learn, môžete lokálne vytvárať a upravovať súbory v jazyku Markdown tak, že vykonáte klonovanie príslušného odkladacieho priestoru dokumentácie. Spoločnosť Microsoft vyžaduje, aby ste rozdeľovali príslušný odkladací priestor do svojho vlastného konta GitHub tak, aby ste mali povolenia na čítanie a zápis a mohli uchovávať svoje navrhované zmeny. Potom pomocou žiadostí o prijatie zmien (PR) zlúčte zmeny do centrálneho zdieľaného odkladacieho priestoru, ktorý je iba na čítanie.
Odkladací priestor spoločnosti Microsoft sa označuje ako upstream. Pomocou akcie vetvenia v rámci používateľského rozhrania služby GitHub používateľ vetví odkladací priestor Microsoft do svojho vlastného konta GitHub. Táto vetva sa označuje ako Origin. Pomocou klonu git používateľ klonuje Origin do svojho lokálneho počítača. Nakoniec používateľ používa git remote add upstream na pripojenie svojho lokálneho klonu späť do odkladacieho priestoru upstream od spoločnosti Microsoft.
Určenie odkladacieho priestoru
Dokumentácia hosťovaná na lokalite Microsoft Learn sa nachádza v niekoľkých odkladacích priestoroch v službe GitHub.
Ak si nie ste istí, v ktorom odkladacom priestore sa článok nachádza, navštívte článok pomocou webového prehliadača. Vyberte prepojenie Upraviť (ikona ceruzky) v pravom hornom rohu článku.
Táto akcia vás vezme do zdrojového súboru v službe GitHub. Názov odkladacieho priestoru sa zobrazí v ľavom hornom rohu stránky.
Tu je niekoľko populárnych odkladacích priestorov, ktoré sú k dispozícii pre verejné príspevky:
- Obsah komunity Microsoft Learn https://github.com/MicrosoftDocs/community-content/
- Dokumentácia k Azure https://github.com/MicrosoftDocs/azure-docs
- Dokumentácia k SQL Serveru https://github.com/MicrosoftDocs/sql-docs
- Dokumentácia k Visual Studiu https://github.com/MicrosoftDocs/visualstudio-docs
- Dokumentácia k technológii .NET https://github.com/dotnet/docs
- Dokumentácia k Azure .NET SDK https://github.com/azure/azure-docs-sdk-dotnet
- Dokumentácia k nástroju ConfigMgr https://github.com/MicrosoftDocs/SCCMdocs
Vetvenie odkladacieho priestoru
Po identifikovaní správneho odkladacieho priestoru je ďalším krokom vetviť odkladací priestor do svojho vlastného konta GitHub.
Vetviť odkladací priestor znamená vytvoriť jeho kópiu vo vašom konte GitHub. Vyžaduje sa osobná vetva, pretože všetky odkladacie priestory dokumentácie spoločnosti Microsoft poskytujú prístup iba na čítanie, ale vaša vetva vám poskytuje prístup na zápis na vykonanie zmien. Vetva vám umožňuje otvoriť žiadosti o prijatie zmien zo svojej vetvy do odkladacieho priestoru spoločnosti Microsoft.
Na stránke hlavného odkladacieho priestoru v službe GitHub vyberte tlačidlo Vetvenia v pravom hornom rohu.
Na obrazovke Vytvorenie novej vetvy skontrolujte, či je možnosť Vlastník nastavená na vaše meno používateľa a začiarknuté je možnosť Kopírovať iba hlavnú vetvu. Prípadne môžete zmeniť názov odkladacieho priestoru a polia Popis .
Klonovanie odkladacieho priestoru
Clone (Klonovanie) znamená vytvorenie kópie odkladacieho priestoru v lokálnom počítači.
Upozornenie
NEKLONUJTE lokálne odkladacie priestory do synchronizovaných priečinkov vo OneDrive. Keď vyberiete priečinok, do ktorého budete klonovať odkladací priestor, vyhnite sa priečinkom, ktoré sa synchronizujú s OneDrivom (napríklad s priečinkom Dokumenty ). OneDrive môže pri zlúčení zmien späť do hlavnej vetvy spôsobiť nechcené konflikty zlúčenia. Namiesto toho je najlepšie vytvoriť na
C:\
jednotke krátky súbor (napríklad C:\GitHub).Git vo Windowse: povoľte dlhé názvy ciest. V predvolenom nastavení Git pre Windows zakáže podporu pre dlhé cesty k súboru, čo zabraňuje klonovaniu ľubovoľného súboru s cieľovou cestou dlhšou ako 255 znakov. Povoľte dlhé cestasúbory súborov, aby ste sa tomuto problému vyhli, spustením nasledujúceho príkazu ako správca:
git config --global core.longpaths true
Vytvorte
GitHub
priečinok v lokálnom počítači. Napríklad C:\GitHub. (Klonujte ho do synchronizačná aplikácia OneDrivu priečinka.)V prehliadači prejdite na GitHub.com a prihláste sa.
V GitHube vpravo hore vyberte z rozbaľovacieho zoznamu svojho profilu položku Vaše odkladacie priestory. Stránka odkladacích priestorov sa zobrazí so zoznamom vašich vetvených odkladacích priestorov.
Vyberte odkladací priestor, ktorý chcete klonovať. Zobrazí sa stránka odkladacieho priestoru vašej vetvy.
Uistite sa, že ste na stránke odkladacieho priestoru pre vetvu , nie na stránke pre produkčný odkladací priestor. Odkladací priestor, na ktorom sa nachádzate, môžete overiť tak,
https://github.com/nancydavolio/azure-docs
že skontrolujete URL adresu: mala by sa zobraziť vaše meno používateľa v službe GitHub, nie v organizácii spoločnosti Microsoft (napríklad a NOThttps://github.com/MicrosoftDocs/azure-docs
). Vaše meno sa zobrazí aj v ľavom hornom rohu a zobrazí sa poznámka, ktorá stojí za názvom hlavného odkladacieho priestoru.<> Vyberte kartu Kód v ľavej hornej časti stránky.
Na pravej strane v rozbaľovacom zozname Kód skopírujte URL adresu pod možnosťou HTTPS .
Dôležité
SKOPÍROVALI ste URL adresu klonu prostredníctvom používateľského rozhrania služby GitHub. Zvyšok krokov by sa mal vykonať v termináli VS Code.
Klonovanie z Visual Studia Code
Otvorte Visual Studio Code.
V hornej navigačnej ponuke vyberte položku Zobraziť a potom vyberte položku Terminal (Terminál). Koncové zobrazenie sa zobrazí v dolnej časti obrazovky programu Visual Studio Code.
V zobrazení terminálu spustite príkaz na zmenu adresára (cd) na
GitHub
priečinok, ktorý ste vytvorili pre odkladacie priestory na jednotke, v kroku 1 v časti Clone a repository (Klonovať odkladací priestor).Príklad:
cd C:\GitHub
Ak sa zobrazí chyba, možno budete musieť naraz zmeniť adresár po jednom priečinku.
Spustite nasledujúci príkaz na klonovanie odkladacieho priestoru:
git clone <paste the clone URL you copied via the GitHub UI>
Napríklad:
git clone https://github.com/nancydavolio/azure-docs.git
Po zobrazení výzvy na overenie prostredníctvom prehliadača vyberte tlačidlo Prihlásiť sa pomocou prehliadača a dokončite proces. Stiahnite si najnovšiu verziu systému Git, ktorá podporuje overovanie prostredníctvom funkcií prehliadača. Ak sa rozhodnete použiť osobný prístupový token GitHubu, môžete si vygenerovať jeden z nasledujúcich pokynov: Vytvorte osobný prístupový token.
Príkaz clone stiahne súbory odkladacieho priestoru z vašej vetvy do nového priečinka v umiestnení, ktoré ste vybrali v kroku 3. Nový priečinok sa vytvorí v aktuálnom priečinku. To môže trvať niekoľko minút v závislosti od veľkosti odkladacieho priestoru. Po dokončení môžete preskúmať priečinok a pozrieť si jeho štruktúru.
Nastavenie vzdialených možností
Po klonovaní odkladacieho priestoru nastavte vzdialené pripojenie s prístupom iba na čítanie k hlavnému odkladaciemu priestoru s názvom upstream. Vzdialené sú aliasy, ktoré odkazujú na vzdialené odkladacie priestory. Origin odkazuje na vašu vetvu a upstream odkazuje na produkčný odkladací priestor. Git automaticky vytvoril origin
vzdialené pri spustení clone
príkazu. URL adresa upstreamu sa používa na udržiavanie synchronizácie vášho lokálneho odkladacieho priestoru s najnovšími zmenami, ktoré urobili iní používatelia.
Spustite nasledujúce príkazy v termináloch Git Bash alebo VS Code.
Zmeňte adresár (
cd
) na priečinok odkladacieho priestoru, ktorýclone
vytvoril príkaz. Napríklad:cd repo-name
Spustením nasledujúceho príkazu pridajte vzdialený názov
upstream
, ktorý odkazuje na produkčný odkladací priestor. Napríklad URL adresa odkladaciehoupstream
priestoru nie jehttps://github.com/MicrosoftDocs/azure-docs.git
https://github.com/nancydavolio/azure-docs.git
.git remote add upstream <the clone URL of the main repo>
Napríklad:
git remote add upstream https://github.com/MicrosoftDocs/azure-docs.git
Spustením nasledujúceho príkazu skontrolujte, či sú vaše vzdialené položky správne:
git remote -v
Príklad výstupu:
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)
Ak ste urobili chybu, odstráňte vzdialené ovládanie a pridajte ho opakovaním kroku. Ak chcete odstrániť
upstream
, spustite príkaz:git remote remove upstream
Ďalšie kroky
- Teraz, keď ste nastavili lokálny klon, nastal čas vykonať veľké zmeny.