図作成ガイドライン
Istio 図ガイドへようこそ！
このガイドは、図形やスタイルを簡単に再利用できるように、SVG ファイルまたはGoogle 図形描画ファイルとして入手できます。これらのガイドラインに従って、Google 図形描画、Inkscape、Illustrator などのベクターグラフィックツールを使用して、Istio ウェブサイト用の SVG 図を作成してください。図のテキストが編集可能な状態であることを確認してください。
私たちの目標は、ウェブサイトのすべての図の整合性を高め、図が明確で、技術的に正確で、アクセス可能であることを保証することです。
テキストを編集可能な状態に保つことで、コミュニティは必要に応じて図を改善および変更することができます。
図を作成するには、次の手順に従います
- ガイドを参照し、必要に応じてコピー＆ペーストします。
- 適切なスタイルの線で図形を接続します。
- 図形と線に、説明的でありながら短いテキストでラベルを付けます。
- 複数回適用されるラベルには、凡例を追加します。
- ドキュメントに図を投稿します。
Google 図形描画で図を作成する場合は、次の手順に従います
- 図を共有ドライブに入れます。
- 図が完成したら、SVG としてエクスポートし、SVG ファイルを PR に含めます。
- Google 図形描画ファイルへの URL を含むコメントを図を含む Markdown ファイルに残します。
図がプロセスを描写している場合は、ステップの説明を図に追加しないでください。代わりに、ステップの番号のみを図に追加し、ステップの説明をドキュメントに番号付きリストとして追加します。リストの番号が図の番号と一致していることを確認してください。このアプローチは、図を理解しやすくし、コンテンツのアクセス性を高めるのに役立ちます。
Istio ドキュメントへの貢献ありがとうございます！
