フォーマット標準に従う

このページでは、Istioドキュメントのフォーマット標準を示します。IstioはコンテンツのマークアップにMarkdownを使用し、Webサイトの構築にHugoを使用しています。ドキュメント全体で一貫性を確保するために、これらのフォーマット標準に合意しました。

強調のために大文字を使用しないでください

コードまたは構成ファイル内の元のキャピタライゼーションのみを、それらの値を直接参照する場合に使用してください。参照された値の周りにバッククォート `` を使用して、接続を明示的にします。たとえば、IstioRoleBindingを使用し、Istio Role Bindingやistio role bindingは使用しないでください。

値を直接参照していない場合は、通常の文のキャピタライゼーションを使用します。たとえば、「Istioロールバインディング構成はYAMLファイルで行われます。」

プレースホルダーには山かっこを使用してください

コマンドまたはコードサンプル内のプレースホルダーには山かっこを使用してください。プレースホルダーが何を表すのかを読者に伝えます。例:

1. Display information about a pod:

    {{< text bash >}}
    $ kubectl describe pod <pod-name>
    {{< /text >}}

    Where `<pod-name>` is the name of one of your pods.

ユーザーインターフェース要素を強調するには太字を使用してください

新しい用語を強調するにはイタリックを使用してください

glossショートコードを使用して、新しい用語の用語集エントリを追加します。

ファイル名、ディレクトリ、パスの周りにはバッククォートを使用してください

インラインコードとコマンドの周りにはバッククォートを使用してください

読者が実行することを意図するコマンドにはコードブロックを使用してください。特定のラベル、フラグ、値、関数、オブジェクト、変数、モジュール、またはコマンドを言及する場合にのみ、インラインコードとコマンドを使用してください。

オブジェクトフィールド名の周りにはバッククォートを使用してください