Kuinka muokata tiedostoja Paguressa Web Käyttöliittymässä

Hanku Lee Versio F33 and newer Last review: 2023-04-18

Tässä osiossa kuvataan, miten voit osallistua olemassa olevaan dokumentaatioon - eli dokumentaatioon, joka on jo julkaistu verkkosivustolla. Ennen kuin aloitat tämän toimenpiteen, varmista, että täytät kaikki kohdassa Prerequisites luetellut vaatimukset.

Jos olet kiinnostunut osallistumaan julkaisutietoihin, katso asianmukainen sivu.

Jokaisen Fedora Docs -sivun yläreunassa on 'Muokkaa tätä sivua' -linkki. Yksinkertaisia päivityksiä varten muutokset voidaan lähettää suoraan Paguren verkkokäyttöliittymästä. Suuremmissa tai monimutkaisemmissa muokkauksissa sinun tulee valmistella ja testata muutokset offline-tilassa ennen lähettämistä.

Editointi verkossa Paguressa

  1. Napsauta 'Muokkaa tätä sivua' -linkkiä ladataksesi dokumentaatiolähteen. Sinut ohjataan asianmukaiseen sisältövarastoon Paguressa.

  2. Napsauta oikealla puolella olevan lähdeluettelon yläpuolella 'Haarukka ja muokkaa'. (Jos olet jo haarautunut arkistoon, tämä painike on merkitty 'Muokkaa haarukassasi' ja voit siirtyä seuraavaan vaiheeseen.)

    1. Jos et ole vielä kirjautunut sisään Pagureen, sinulta kysytään tunnistetietojasi.

    2. Odota toimenpiteen päättymistä. Sinun on ehkä päivitettävä sivu, koska se ei aina päivity automaattisesti, kun prosessi on valmis.

  3. Kun tiedosto on ladattu haarukkaan, tee tarvittavat muutokset sisältöön, vahvista ne haarukkaan ja valmistele pull-pyyntö (PR).

    1. Jokainen pull-ilmoitus tulee lähettää omasta haarastaan arkistossasi. Valitse toimitusliittymän Haara-otsikon alta 'Uusi haara' ja anna haaralle lyhyt, yksilöllinen nimi.

    2. Täytä toimitusviestilomake.

    3. Napsauta 'Vahvista muutokset' luodaksesi haaran ja tallentaaksesi nämä muutokset haarukkaan.

  4. Kun toimitus on tallennettu, sivu päivittyy haarukan toimitusten luetteloon.

  5. Jos haluat sisällyttää muita toisiinsa liittyviä muutoksia, toista tämä prosessi ja sitouta ne samaan haaraan.

  6. Kun olet valmis, napsauta 'Luo pull-pyyntö' ja täytä PR-lomake lähettääksesi haarasi ylävirran arkistoon.

Git-toimitusvinkkejä

  • Kun nimeät haaraa, käytä vain ASCII-kirjaimia, numeroita, väliviivoja (%-%) ja alaviivoja (%_%). Nimi may sisältää yksittäisiä pisteitä (%.%). Välilyönnit, kaksoispisteet (%.. %), ja useimmat muut välimerkit eivät ole sallittuja.

  • Toimituksen otsikko on tapa, jolla muokkauksesi tunnistetaan sivun arkistolokissa. Ehdotettu otsikko 'Päivitä [tiedostonimi]%%polkunimi%%' riittää pieniin muokkauksiin. Neuvoja hyvien commit-viestien kirjoittamiseen on commit.style, jonka on kirjoittanut Tim Pope ([application]%vim-kirjan kirjoittaja).

  • Käytä Commitin kuvaus -kenttää lisätietojen antamiseen tarvittaessa, mutta pidä se lyhyenä. Sinulla on mahdollisuus selittää tai keskustella muutoksistasi, kun lähetät PR:n.

Offline-muokkaus

  1. Napsauta 'Muokkaa tätä sivua' -linkkiä ladataksesi dokumentaatiolähteen. Sinut ohjataan asianmukaiseen sisältövarastoon Paguressa. Kun olet löytänyt oikean arkiston, tee haarukka, jos sinulla ei ole sitä vielä haarautunut:

    1. Napsauta oikeassa yläkulmassa Haarukka.

    2. Jos et ole vielä kirjautunut sisään Pagureen, sinulta kysytään tunnistetietojasi.

    3. Odota toimenpiteen päättymistä. Sinun on ehkä päivitettävä sivu, koska se ei aina päivity automaattisesti, kun prosessi on valmis.

    4. Kloonaa haarukkasi.

  2. Tutustu uuteen haaraan ja lisää lahjoituksesi.

  3. Jos olet lisännyt uusia tiedostoja, varmista, että ne ovat kohtuullisessa paikassa arkiston [tiedostonimi]%nav.adoc%-määritystiedostossa

  4. Rakenna paikallisesti ja varmista, että kaikki näyttää siltä, miltä odotat. Katso ohjeet Paikallisen esikatselun rakentaminen.

  5. Kun olet valmis, vahvista muutokset ja työnnä ne haarukkaan.

  6. Paguren avulla voit tehdä pull-pyynnön haarukastasi pääarkiston päähaaraan.

Pull-pyynnön hallinta

Joku näkee pull-pyyntösi ja joko yhdistää sen tai antaa palautetta, jos sinun pitäisi muuttaa jotain. Työskentele kommentoijien kanssa varmistaaksesi, että panoksesi ovat standardien mukaisia.

Jos kukaan ei reagoi vetopyyntöösi useaan päivään, yritä tuoda se esiin jollakin linkeistä:https://calendar.fedoraproject.org//docs/[weekly meetings], Matrix-kanavalla (#docs Fedora Chatissa) tai linkillä:https://discussion.fedoraproject.org/tag/docs[postituslista].

Muutokset näkyvät verkossa jonkin aikaa pull-pyynnön yhdistämisen jälkeen. Sivustoa päivitetään tunnin välein. Jos muutokset eivät näy verkossa 24 tunnin kuluessa PR:n yhdistämisestä, pingaa %asamalik% (Adam Šamalík) IRC-kanavalla ja kysy häneltä asiasta.

Want to help? Learn how to contribute to Fedora Docs ›