Внесення нового вмісту

У цьому розділі наведено інформацію, яку слід знати, перш ніж додавати новий вміст.

Також є окремі сторінки про подання прикладів використання і статей для блогу.

Процес внесення нового вмісту

flowchart LR
    subgraph second[Перш ніж розпочати]
    direction TB
    S[ ] -.-
    A[Підпишіть CNCF CLA] --> B[Оберіть гілку Git]
    B --> C[Одна мова на PR]
    C --> F[Ознайомтесь з
інструментами для участі]
    end
    subgraph first[Основи участі]
    direction TB
       T[ ] -.-
       D[Пишіть документи в markdown
та збирайте сайт за допомогою Hugo] --- E[сирці на GitHub]
       E --- G[Тека '/content/../docs' містить документи
для кількох мов]
       G --- H[Ознайомтесь з типом вмісту сторінок Hugo
та shortcodes]
    end

    first ----> second

classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,C,D,E,F,G,H grey
class S,T spacewhite
class first,second white

Схема — підготовка до внесення нового вмісту

На схемі вище показано інформацію, яку слід знати, перш ніж подавати новий вміст. Подробиці наведено нижче.

Основи участі

• Пишіть документацію Kubernetes у Markdown та збирайте сайт Kubernetes за допомогою Hugo.
• Документація Kubernetes використовує CommonMark як свій варіант Markdown.
• Вихідний код розміщено на GitHub. Документацію Kubernetes можна знайти в /content/en/docs/. Частина довідкової документації автоматично генерується скриптами в теці update-imported-docs/.
• Типи контенту сторінок описують подання вмісту документації в Hugo.
• Для внеску в документацію Kubernetes можна використовувати shortcodes Docsy або власні shortcodes Hugo.
• Крім стандартних shortcodes Hugo, ми використовуємо в документації низку власні shortcodes Hugo для керування поданням вмісту.
• Вихідний код документації доступний кількома мовами в /content/. Кожна мова має власну теку з дволітерним кодом, визначеним стандартом ISO 639-1. Наприклад, вихідний код англійської документації зберігається в /content/en/docs/.
• Докладніше про внесок у документацію кількома мовами або початок нового перекладу див. локалізацію.

Перш ніж розпочати

Підпишіть CNCF CLA

Усі учасники Kubernetes мають прочитати Посібник для учасників і підписати Contributor License Agreement (CLA).

Pull request від учасників, які не підписали CLA, не проходять автоматизовані тести. Імʼя та електронна адреса, які ви вказуєте, мають збігатися з тими, що є у вашому git config, а ваші імʼя та електронна адреса в git мають збігатися з тими, що використовуються для CNCF CLA.

Вибір гілки Git

Відкриваючи pull request, потрібно заздалегідь знати, на якій гілці базувати свою роботу.

Якщо ви досі не впевнені, яку гілку вибрати, запитайте в #sig-docs у Slack.

Мови в одному PR

Обмежуйте pull request однією мовою. Якщо потрібно внести однакову зміну в той самий приклад коду кількома мовами, відкрийте окремий PR для кожної мови.

Інструменти для учасників

Тека інструментів для учасників у репозиторії kubernetes/website містить інструменти, які допоможуть вам робити внесок легше.

Що далі

• Прочитайте про подання статей для блогу.