Пропозиції щодо покращення вмісту
Якщо ви помітили проблему в документації Kubernetes або маєте ідею для нового вмісту, створіть тікет. Усе, що вам потрібно, — обліковий запис GitHub і браузер.
У більшості випадків нова робота над документацією Kubernetes починається з тікета на GitHub. Потім учасники Kubernetes переглядають, класифікують і позначають тікети мітками за потреби. Далі ви або інший учасник спільноти Kubernetes відкриваєте pull request зі змінами, які розвʼязують проблему.
Створення тікета
Якщо ви хочете запропонувати покращення наявного вмісту або помітили помилку, створіть тікет.
- Натисніть посилання Створити тікет на правій боковій панелі. Вас буде перенаправлено на сторінку тікета на GitHub з попередньо заповненими заголовками.
- Опишіть проблему або пропозицію щодо покращення. Надайте якнайбільше деталей.
- Натисніть Submit new issue.
Після подання час від часу перевіряйте свій тікет або ввімкніть сповіщення GitHub. Рецензенти й інші учасники спільноти можуть поставити запитання, перш ніж зможуть щось зробити з вашим тікетом.
Пропонування нового вмісту
Якщо у вас є ідея для нового вмісту, але ви не впевнені, де його розмістити, ви все одно можете створити тікет. Або:
- Виберіть наявну сторінку в розділі, до якого, на вашу думку, належить вміст, і натисніть Створити тікет.
- Перейдіть на GitHub та створіть тікет там.
Як створювати хороші тікети
Створюючи тікет, памʼятайте таке:
- Надайте чіткий опис проблеми. Опишіть, що саме відсутнє, застаріле, неправильне або потребує покращення.
- Поясніть конкретний вплив проблеми на користувачів.
- Обмежте обсяг тікета розумним обсягом роботи. Великі проблеми розбийте на менші тікети. Наприклад, «Виправити документацію з безпеки» — занадто широко, а «Додати подробиці до теми 'Обмеження доступу до мережі'» — достатньо конкретно, щоб з цим можна було працювати.
- Пошукайте наявні тікети, щоб побачити, чи є щось повʼязане або схоже на новий тікет.
- Якщо новий тікет стосується іншого тікета або pull request, посилайтеся на нього або через повну URL-адресу, або через номер тікета або pull request з префіксом
#. Наприклад, Introduced by #987654. - Дотримуйтеся Кодексу поведінки. Поважайте інших учасників. Наприклад, «Документація жахлива» — це не корисний і не ввічливий відгук.