Gidas
Bendruomenės pagalba yra labai laukiama! Nesijaudinkite jeigu turite mažai patirties dirbant su atviro kodo projektais ar git, šiame puslapyje pateikiamos gairės pradedantiesiems.
Kaip galiu padėti?
Pirmiausa - ačiū kad norite padėti šiam projektui augti. Yra daugelis būdų kaip galite prisidėti — papasakokite draugams apie ham.guide, pataisykite gramatines klaidas kurias randate, patikslinkite pasenusią informaciją, išverskite puslapius į kitą kalbą, ar net pridėkite daugiau turinio. Mūsų Github Issue puslapyje ieškokite pranešimų pažymėtų help wanted ir bandykite prisidėti prie jų sprendimo.
Issues
Jeigu turite pasiūlymų, klausimų ar radote klaidų, parašykite pranešimą mūsų Github Issue puslapyje.
Redagavimas pradedantiesiams
Jeigu radote gramatinę klaidą, neteisingą informaciją, ar norėtumėte patikslinti ką nors, atlikite šiuos žingsnius:
- Slinkite iki puslapio, kurį norėtumėte redaguoti, apačios ir spauskite Redaguoti šį puslapį nuorodą. Jūs būsite nukreiptas į Github ir norėdami pateikti pakeitimus, turėsite susikurti paskyrą, jeigu jos dar neturite.
- Prisijungus, spauskite Fork this repository and propose changes mygtuką.
- Atlikite pakeitimus puslapiui ir Propose file change skyriuje paaiškinkite ką ir kodėl pakeitėte.
- Spauskite Propose file change mygtuką ir Create pull request kitame puslapyje.
- Įsitikinkite kad jūsų pull request turi atitinkamą antraštę ir aprašymą ir spauskite Create pull request
Dėkojame, kad tobulinate ham.guide! Mes peržiūrėsime jūsų pakeitimus ir atnaujintą puslapį matysite, kai pakeitimus patvirtinsime. Kartas nuo karto patikrinkite savo pull request — ten galite rasti komentarus ir klausimus susijusius su jūsų pakeitimais.
Redagavimas pažengusiems
Vuepress
Projektas sukurtas naudojant Vuepress.
Paleidimas vietiniame tinkle
Windows
Šiuo atveju rekomenduoju naudoti WSL ir tokiu būdu įdiegti Git ir Node.
MacOS
Įdiekite Git ir Node pagal šias instrukcijas (ar sekite panašų gidą, kurį galite rasti internete).
Linux
Naudodami savo distribucijos paketų tvarkyklę, įsidiekite programas Git ir Node
Taip pat reikės įdiegti Yarn
Kai įdiegsite Git ir Node, klonuokite ham.guide repozitoriją ir sukurkite naują šaką.
Įrašykite būtinus modulius
yarn
- Paleiskite vietinį serverį
yarn dev
Apsilankykite localhost:8080
ir turėtumėte pamatyti ham.guide veikiantį vietiniame tinkle.
Projekto struktūra
.
├── src
│ ├── .vuepress
│ ├── contribute
| ├── phonetic-alphabet
| ├── q-code
| ├── radio-operating-ethics
│ └── lt
│ ├── contribute
│ ├── phonetic-alphabet
│ ├── q-code
│ └── radio-operating-ethics
├── CHANGELOG.md
├── LICENSE
├── package.json
└── README.md
Tai yra supaprastinta projekto struktūros diagrama.
src/
aplanke talpinamas visas svetainės turinys.src/.vuepress
yra Vuepress konfigūracijos ir stilių failai, komponentų ir viešų failų katalogai. Daugiau informacijos apie tai galite rasti Vuepress dokumentacijoje, bet šiems failams retai reikalingos modifikacijos.
.
├── src
│ ├── .vuepress
│ ├── contribute
│ ├── phonetic-alphabet
| ├── q-code
| ├── radio-operating-ethics
│ └── lt
│ ├── contribute
| ├── phonetic-alphabet
| ├── q-code
│ └── radio-operating-ethics
...
Aplankai src/contribute/
ar src/q-code/
yra puslapių arba puslapių grupių aplankai. Puslapis yra aplankas talpinantis vieną README.md
failą. Puslapių grupė yra aplankas turintis README.md
ir kitus .md
failus papildomiems puslapiams.
Perspėjimas
Jeigu norite sukurti naują puslapį ar puslapių grupę, reikės modifikuoti src/.vuepress/config.js
failo themeConfig.locales.sidebar
nustatymą, tam kad jūsų puslapis būtų rodomas navigacijoje. Bandykite tai padaryti pats, naudodami jau aprašytą kodą kaip pavyzdį, tačiau nebijokite prašyti pagalbos mūsų Github puslapyje, jeigu užstrigsite!
.
├── src
│ ├── .vuepress
│ ├── contribute
│ ├── phonetic-alphabet
| ├── q-code
| ├── radio-operating-ethics
│ └── lt
│ ├── contribute
| ├── phonetic-alphabet
| ├── q-code
│ └── radio-operating-ethics
...
Aplankai pavadinti pagal dviejų raidžių šalies kodą yra kalbos aplankai. Numatytoji kalbia šiame projekte yra anglų, todėl src/contribute/
ir src/radio-operating-ethics/
nereikalingas kalbos aplankas. Kitos kalbos privalo turėti kalbos aplanką ir jis turėtų talpinti tuos pačius puslapius ir puslapių grupes kurie yra parašyti anglų kalba.