ドキュメントの執筆

このドキュメントには、Entドキュメントサイトに変更を加える際のガイドラインが記載されています。

Entドキュメントサイトは、プロジェクトのメインの GitHubリポジトリから生成されます。

以下の短いガイドに従って、ドキュメントの改善と追加を行ってください。

セットアップ

1. メインリポジトリを、フォークし、ローカルにクローンしてください

2. ドキュメントサイトでは Docusaurus を使用しています。 実行するには、 Node.js がインストールされている必要があります

3. 依存関係をインストールします

cd doc/website && npm install

4. 開発モードでウェブサイトを実行します

cd doc/website && npm start

5. ブラウザでhttp://localhost:3000 を開きます。

一般的なガイドライン

• ドキュメントのファイルは doc/mdにあり、上部に「フロントマター」スタイルの注釈が付いた Markdown 形式で書かれています。 Docusaurusのフォーマットについてより詳しく知る
• EntはGolang CommitMessageフォーマットを使用して、リポジトリの履歴をきれいに読みやすくしています。 そのため、以下のようなコミットメッセージを使用してください。

doc/md: adding a guide on contribution of docs to ent

新規ドキュメントの追加

1. doc/md ディレクトリに新しい Markdown ファイルを追加します。例えば doc/md/writing-docs.md

2. ファイルは以下のようにフォーマットする必要があります:

---
id: writing-docs
title: Writing Docs
---
...

idはドキュメントのユニークな識別子で、ファイル名から接尾辞.mdを除いたものと同じである必要があります。titleはページ自体やサイト上のナビゲーション要素に表示されるドキュメントのタイトルです。

3. ドキュメントのウェブサイトのサイドバーにページを表示させたい場合は、 id を website/sidebars.jsに追加してください。

{
      type: 'category',
      label: 'Misc',
      items: [
        'templates',
        'graphql',
        'sql-integration',
        'testing',
        'faq',
        'generating-ent-schemas',
        'feature-flags',
        'translations',
        'contributors',
+       'writing-docs',
        'slack'
      ],
      collapsed: false,
    },