Revisions rev11

TAEKO AKATSUKA
カテゴリ内READMEのデザイン変更にともない、スクショや説明を変更しました
Updated by taea 2020-10-08 15:03:04 +0900
  • ## READMEとは?
  • <img width="3516" alt="image.png (1.8 MB)" src="https://img.esa.io/uploads/production/attachments/105/2020/09/07/2/e441dda3-b61c-428b-b37d-c7b77e740c6d.png">
  • - __README__ とは、チームのHome( `https://TEAM.esa.io/`)のページの中央部に表示されるコンテンツです。
  • - チーム作成時に __README.md__ というタイトルの記事があらかじめ用意されており(上記画像参照)、この記事を __Edit__ ボタンから自由に編集することができます。
  • - チームでよく使うページのリンク等、頻繁に必要になる情報を README に書いておくと、より便利にesaを使うことができます。
  • - すでに設定してあるREADMEの記事を削除してしまった場合は、新たに "README" ではじまるタイトルの記事(カテゴリなし)を作ると、自動的に Homeに設定されます
  • ## カテゴリのREADME
  • - READMEは、チームのHomeだけではなく、各カテゴリにも設定できます。
  • - `カテゴリ名/README` というタイトルで記事を作成すると、その記事がカテゴリのREADMEとして設定されます。
  • - カテゴリのREADMEは、カテゴリページ左側のメニュー内で、対象カテゴリのすぐ下に表示され"README" をクリックすると表示できます。
  • - <img width="2612" alt="image.png (1.3 MB)" src="https://img.esa.io/uploads/production/attachments/105/2020/09/07/2/d2f282b2-c465-4d10-814d-929b6be02678.png">
  • - カテゴリのREADMEは、カテゴリページの上部に一定の高さにで省略された状態で表示され、その場でスクロールして全文を見ることができます。
  • - または左上の"README"のタイトルをクリックして、元の記事を参照することもできます。
  • - <img width="2222" alt="image.png (452.4 kB)" src="https://img.esa.io/uploads/production/attachments/105/2020/10/08/2/931be58e-02cf-4b11-8aee-11af9c9e63d1.png">
  • ## README に書いておくと便利な情報の例
  • - チームや会社でよく使う情報
  • - 会社の住所や基本情報 等
  • - チーム全員に共通するワークフローや決まり 等
  • - チームでesaの記事の書き方やカテゴリの作り方等に決まりがある場合にも、READMEに書いておくか、説明ページへのリンクを張っておくと便利です
  • - よく使うページへのリンク
  • - 開発中のプロダクトのリンク
  • - チームで使っている外部Webサービスへのリンク
  • - esaのオススメ便利URL
  • - 特定のテンプレートを使って新規記事を作成する("日報を書く" などのリンクに使えます): `/posts/new?template_post_id=[テンプレートの記事番号]`

READMEとは?

