Jaa

Microsoft Learn -dokumentaation Git- ja GitHub-perusteet

  • Artikkeli

Yleiskuvaus

Osallistuessasi Microsoft Learn -dokumentaatioon osallistut useisiin työkaluihin ja prosesseihin. Työskentelet muiden osallistujien kanssa rinnakkain samassa projektissa, mahdollisesti täsmälleen saman sisällön parissa ja ehkä jopa samanaikaisesti. Tämä kaikki on mahdollista Git- ja GitHub-ohjelmiston kautta.

Git on avoimen lähdekoodin versiontarkistusjärjestelmä. Se helpottaa tällaista projektiyhteistyötä mahdollistamalla jaetun versionhallinnan tiedostoissa, joita säilytetään reaaliaikaisen käytön aikana säilöissä. Lyhyesti sanottuna Git mahdollistaa useiden eri osallistujien ajan mittaan tekemän työn työvirtojen integroinnin tietyssä säilössä.

GitHub on Git-säilöjen, kuten Microsoft Learn -sisällön säilytykseen käytettyjen säilöjen, verkkopohjainen isännöintipalvelu. Missä tahansa projektissa GitHub isännöi pääsäilöä, josta osallistujat voivat tehdä kopioita omaa työskentelyään varten.

Tässä artikkelissa määritetään keskeiset termit, jotka ovat osa Microsoft Learn -työnkulkua. Se sisältää myös yleiskatsauksen Git- ja GitHub-säilöistä sekä kerrotaan, miten sisältö on järjestetty Microsoftin tekniseen dokumentaatioon.

Branch

Haarat erottavat toisistaan työvirrat (joita yleensä kutsutaan versioiksi). Eri osallistujien työpanokset tallentuvat ja rajoittuvat aina tiettyyn haaraan.

Eristämalla tiettyyn haaraan liittyvät muutokset voit hallita ja lisätä kyseiset muutokset erikseen. Riippuen siitä, millaista työtä teet, saatat käytännössä päätyä tilanteeseen, jossa säilössäsi on useita toimivia haaroja. On hyvin tavallista työskennellä useiden haarojen parissa samanaikaisesti, joista kukin edustaa eri projektia.

Kaikki säilöt sisältävät oletushaaran (jota tavallisesti kutsutaan päähaaraksi) ja yhden tai useamman keskeneräisen työn alla olevan haaran (työhaaroja), joita ei ole vielä integroitu oletushaaraan. Oletushaara toimii nykyisenä versiona ja projektin yksittäisenä totuuden lähteenä. Kaikki muut säilön haarat luodaan päähaarasta.

Aina, kun lisäät joukon loogisesti toisiinsa liittyviä muutoksia, on parasta luoda toimiva haara muutosten hallitsemiseksi. Emme suosittele muutosten tekemistä suoraan oletushaaraan.

Fork-toiminto

Tätä termiä käytetään tavallisesti solmuna viitattaessa GitHub-pääsäilön kopioon. Käytännössä haarautuma on vain säilö muiden joukossa. Se on kuitenkin erityinen siinä mielessä, että GitHub ylläpitää yhteyttä takaisin pääsäilöön. Tätä termiä käytetään joskus verbinä, kuten "Säilöön täytyy ensin tehdä haarautumat".

Git

Jos keskitetyt versiontarkistusjärjestelmät (kuten Team Foundation Server, SharePoint tai Visual Source Lokero) ovat sinulle tuttuja, huomaat, että Gille on ainutlaatuinen osallistumistyönkulku ja -terminologia, jotka tukevat sen hajautettua mallia. Esimerkiksi tiedoston lukitsemista, joka tavallisesti liittyy sisään- ja uloskuittaustoimintoihin, ei käytetä. Sen sijaan Git on huolissaan vielä hienommilla muutoksilla muutoksista, tiedostojen tavutavujen vertailuun.

Git käyttää myös kerrostettua rakennetta projektin sisällön tallennukseen ja hallintaan:

  • Säilö: tämä on korkeimman tason tallennusyksikkö. Säilö sisältää yhden tai useamman haaran.
  • Haara: tallennusyksikkö, joka sisältää tiedostot ja kansiot, jotka muodostavat projektin sisältöjoukon. Lisätietoja haaroista on tämän artikkelin Haara-osassa .

Osallistujat päivittävät ja käsittelevät säilöjä vuorovaikutuksessa Git-palvelun kanssa sekä paikallisella tasolla että GitHub-tasolla seuraavilla tavoilla:

  • Paikallisesti hyödyntämällä erilaisia työkaluja, kuten Git Bash -konsolia, joka tukee Git-komentoja paikallisten säilöjen hallinnassa ja kommunikoinnissa GitHub-säilöjen kanssa.
  • Käyttämällä www.github.com-sivustoa, johon on integroitu Git-palvelu takaisin pääsäilöön virtaavien työpanosten yhteensovitusta varten.

GitHub

Muistiinpano

