De documentatie van Git en van GitHub essentiële
Overzicht
Als u alleen kleine, alleen-tekst wijzigingen in artikelen wilt aanbrengen, hoeft u de details van dit artikel niet te begrijpen. In dit artikel wordt de workflow beschreven voor het uitvoeren van belangrijke bewerkingen, zoals het maken van nieuwe artikelen, het toevoegen van afbeeldingen of het doorlopend bewerken van de documentatie bij de Adobe.
Als medewerker aan de inhoud van de Adobe documentatie, kunt u met veelvoudige hulpmiddelen en processen in wisselwerking staan. U kunt parallel met andere contribuanten aan hetzelfde project werken, mogelijk dezelfde inhoud, zelfs tegelijkertijd. Dit wordt allen toegelaten door de software van Git en van GitHub.
Git is een opensource versiecontrolesysteem dat samenwerking toestaat. De veelvoudige medewerkers kunnen aan dossiers werken die in bewaarplaatsen leven.
GitHub is de web-based ontvangende dienst voor de bewaarplaatsen van het Git, zoals die worden gebruikt om docs.adobe.cominhoud op te slaan. Voor om het even welk project, gastheren GitHub de belangrijkste bewaarplaats, waarvan de contribuanten exemplaren voor hun eigen werk kunnen maken.
Git
Git heeft een unieke workflow en terminologie voor bijdragen die het gedistribueerde model ondersteunen. Er is bijvoorbeeld geen bestandsvergrendeling die normaal gesproken aan uitchecken/inchecken is gekoppeld. Met Git kunnen wijzigingen nog fijner worden opgelost, waarbij bestanden per byte worden vergeleken.
Git gebruikt ook een gelaagde structuur om inhoud voor een project op te slaan en te beheren:
- Bewaarplaats: Ook gekend als a repo, is dit de hoogste eenheid van opslag. Een gegevensopslagruimte bevat een of meer vertakkingen.
- Tak: Alle bewaarplaatsen bevatten een standaardtak (typisch genoemd "hoofd") en één of meerdere takken die om terug in de belangrijkste tak bestemd zijn te worden samengevoegd. De hoofdvertakking fungeert als de huidige versie en bron van waaruit inhoud wordt gepubliceerd. Het is het bovenliggende element waarvan alle andere vertakkingen in de repository worden gemaakt.
Medewerkers werken met Git samen om opslagruimten op zowel het lokale niveau als het niveau van GitHub bij te werken en te manipuleren:
- Lokaal door hulpmiddelen zoals de Desktop GitHub.
- Via www.github.com, die Git integreert om de verzoening van bijdragen te beheren die terug naar de belangrijkste bewaarplaats stromen.
GitHub
Alle werkschema's beginnen en eindigen op het niveau GitHub, waar de belangrijkste bewaarplaats voor om het even welk project van de Adobe documentatie wordt opgeslagen. De kopieën die contribuanten voor eigen gebruik maken, worden verspreid over meerdere computers. Deze exemplaren worden uiteindelijk in de belangrijkste bewaarplaats GitHub van het project samengebracht.
Directoryorganisatie
De standaard/hoofdvertakking van een project fungeert als de huidige versie van de inhoud voor het project. De inhoud in de hoofdvertakking - en takken die van het worden gecreeerd - richt zich op de organisatie van de artikelonderwerpen. Submappen worden gebruikt voor het ordenen van inhoud en afbeeldingselementen.
Doorgaans kunt u een help -hoofdmap van de hoofdmap van de opslagplaats vinden. De artikelmap bevat een set submappen. Artikelen in de submappen worden opgemaakt als Markeringen voor bestanden die de extensie .md gebruiken.
Binnen de wortel van deze folder, kunt u algemene artikelen vinden die op de algemene dienst of het product betrekking hebben. En typisch, kunt u een andere reeks subdirectories dan vinden die de eigenschappen/de diensten of gemeenschappelijke scenario's aanpassen.
Assets-directory
De gidsen van de gebruiker bevatten /assets subdirectories voor beelddossiers die binnen een folder van verwijzingen worden voorzien.
Pull-aanvragen
A trekt verzoek een geschikte manier voor een medewerker om een reeks veranderingen voor te stellen die op de standaardtak zullen worden toegepast. De veranderingen (die ook als worden bekend begaan) worden opgeslagen in de tak van een contribuant, zodat kan GitHub het effect van eerst modelleren die hen samenvoegen in de standaardtak. Een pull-verzoek fungeert ook als een mechanisme om de contribuant feedback te geven van een build/validatieproces, de controleur van de pull-aanvraag, om mogelijke problemen of vragen op te lossen voordat de wijzigingen worden samengevoegd in de standaardvertakking.
Er zijn twee manieren om door trekpleverzoek bij te dragen, afhankelijk van de grootte van veranderingen die u wilt voorstellen. Wij zullen dit in detail later, in de GitHub werkschemasectie van deze gids behandelen.