Робота з GitHub

Документація Istio слідує стандартній моделі співпраці GitHub для Pull Requests (PR). Ця усталена модель співпраці допомагає відкритим проєктам керувати наступними типами внесків:

• Додавання нових файлів до репозиторію.
• Редагування існуючих файлів.
• Огляд доданих або змінених файлів.
• Керування кількома релізами або гілками розробки.

Посібники з участі припускають, що ви можете виконати наступні завдання:

• Форкнути репозиторій документації Istio.
• Створити гілку для ваших змін.
• Додати коміти до цієї гілки.
• Відкрити PR, щоб поділитися вашим внеском.

Перед початком

Щоб внести зміни в документацію Istio, вам потрібно:

1. Створити обліковий запис GitHub.

2. Підписати Угоду про участь.

3. Встановити Docker, щоб попередньо переглядати та тестувати ваші зміни.

Документація Istio публікується під ліцензією Apache 2.0.

Швидке редагування

Кожен користувач GitHub, який підписав CLA, може внести швидке редагування будь-якої сторінки на вебсайті Istio. Процес дуже простий:

1. Відвідайте сторінку, яку ви хочете редагувати.
2. Додайте preliminary на початку URL. Наприклад, щоб редагувати https://istio.io/about, новий URL має бути https://preliminary.istio.io/about
3. Натисніть значок олівця в нижньому правому куті.
4. Зробіть ваші редагування в інтерфейсі GitHub.
5. Подайте Pull Request з вашими змінами.

Будь ласка, перегляньте наші посібники про те, як вносити новий контент або рецензувати контент, щоб дізнатися більше про подання більш значних змін.

Стратегія гілок

Активний розвиток контенту відбувається за допомогою основної гілки репозиторію istio/istio.io. В день релізу Istio ми створюємо гілку релізу з master для цього релізу. Наступна кнопка веде вас до репозиторію на GitHub:

Переглянути вихідний код цього сайту

Репозиторій документації Istio використовує кілька гілок для публікації документації для всіх релізів Istio. Кожен реліз Istio має відповідну гілку документації. Наприклад, є гілки з назвами release-1.0, release-1.1, release-1.2 і так далі. Ці гілки були створені в день відповідного релізу. Щоб переглянути документацію для конкретного релізу, перегляньте архівну сторінку.

Ця стратегія гілок дозволяє нам надавати такі онлайн-ресурси Istio:

• Публічний сайт показує контент з поточної гілки релізу.

• Попередній сайт на https://preliminary.istio.io показує контент з основної гілки.

• Архівний сайт показує контент з усіх попередніх гілок релізів.

З урахуванням того, як працюють гілки, якщо ви подаєте зміну в основну гілку, ця зміна не зʼявиться на istio.io до наступного великого релізу Istio. Якщо ваша зміна документації стосується поточного релізу Istio, тоді, ймовірно, варто також застосувати вашу зміну до поточної гілки релізу. Ви можете зробити це легко та автоматично, використовуючи спеціальні мітки cherry-pick на вашому PR до документації. Наприклад, якщо ви вносите виправлення в PR до основної гілки, ви можете застосувати мітку cherrypick/release-1.4, щоб обʼєднати цю зміну з гілкою release-1.4.

Коли ваш початковий PR буде обʼєднано, автоматизація створює новий PR в гілці релізу, який включає ваші зміни.

У рідкісних випадках автоматичні cherry-pick не працюють. Коли це трапляється, автоматизація залишає примітку в оригінальному PR, що вказує на те, що вона зазнала невдачі. Коли це трапляється, вам потрібно вручну створити cherry-pick та розвʼязати помилки злиття, які завадили автоматичному процесу.

Зверніть увагу, що ми завжди робимо cherry-pick зміни тільки в поточну гілку релізу, а не в старі гілки. Старі гілки вважаються архівованими та зазвичай не отримують жодних змін.

Ролі в спільноті Istio

Залежно від ваших внесків і обовʼязків, є кілька ролей, які ви можете займати.

Відвідайте нашу сторінку з оглядом ролей щоб дізнатися про ролі, відповідні вимоги та обовʼязки, а також привілеї, повʼязані з ролями.

Відвідайте нашу сторінку спільноти, щоб дізнатися більше про спільноту Istio в цілому.