Vaikka ohjeet perustuvat GitHubin käyttöön, jotkin tiimit käyttävät Visual Studio Team Servicesiä Git-säilöjen isännöintiin. Visual Studio Team Explorer -asiakasohjelmassa on graafinen käyttöliittymä Team Services -säilöjen hallintaan vaihtoehtona komentorivin Git-komentojen käytölle.
Myös monet seuraavista ohjeista on kehitetty parhaina käytäntöinä Azure-palvelusisällön isännöinnistä GitHubissa vuosien kokemuksen perusteella. Ne saattavat olla pakollisia joissakin Microsoft Learn -säilöissä.

Kaikki työnkulut alkavat ja päättyvät GitHubin tasolla, jolla sijaitsee kaikkien asiakirjaprojektien ensisijainen säilö. Kopiot, jotka osallistujat luovat omiin tarpeisiinsa, jaetaan useisiin tietokoneisiin. Nämä kopiot yhdistetään lopulta takaisin projektin GitHub-pääsäilöön.

Hakemiston järjestely

Projektin oletushaara toimii projektin sisällön nykyisenä versiona. Oletushaaran – ja siitä luotujen haarojen – sisältö on löyhästi yhdenmukainen artikkelien organisaation kanssa vastaavilla Microsoft Learn -sivuilla. Alihakemistoja käytetään erottamaan samankaltaiat artikkelit (kuten palvelut), mediasisältö (kuten kuvatiedostot) ja "sisällytä" tiedostot (jotka mahdollistavat sisällön uudelleenkäytön).

Artikkelit-alihakemisto

Löydät articles-päähakemiston tavallisesti säilön juuresta. - articles hakemisto sisältää joukon alihakemistojen artikkeleita, jotka on muotoiltu Markdown-tiedostoiksi, joilla on .md-tunniste . Jotkin useita palveluja tukevat säilöt käyttävät yleistä /articles-alihakemistoa. Esimerkiksi Azure-Docs-säilö on tällainen. Muut säilöt saattavat käyttää palvelukohtaista nimeä. Tällainen on esimerkiksi IntuneDocs-säilö, joka käyttää /IntuneDocs-alihakemistoa.

Tämän hakemiston juuresta löydät yleisiä artikkeleita, jotka liittyvät koko palveluun tai tuotteeseen. Löydät tavallisesti myös toisen alihakemistojen sarjan, joka vastaa toimintoja ja palveluja tai yleisiä skenaarioita. Esimerkiksi Azuren näennäiskoneen artikkelit ovat /virtual-machines-alihakemistossa ja Intunen ”ymmärtämisen ja tutkimisen” artikkelit ovat /understand-explore-alihakemistossa.

Media-alihakemisto

Jokainen artikkelihakemisto sisältää /media-alihakemiston vastaavia mediatiedostoja varten. Mediatiedostot sisältävät kuvia, joita käyttävät artikkelit, joissa on kuvaviitteitä.

Sisältää alihakemiston

Mahdollinen kahden tai useamman artikkelin välillä jaettu uudelleenkäytettävä sisältö sijoitetaan /includes-alihakemistoon articles-päähakemistossa. Jos Markdown-tiedostossa käytetään sisällytettyä tiedostoa, vastaava sisällytyksen Markdown-tunniste sijoitetaan paikkaan, johon sisällytetyn tiedoston täytyy viitata.

Katso lisäohjeita kohdasta Markdown-viitetiedot: Sisällytys .

Markdown-tiedostomalli

