Kuinka käyttää GitLab-käyttöliittymää monimutkaisempaan asiakirjojen ylläpitoon
Dokumentaatiota pitää ylläpitää sisällön kasvaessa. Kirjoittajat ja arvioijat voivat osallistua dokumentaatioihin helposti ja tehokkaasti GitLabin verkkokäyttöliittymässä. Web IDE:stä, CI-putkistosta renderöidyn sisällön yhteisarviointiin ja sivujen hyväksyntään voit työskennellä hyvän sisällön ja dokumenttien ylläpidon parissa ilman keskeytyksiä asennukseen ja konfigurointiin. Artikkeli olettaa, että olet jo perehtynyt Gitin ja jatkuvan integraation (CI) kanssa.
Asiakirjojen ylläpito
Dokumentaation ylläpito ilmenee monin tavoin.
-
Tekninen tarkkuus
-
Ajantasaisuus
-
Dokumentaation kuratointi loogisessa järjestyksessä
-
Johdonmukaisuus esityksessä
-
Vakiomallipohjat, attribuutit ja käytännöt, joita sovelletaan Docs-repoissa
-
CI-putken käyttö dokumenttien laadun tarkistusten automatisointiin
Seuraavat osiot käyvät läpi, miten ylläpitää ja jatkuvasti parantaa Fedora Docs -repositioita GitLabin sisäänrakennettujen työkalujen avulla.
GitLab Web IDE
Uusi Web IDE julkaistiin osana GitLab 15.7 -versiota joulukuussa 2022, ja se tarjoaa tiedostoselaimen, tekstieditorin ja versionhallinnan samassa paikassa.
Explorer
Vasemman ruudun resurssienhallinta auttaa löytämään Fedora-dokumenttien arkistorakenteen ja tiedostoluettelon. Olipa arkisto mikä tahansa, vakiomuotoinen arkistorakenne mahdollistaa tiedostojen selaamisen ja useiden sivujen ristiviittausten nopean tekemisen.
Tekstieditori
Kun olet tehnyt muutoksia, siirry toimintopalkissa olevaan lähdekoodinhallinta-kuvakkeeseen ja napsauta Muutosten-painiketta Vahvista ja lähetä -painikkeen alla nähdäksesi luettelon muuttamistasi tiedostoista rinnakkain. Jos olet tehnyt useita muutoksia, Muutosten-painike näyttää yleiskatsauksen tekemistäsi muutoksista.
Jos napsautat Luo MR, sinut ohjataan haarautumaan yhdistämispyynnön luomista varten. Siirry projektiin -vaihtoehto sopii, kun olet tehnyt pieniä committeja vaiheittain ja haluat yhdistää ne yhdeksi.
CI pipeline
Docsin automaattinen testi käynnistää syntaksin validoinnin ja tyylivirheet sekä auttaa korjaamaan ne ennen MR:n yhdistämistä. Tavoitteena on dokumentaation yhdenmukaisuus koko projektin tasolla ja tyylioppaiden noudattaminen. Docs-tiimi esitteli syntaksitietoisen dokumentaatiolinkerin muutamalle repositoriolle, josta löytyy vale-määritystiedostoja. Jotkut kirjoittajat kirjoittavat artikkeleita ilman tyylioppaiden ja luettavuuden tuntemusta. Katso vale-linkerin konfiguraatio CI:lle kyseisissä repositorioissa:
Documentation linter carries out more than 20 tests:
-
To trigger a CI pipeline to scan for any errors.
-
Dokumentaation sanojen ja rakenteen nukkaamiseksi.
-
Linkkien oikeellisuuden tarkistamiseksi.
-
Tarkistaa luettavuuden ja suorittaa testejä tietoisen kielenkäytön ja muiden ominaisuuksien varalta.
Please be aware linter helps you write better, but it does not auto correct errors.
Visuaaliset arvostelut
Tarkastelusovelluksissa näytetään renderöidyn sivun reaaliaikainen esikatselu, jos napsautat näytä sovellus -kuvaketta tai näytä käyttöönotto -kuvaketta esikatselussa MR_number.
Sinulle näytetään Artifacts-build-sivu, jossa on työnumero ja linkki GitLabissa isännöityyn renderöityyn sivuun. Napsauta linkkiä tarkastellaksesi sisältöä aivan kuten suoritit Docsbuild-komentosarjan paikallisella tietokoneella.
Muutosten esikatselu MR-tarkistuksen aikana helpottaa tiivistä yhteistyötä virheiden havaitsemiseksi ja ehdotusten tekemiseksi sisällön parantamiseksi.
Näytä sovellus -painike katoaa näkyvistä MR:n yhdistämisen jälkeen.
Want to help? Learn how to contribute to Fedora Docs ›