Інструкції зі створення діаграм
Ласкаво просимо до посібника по діаграмам Istio!
Посібник доступний у форматі SVG або як файл Google Drawings для зручного повторного використання форм і стилів. Використовуйте ці вказівки для створення SVG-діаграм для сайту Istio за допомогою будь-якого інструменту для векторної графіки, такого як Google Drawings, Inkscape або Illustrator. Переконайтеся, що текст у ваших діаграмах залишається редагованим.
Наша мета — забезпечити послідовність усіх діаграм на нашому сайті, щоб діаграми були чіткими, технічно точними та доступними.
Залишаючи текст редагованим, ви дозволяєте спільноті покращувати та змінювати діаграми за потреби.
Щоб створити ваші діаграми, дотримуйтесь цих кроків:
- Ознайомтеся з посібником та скопіюйте з нього за потреби.
- Зʼєднайте форми відповідним стилем ліній.
- Позначте форми та лінії описовим, але коротким текстом.
- Додайте легенду для будь-яких ярликів, що використовуються кілька разів.
- Зробіть внесок у нашу документацію.
Якщо ви створюєте діаграму в Google Drawings, дотримуйтесь цих кроків:
- Помістіть вашу діаграму у наш загальний диск.
- Коли діаграма буде завершена, експортуйте її як SVG і включіть SVG файл у ваш PR.
- Залиште коментар у Markdown-файлі, що містить діаграму, з URL до файлу Google Drawings.
Якщо ваша діаграма зображує процес, не додавайте описи кроків до діаграми. Натомість лише додайте номери кроків до діаграми та додайте описи кроків як нумерований список у документі. Переконайтеся, що номери у списку відповідають номерам на вашій діаграмі. Такий підхід допомагає зробити діаграми зрозумілішими, а контент — більш доступним.
Дякуємо за внесок у документацію Istio!
