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