Skip to content

Commit 2587f91

Browse files
committed
add file to /docs/how-to-add-dojo.md
新規Dojoを追加する際の手順についてまとめました. 開発用の手順書であるため `docs/` 以下に設置しています. close #259
1 parent e2d4954 commit 2587f91

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

docs/how-to-add-dojo.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# 新規Dojoの追加方法
2+
3+
新規Dojoから申請が来た場合の手順書( 2018/02/26現在)
4+
5+
## Dojo DBの追加手順
6+
7+
+ [CoderDojoJapanの申請フォーム](http://goo.gl/forms/UfY69hsA99) に来ている新規Dojoを確認する
8+
+ 申請結果には個人情報が含まれるため、一般公開されていません :secret:
9+
+ `db/dojos.yaml` 以下に次のようなtemplateで追記する
10+
+ 追記場所は都道府県で順で追加することが好ましい
11+
12+
```yaml
13+
- created_at: '2016-12-19'
14+
order: '473251'
15+
name: 嘉手納 (沖縄)
16+
prefecture_id: 47
17+
logo: "/img/dojos/kadena.png"
18+
url: http://coderdojokadena.hatenablog.jp/
19+
description: 沖縄県中頭郡で毎月開催
20+
tags:
21+
- Scratch
22+
- LEGO Mindstorms
23+
- ラズベリーパイ
24+
```
25+
26+
フォームとカラムの対応については以下の通りです
27+
28+
| Dojoカラム | フォーム |
29+
|:-----------------|:------------------:|
30+
| `created_at` | タイムスタンプ |
31+
| `order` | [全国地方公共団体コード] (https://docs.google.com/spreadsheets/d/1b2XZxifpP8GSASvP9sPq1BYwsCH6Y_FHSkol_nfaGxw/edit#gid=1813423171) |
32+
|`name` | 正式名称 |
33+
| `prefecture_id` | `db/seeds.rb` の該当番号 |
34+
|`logo` | `public/` のDojo画像パス |
35+
| `url` | イベントの管理ページ (個別イベントURLではない) |
36+
| `description` |フォーム `Dojoの開催場所と開催頻度について教えてください` |
37+
|`tags` | フォーム `Dojo で対応可能な技術を教えてください (最大5つまで)`|
38+
39+
40+
- ここまで記述した後に `be rails dojos:update_db_by_yaml` を実行しdbに新規Dojoを反映する
41+
- その後 `be rails dojos:migrate_adding_id_to_yaml`  を実行し,yamlにidが動的に付けられた事を確認する
42+
43+
### 関連issue
44+
45+
- https://github.com/coderdojo-japan/coderdojo.jp/issues/219
46+
47+
## 集計対象の追加
48+
49+
- 集計対象は `db/dojo_event_services.yaml` で管理をしている為ここに追記をする
50+
51+
```yaml
52+
- dojo_id: 131
53+
name: facebook
54+
group_id: 209274086317393
55+
url: https://www.facebook.com/CoderDojoTottori/
56+
```
57+
58+
59+
| yaml | 内容 |
60+
|:-----------------|:------------------:|
61+
| `dojo_id` | 該当するDojoのid |
62+
| `name` | 設定するイベント管理サービスの名前 (connpass,facebook, doorkeeper) |
63+
| `group_id` | イベント管理ページのid |
64+
| `url` | イベント管理ページのURL |
65+
66+
- `group_id` についてはFaceBookの場合 [lookup-id](https://lookup-id.com/#) で確認できる
67+
68+
- 本番環境についてはTravise.ciがよしなにやってくれる。

0 commit comments

Comments
 (0)