Hissa qo'shish bo'yicha ko'rsatmalar

Hujjatlarga qanday hissa qo’shish

Ushbu asosiy namuna ko’rsatmalar sizning Docsy saytingiz Netlify yordamida joylashtirilib, fayllaringiz GitHub da saqlanishi haqida taxmin qiladi. Siz ko’rsatmalarni “o’zi kabi” ishlatishingiz yoki o’z ko’rsatmalaringiz bilan moslashtira olasiz: masalan, boshqa joylashtirish variantlari, hujjat loyihangizning fayl tuzilishi haqida ma’lumot, loyihaga xos ko’rib chiqish ko’rsatmalari, versiya ko’rsatmalari yoki foydalanuvchilaringiz saytingizni yangilashda foydali deb bilishi mumkin bo’lgan boshqa ma’lumotlar. Kubeflow da ajoyib misol bor.

Bizning misol saytimizga emas, balki o’z hujjat repongizga havola qilishni unutmang! Shuningdek, foydalanuvchilaringiz bu ko’rsatmalarni hujjat repo README dan topa olishlarini ta’minlang: ularni u yerga qo’shing va bu sahifadan ularga havola qiling, yoki ularni bu yerga qo’shing va README dan ularga havola qiling, yoki ularni ikkala joyga ham qo’shing.

Biz veb-saytimizni formatlash va yaratish uchun Hugo dan, stil va sayt tuzilishi uchun Docsy mavzusidan va saytni joylashtirish boshqaruvini Netlify dan foydalanamiz. Hugo bizga shablonlar, standart katalog tuzilishida kontent tashkiloti va veb-sayt yaratish mexanizmini taqdim etuvchi ochiq manbali statik sayt generatoridir. Siz sahifalarni Markdown (yoki agar xohlasangiz HTML) da yozasiz va Hugo ularni veb-saytga o’rab oladi.

Loyiha a’zolari tomonidan yuborilganlar ham, barcha taqdimotlar ko’rib chiqishni talab qiladi. Biz buning uchun GitHub pull requestlaridan foydalanamiz. Pull requestlardan foydalanish haqida ko’proq ma’lumot olish uchun GitHub Help ni ko’ring.

Netlify bilan tez boshlash

Mana hujjatlarni yangilash bo’yicha tezkor qo’llanma. Bu siz GitHub workflow bilan tanish ekanligingizni va hujjat yangilanishlaringizning avtomatlashgan ko’rib chiqishidan foydalanishni xohlayotganingizni nazarda tutadi:

  1. GitHub da Goldydocs repo ni fork qiling.
  2. O’zgarishlaringizni qiling va pull request (PR) yuboring.
  3. Agar hali ko’rib chiqishga tayyor bo’lmasangiz, ish jarayonida ekanligini bildirish uchun PR nomiga “WIP” qo’shing. (Sahifa front matter ga Hugo “draft = true” xususiyatini qo’shmang, chunki bu keyingi punktda tasvirlangan kontent preview ning avtomatik joylashtirish ishini to’xtatadi.)
  4. Avtomatlashgan PR workflow ba’zi tekshiruvlarni bajarishini kuting. Tayyor bo’lgach, siz shunday izoh ko’rishingiz kerak: deploy/netlify — Deploy preview ready!
  5. Yangilanishlaringizning previewini ko’rish uchun “Deploy preview ready” ning o’ng tomonidagi Details tugmasini bosing.
  6. Kontent bilan qoniqguningizcha hujjatingizni yangilashni va o’zgarishlaringizni yuklashni davom ettiring.
  7. Ko’rib chiqish uchun tayyor bo’lganingizda, PR ga izoh qo’shing va “WIP” belgilarini olib tashlang.

Bitta sahifani yangilash

Agar siz hujjatlardan foydalanayotganda o’zgartirishni xohlagan narsani topgan bo’lsangiz, Docsy sizning uchun yorliq yo’l bor:

  1. Sahifaning yuqori o’ng burchagidagi Ushbu sahifani tahrirlash tugmasini bosing.
  2. Agar sizda loyiha reposining eng so’nggi fork mavjud bo’lmasa, uni olish uchun taklif qilinadi - loyihaning eng so’nggi versiyasini tahrirlash uchun Fork this repository and propose changes yoki Update your Fork tugmasini bosing. Sizning forkingizda tegishli sahifa tahrirlash rejimida ko’rsatiladi.
  3. O’zgarishlarni qilish, ko’rib chiqish va taklif qilish uchun yuqoridagi Netlify bilan tez boshlash jarayonining qolgan qismini kuzatib boring.

O’zgarishlaringizni mahalliy ko’rib chiqish

Agar ishlayotganingizda o’zgarishlaringizni ko’rib chiqish uchun o’z mahalliy Hugo serveringizni ishga tushirishni xohlasangiz:

  1. Hugo va kerak bo’lgan boshqa vositalarni o’rnatish uchun Boshlash dagi ko’rsatmalarga amal qiling. Sizga kamida Hugo versiya 0.146.0 kerak bo’ladi (biz eng so’nggi mavjud versiyadan foydalanishni tavsiya qilamiz) va u SCSS ni qo’llab-quvvatlaydigan extended versiyasi bo’lishi kerak.

  2. Goldydocs repo repositoriyasini o’z loyihangizga fork qiling, so’ngra git clone yordamida mahalliy nusxa yarating.

    git clone --branch v0.12.0 --depth 1 https://github.com/google/docsy-example.git

  3. Sayt ildiz katalogida hugo server ni ishga tushiring. Standart bo’yicha saytingiz http://localhost:1313/ da mavjud bo’ladi. Endi siz saytingizni mahalliy xizmat qilayotganingiz uchun, Hugo kontentdagi o’zgarishlarni kuzatib boradi va saytingizni avtomatik ravishda yangilaydi.

  4. Fayllarni tahrirlash, ularni commit qilish, o’zgarishlarni forkingizga yuklash va pull request yaratish uchun odatiy GitHub workflow bilan davom eting.

Issue yaratish

Agar siz hujjatlarda muammo topdingiz, lekin uni qanday o’zingiz hal qilishni bilmasangiz, Goldydocs repo da issue yarating. Shuningdek, sahifaning yuqori o’ng burchagidagi Create Issue tugmasini bosib, muayyan sahifa haqida issue yaratishingiz mumkin.

Foydali resurslar


Last modified 21.09.212149: add files (4f90394)