ファイルの規約

私たちのドキュメントには、ファイルに関するいくつかの規約があります。

命名

新しいファイルを作成する際は、特定の命名規約に従ってください。

ファイル名は以下の条件を満たすべきです：

• ファイルの目的を意味的に伝える
• 小文字である
• 単語の間にダッシュを使用する
• フォルダの下にある単一のファイルにはのみ _index.md を使用する

許可されるファイル名

/fundamentals/concepts/what-is-cloudflare.md
/assets/images/api-shield/api-shield-call-sequence.png

許可されないファイル名

/fundamentals/concepts/What is Cloudflare.md
/fundamentals/concepts/What-is-Cloudflare.md
/fundamentals/concepts/what-is-cloudflare/index.md
/assets/images/api-shield/API_Image_1.png

これらの規約は、ユーザーの可読性、SEOの規約、そして私たちのGitHubアクションが壊れないようにするために重要です。

フォルダ

各フォルダには _index.md という名前のファイルを持つべきです。

/fundamentals/concepts/_index.md

この規約は、私たちの静的サイトジェネレーターである Hugo ↗ がコンテンツを セクション ↗ として扱うことを保証します。 /fundamentals/concepts/_index.md のコンテンツは、https://developers.cloudflare.com/fundamentals/concepts/ でもレンダリングされます。

コンテンツファイル

通常のコンテンツファイルは /content/{product_folder}/ ディレクトリに追加してください。

/content/fundamentals/concepts/what-is-cloudflare.md

画像ファイル

画像ファイルは /assets/images/{product_folder}/ ディレクトリに追加してください。

/assets/images/api-shield/api-shield-call-sequence.png