how-to-add-post.md

Wikiに資料を追加する

必要なもの

• yarn (npmでもいいです)
• git

Getting Started

git clone https://github.com/Sakuten/knowledge-base.git
cd knowledge-base
yarn install --dev

これで環境は構築できました。

下記のコマンドで開発サーバが立ち上がり、レンダリングされたGitBookを見ることができます。

yarn start

項目を追加する

新しく項目を追加するには、通常のbackendやfrontendと同じようにfeatureを切ってPRを出す必要があります。

git flow feature start your-post
# ..
# 資料を書く
# ..
git push origin feature/your-post

PRがマージされると、デプロイされたWikiで追加された項目を見ることができるようになります。お疲れ様でした。

ディレクトリ構造

.
└── docs
    ├── backend         # バックエンド資料
    ├── frontend        # フロントエンド資料
    ├── infrastructure  # インフラ資料
    ├── misc            # その他、使い方など
    └── lecture         # もくもく資料
        └── <title>

資料は適切にフォルダ分けして配置してください。

よくわからなかったら適当なところに置いてくれれば、PRで誰かが適切な場所を選んでくれる気がするので、あんまり悩まないでも大丈夫です。