image.png (1.8 MB)
  • README とは、チームのHome( https://TEAM.esa.io/)のページの中央部に表示されるコンテンツです。
  • チーム作成時に README.md というタイトルの記事があらかじめ用意されており(上記画像参照)、この記事を Edit ボタンから自由に編集することができます。
  • チームでよく使うページのリンク等、頻繁に必要になる情報を README に書いておくと、より便利にesaを使うことができます。
  • すでに設定してあるREADMEの記事を削除してしまった場合は、新たに "README" ではじまるタイトルの記事(カテゴリなし)を作ると、自動的に Homeに設定されます

カテゴリのREADME

  • READMEは、チームのHomeだけではなく、各カテゴリにも設定できます。
  • カテゴリ名/README というタイトルで記事を作成すると、その記事がカテゴリのREADMEとして設定されます。
  • カテゴリのREADMEは、カテゴリページ左側のメニュー内で、対象カテゴリのすぐ下に表示される"README"カテゴリのREADMEは、カテゴリページの上部に一定の高さにで省略された状態で表示され、その場でスクロールして全文を見ることができます。 をクリックすると表示できます。
    • image.png (1.3 MB)または左上の"README"のタイトルをクリックして、元の記事を参照することもできます。
    • image.png (452.4 kB)

README に書いておくと便利な情報の例

  • チームや会社でよく使う情報
    • 会社の住所や基本情報 等
    • チーム全員に共通するワークフローや決まり 等
    • チームでesaの記事の書き方やカテゴリの作り方等に決まりがある場合にも、READMEに書いておくか、説明ページへのリンクを張っておくと便利です
  • よく使うページへのリンク
    • 開発中のプロダクトのリンク
    • チームで使っている外部Webサービスへのリンク
  • esaのオススメ便利URL
    • 特定のテンプレートを使って新規記事を作成する("日報を書く" などのリンクに使えます): /posts/new?template_post_id=[テンプレートの記事番号]
## READMEとは?

<img width="3516" alt="image.png (1.8 MB)" src="https://img.esa.io/uploads/production/attachments/105/2020/09/07/2/e441dda3-b61c-428b-b37d-c7b77e740c6d.png">

- __README__ とは、チームのHome( `https://TEAM.esa.io/`)のページの中央部に表示されるコンテンツです。
- チーム作成時に __README.md__ というタイトルの記事があらかじめ用意されており(上記画像参照)、この記事を __Edit__ ボタンから自由に編集することができます。
- チームでよく使うページのリンク等、頻繁に必要になる情報を README に書いておくと、より便利にesaを使うことができます。
- すでに設定してあるREADMEの記事を削除してしまった場合は、新たに "README" ではじまるタイトルの記事(カテゴリなし)を作ると、自動的に Homeに設定されます

## カテゴリのREADME

- READMEは、チームのHomeだけではなく、各カテゴリにも設定できます。
- `カテゴリ名/README` というタイトルで記事を作成すると、その記事がカテゴリのREADMEとして設定されます。
- カテゴリのREADMEは、カテゴリページの上部に一定の高さにで省略された状態で表示され、その場でスクロールして全文を見ることができます。
    - または左上の"README"のタイトルをクリックして、元の記事を参照することもできます。
    - <img width="2222" alt="image.png (452.4 kB)" src="https://img.esa.io/uploads/production/attachments/105/2020/10/08/2/931be58e-02cf-4b11-8aee-11af9c9e63d1.png">


## README に書いておくと便利な情報の例

- チームや会社でよく使う情報
    - 会社の住所や基本情報 等
    - チーム全員に共通するワークフローや決まり 等
    - チームでesaの記事の書き方やカテゴリの作り方等に決まりがある場合にも、READMEに書いておくか、説明ページへのリンクを張っておくと便利です
- よく使うページへのリンク
    - 開発中のプロダクトのリンク
    - チームで使っている外部Webサービスへのリンク
-  esaのオススメ便利URL
    - 特定のテンプレートを使って新規記事を作成する("日報を書く" などのリンクに使えます): `/posts/new?template_post_id=[テンプレートの記事番号]`

READMEとは?

image.png (1.8 MB)
  • README とは、チームのHome( https://TEAM.esa.io/)のページの中央部に表示されるコンテンツです。
  • チーム作成時に README.md というタイトルの記事があらかじめ用意されており(上記画像参照)、この記事を Edit ボタンから自由に編集することができます。
  • チームでよく使うページのリンク等、頻繁に必要になる情報を README に書いておくと、より便利にesaを使うことができます。
  • すでに設定してあるREADMEの記事を削除してしまった場合は、新たに "README" ではじまるタイトルの記事(カテゴリなし)を作ると、自動的に Homeに設定されます

カテゴリのREADME

  • READMEは、チームのHomeだけではなく、各カテゴリにも設定できます。
  • カテゴリ名/README というタイトルで記事を作成すると、その記事がカテゴリのREADMEとして設定されます。
  • カテゴリのREADMEは、カテゴリページの上部に一定の高さにで省略された状態で表示され、その場でスクロールして全文を見ることができます。
    • または左上の"README"のタイトルをクリックして、元の記事を参照することもできます。
    • image.png (452.4 kB)

README に書いておくと便利な情報の例

  • チームや会社でよく使う情報
    • 会社の住所や基本情報 等
    • チーム全員に共通するワークフローや決まり 等
    • チームでesaの記事の書き方やカテゴリの作り方等に決まりがある場合にも、READMEに書いておくか、説明ページへのリンクを張っておくと便利です
  • よく使うページへのリンク
    • 開発中のプロダクトのリンク
    • チームで使っている外部Webサービスへのリンク
  • esaのオススメ便利URL
    • 特定のテンプレートを使って新規記事を作成する("日報を書く" などのリンクに使えます): /posts/new?template_post_id=[テンプレートの記事番号]