READMEとは?
-
README とは、チームのHome(
https://TEAM.esa.io/
)のページの中央部に表示されるコンテンツです。
- チーム作成時に README.md というタイトルの記事があらかじめ用意されており(上記画像参照)、この記事を Edit ボタンから自由に編集することができます。
- チームでよく使うページのリンク等、頻繁に必要になる情報を README に書いておくと、より便利にesaを使うことができます。
- すでに設定してあるREADMEの記事を削除してしまった場合は、新たに "README" ではじまるタイトルの記事(カテゴリなし)を作ると、自動的に Homeに設定されます
カテゴリのREADME
- READMEは、チームのHomeだけではなく、各カテゴリにも設定できます。
-
カテゴリ名/README
というタイトルで記事を作成すると、その記事がカテゴリのREADMEとして設定されます。
- カテゴリのREADMEは、カテゴリページの上部に一定の高さにで省略された状態で表示され、その場でスクロールして全文を見ることができます。
- または左上の"README"のタイトルをクリックして、元の記事を参照することもできます。
README に書いておくと便利な情報の例
- チームや会社でよく使う情報
- 会社の住所や基本情報 等
- チーム全員に共通するワークフローや決まり 等
- チームでesaの記事の書き方やカテゴリの作り方等に決まりがある場合にも、READMEに書いておくか、説明ページへのリンクを張っておくと便利です
- よく使うページへのリンク
- 開発中のプロダクトのリンク
- チームで使っている外部Webサービスへのリンク
- esaのオススメ便利URL
- 特定のテンプレートを使って新規記事を作成する("日報を書く" などのリンクに使えます):
/posts/new?template_post_id=[テンプレートの記事番号]