Kunkin säilön juurihakemistossa on yleensä käytännöllisyyden vuoksi Markdown-mallitiedosto, jonka nimi on template.md. Voit käyttää tätä mallitiedostoa lähtökohtana, jos haluat luoda uuden artikkelin säilöön lähetettäväksi. Tiedostossa on seuraava sisältö:

  • Tiedoston yläosassa sijaitseva metatieto-otsikko, joka on hahmoteltu kahdelle kolmen yhdysmerkin viivalle. Se sisältää erinäisiä tunnisteita, joita käytetään artikkeliin liittyvien tietojen seurantaan. Artikkelin metatiedot mahdollistavat tietyt toiminnot, kuten tekijän attribuution, osallistujan attribuution, navigointipolut ja artikkelin kuvaukset. Se sisältää myös SEO-optimointeja ja raportointiprosesseja, joita Microsoft käyttää sisällön suorituskyvyn arviointiin. Metatiedot ovat siis tärkeitä!
  • Metatieto-osio, joka kuvaa eri metatietotunnisteet ja -arvot. Jos et ole varma metatieto-osiossa käytettävistä arvoista, voit jättää ne tyhjiksi tai kommentoida niitä lisäämällä niiden eteen ristikkomerkin (#), jolloin säilön pull-pyyntöjen tarkistaja tarkistaa/täydentää ne.
  • Esimerkkejä Markdownin käytöstä artikkelin osien muotoilussa.
  • Yleisiä ohjeita eri ilmoitustyyppien yhteydessä käytettävien Markdown-laajennusten käytöstä.
  • Esimerkkejä videon upottamisesta iframe-kehyksen avulla.
  • Yleiset ohjeet Microsoftin teknisten ohjeiden laajennusten käytöstä, ja voit käyttää näitä erityisohjausobjekteja, kuten painikkeita ja valitsimia.

Alkuperä

Tämä termi on nimi, joka määritetään yhteydelle paikallisen säilön ja sen säilön välillä, josta se kloonattiin. Microsoft Learn -työnkulussa alkuperä edustaa yhteyttä haaraumaan. Tätä termiä käytetään joskus nimikkeinä itse alkuperäsäilölle, kuten "Muista siirtää muutokset alkuperään".

Pull-pyynnöt

Pull-pyyntö (PR) on sisällön omistajalle tarkoitettu pyyntö noutaa muutokset viralliseen lähteeseen. PULL-pyyntö mahdollistaa GitHubin yhteistyömallin pyytämällä, että työhaaran muutokset (joita kutsutaan myös vahvistuksiksi) noudetaan ja yhdistetään toiseen haaraan. Useimmissa tapauksissa kyseinen toinen haara on pääsäilön oletushaara.

PULL-pyyntö toimii myös mekanismina, jonka avulla osallistuja saa palautetta Microsoft Learnin vahvistusprosesseista ja PR-tarkistaja voi ratkaista ongelmat tai kysymykset ennen muutosten yhdistämistä oletushaaraan.

Kauko

Etäyhteys on nimetty yhteys etäsäilöön, kuten "alkuperä"- tai "yläpuoliseen" etäsäilöön. Git viittaa tähän etäsäilönä, koska sillä viitataan säilöön, joka sijaitsee toisella tietokoneella. Microsoft Learn -työnkulussa etäsäilö on aina GitHub-säilö.

Tuotantoketjun alkupää

Samoin kuin alkuperäetäsäilö, yläpuolinen säilö on toisen säilön nimetty yhteys. Microsoft Learn -työnkulussa yläpuolinen säilö edustaa yhteyttä paikallisen säilön ja sen pääsäilön välillä, josta haarautuksesi on luotu. Tätä termiä käytetään joskus nimitystoimintona itse ylätason säilölle, kuten "Muista ottaa uusimmat muutokset yläpuoliksesta".

Lisätietoja

Jos et tunne Gitistä tai GitHubista, näiden resurssien avulla voit oppia, olla tuottava tai vastata kysymyksiin.

Git-lähteen hallintaresurssit

GitHub-resurssit

Usein kysytyt kysymykset

Mitä Git on?

Git auttaa seuraamaan muutoksia, kun monet käyttävät tietokonekoodia yhdessä. Se on kuin koodin aikakone, joten voit tarvittaessa palata takaisin.

Miksi Git-git-komentoa käytetään?

Se sopii erinomaisesti tiimityöskelpaan. Gitin avulla monet ihmiset voivat helposti työskennellä samassa projektissa mokaamatta toistensa työtä. Se auttaa myös korjaamaan virheitä helposti.

Miten Git toimii?

Git tallentaa kaikki versiot projektin koodista. Kun teet muutoksia, Git ottaa kuvan (kuten tilannevedoksen) erilaisista ominaisuksesta. Voit tehdä eri versioita samanaikaisesti ilman ongelmia.

Mitä ovat haarat Gitissä?

Haarat ovat kuin projektin eri polut. He antoivat ihmisten työstää uusia asioita muuttamatta pääprojektia. Myöhemmin he voivat tuoda nämä muutokset takaisin pääprojektiin.

Mikä on vahvistus Gitissä?

Vahvistus on kuin tallennuspiste. Sen avulla voit tallentaa tekemäsi muutokset. Jokaisella vahvistuksella on yksilöivä tunnus ja huomautus muutoksista.

Mikä GitHub on?

GitHub on sivusto, johon voit tallentaa Git-projektisi. Se on kuin iso keskus koodin jakamiseen ja työstämiseen yhdessä muiden kanssa. Se auttaa myös seuraamaan, kuka on muuttanut mitäkin.

Miten GitHub poikkeaa Gitistä?

Git on työkalu muutosten seurantaan, kun taas GitHub on paikka, johon voit tallentaa projektisi ja työskennellä yhdessä. GitHub käyttää Gitin taikuutta.

Onko GitHub ilmainen?

Kyllä, projekteissa kaikki voivat nähdä. Yksityisissä projekteissa (vain sinä ja tiimisi) saatat joutua maksamaan. Ne tarjoavat erilaisia palvelupaketteja ja lisäominaisuuksia.

Mitä ovat Pull-pyynnöt GitHubissa?

Pull-pyynnöt ovat kuin pyydetään sijoittamaan muutoksesi pääprojektiin. Ihmiset voivat tarkastella muutoksia ja keskustella niistä ennen niiden lisäämistä.

Kuinka turvallinen GitHub on?

GitHub huolehtii hyvin suojauksesta. He käyttävät erikoiskoodeja ja sääntöjä varmistaakseen, että vain oikeat käyttäjät voivat käyttää ja muuttaa koodiasi. Voit myös lisätä ylimääräisiä suojauskerroksia, kuten kaksivaiheisen todentamisen, lisätäkseen turvallisuutta.