diff --git a/README.md b/README.md index 34e9d19f1..6cf78d820 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Online Conference System written in Ruby on Rails ## About Dreamkast platform -See [Docs](docs/README.md) +See [Notion](https://www.notion.so/cloudnativedays/Dreamkast-Team-bc787244afdc45b880c014bd61891aa8) (Member only) ## Prerequisites diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 19b39ccb3..000000000 --- a/docs/README.md +++ /dev/null @@ -1,15 +0,0 @@ -Dreamkast platform -================== - -
- -
- -|Name|Description|Platform|Repos|Manifest| -|----|----|----|----|----| -|Dreamkast|See [Docs](dreamkast.md)|Kubernetes||| -|Dreamkast UI|See [Docs](dreamkast-ui.md)|Kubernetes||| -|Dreamkast Infra|Dreamkastの各コンポーネントをIaCするリポジトリ。
- Kubernetesマニフェスト
- CloudFormation - AWSリソースの管理
- Terraform - AWS以外のリソースの管理
- Grafana Dashboard||[Repos](https://github.com/cloudnativedaysjp/dreamkast-infra)|-| -|Dreamkast Relasebot|ChatOpsを実現するコンポーネント。Slackで@dreamkast-releasebotを呼び出すことで、各プロダクトをProduction環境にデプロイできる。
言語/Framework: Go / slack-go (RTM)|Kubernetes|[Repos](https://github.com/cloudnativedaysjp/dreamkast-releasebot)|[Manifest](https://github.com/cloudnativedaysjp/dreamkast-infra/tree/main/manifests/app/dreamkast-releasebot)| -|Dreamkast Review App Operator|GitHubのPull Requestをチェックし、新しいPRが出来たらDreamkastのコンポーネント一式を立ち上げる、KubernetesのOperator。
言語/Framework: Go / Kubebuilder|Kubernetes|[Repos](https://github.com/cloudnativedaysjp/reviewapp-operator)|[Manifest](https://github.com/cloudnativedaysjp/dreamkast-infra/tree/main/manifests/infra/reviewapp-operator)| -|Dreamkast API Docs|DreamkastのAPIを定義しているドキュメント。Swaggerを利用している|Kubernetes|[Repos](https://github.com/cloudnativedaysjp/dreamkast-api-docs)|[Manifest](https://github.com/cloudnativedaysjp/dreamkast-infra/tree/main/manifests/app/dreamkast-api-mock/base)| diff --git a/docs/dreamkast-ui.md b/docs/dreamkast-ui.md deleted file mode 100644 index 2b29bbbb5..000000000 --- a/docs/dreamkast-ui.md +++ /dev/null @@ -1,32 +0,0 @@ -Dreamkast UI -============ - -
- -
- -Repository: https://github.com/cloudnativedaysjp/dreamkast-ui/ - -### これは何? - -イベント当日に視聴者が動画配信を視聴するためのアプリケーション。Amazon IVSやVimeoの動画を埋め込み、視聴者に提供する。タブによるUIで簡単にトラックを切り替えられる設計が特徴 - - Next.jsを使っており、TypeScriptで記述されている。 - -- IVS/Vimeoの埋め込み(イベントによって使い分ける) -- タブによるセッション切り替え機能 -- チャット機能 -- スポンサーブース(現状は無効化) - -DreamkastとDreamkast UIの前段にはKubernetes上で稼働しているContourがおり、L7ロードバランスされている。/uiにアクセスしたときはDreamkast UIに繋がるようになっている - -### どこで動いているか - -- EKS(Kubernetes) - -Manifest: https://github.com/cloudnativedaysjp/dreamkast-infra/tree/main/manifests/app/dreamkast - -### 依存しているサービス - -- Dreamkast - REST APIでイベントに関する情報を取得。またイベントの切り替えやチャットをWebSocketを使って通信している -- Karte - 利用者トラッキング diff --git a/docs/dreamkast.md b/docs/dreamkast.md deleted file mode 100644 index 2865393b2..000000000 --- a/docs/dreamkast.md +++ /dev/null @@ -1,81 +0,0 @@ -Dreamkast -========= - -
- -
- -Repository: https://github.com/cloudnativedaysjp/dreamkast/ - -### これは何? - -Ruby on Railsで書かれたDreamkast platformの中核となるコンポーネント。 - - -### 機能 - -- カンファレンス - - カンファレンスのブランドサイト - - 複数のカンファレンスを扱うことができる - - カンファレンスに関するステータスを管理できる - - 参加登録中、開催中、終了、アーカイブ - - Proposalエントリーの有効・無効 - - 参加申し込みの有効・無効 - - タイムテーブルの表示・非表示 - - スポンサーの表示・非表示 - -- 登壇者 - - Call for Proposals - - プロフィール登録 - - Proposalの登録(複数登録可能) - - (admin)各Proposalの採択・非採択を選択する - - (admin) 採択結果の公開 - - 公開時には応募者にメール通知する - - 登壇者用のダッシュボード - -- カンファレンス参加者 - - 各カンファレンスに参加登録する - - 視聴予定セッションを登録する - - タイムテーブル - - (admin) 各セッションの日時・トラックを指定してタイムテーブルを作成する - - セッション情報提供 - - (admin) 参加者へのアナウンス - -- スポンサー - - スポンサー名、URL、ロゴなどをカンファレンスのトップページやイベント当日の配信画面に表示する - - スポンサー用のダッシュボードからスポンサーセッションが登録できる - -- イベント当日 - - 複数トラック - - 任意の数のトラックを用意可能 - - 各トラック毎に個別に配信できる - - トラックの切り替えをスムーズに行うことがで着る - - ライブ配信、もしくは事前録画動画配信 - - 配信はIVSを使用 - - 各セッションをMediaLiveを使って録画、セッション終了後にアーカイブ動画として即公開 - - チャット・QA - - 各セッション毎にチャットルームが用意されており、参加者・登壇者がコミュニケーションできる - - テキスト投稿、複数種類の絵文字投稿が可能 - - 特定のメッセージを親としてスレッドを作れる - - 登壇者の投稿は登壇者とわかるように目立つ見た目になる - - 質問かどうかを指定でき、質問の場合は目立つ見た目になる。また、質問のみ表示するように表示切り替えができる -- APIの提供 - -### どこで動いているか - -- EKS(Kubernetes) - -Manifest: https://github.com/cloudnativedaysjp/dreamkast-infra/tree/main/manifests/app/dreamkast - -### 依存しているサービス - -- EKS(Kubernetes) - 実行環境として -- Auth0 - 認証認可 -- Amazon RDS(MySQL) - DBとして。開発環境ではMySQLのコンテナを利用 -- Amazon S3 - アップロードされた画像の保存先として -- Amazon ElastiCache(Redis) - セッションの保存。開発環境ではRedisのコンテナを利用 -- Amazon SES - メール送信 -- Amazon SQS - チャットやメール送信のキューとして -- Amazon IVS, MediaLive, MediaPackage - 動画配信 -- Sentry - エラートラッキング -- Karte - 利用者トラッキング \ No newline at end of file diff --git a/docs/images/dreamkast-ui.png b/docs/images/dreamkast-ui.png deleted file mode 100644 index af2673795..000000000 Binary files a/docs/images/dreamkast-ui.png and /dev/null differ diff --git a/docs/images/dreamkast.png b/docs/images/dreamkast.png deleted file mode 100644 index 82d56fc0a..000000000 Binary files a/docs/images/dreamkast.png and /dev/null differ diff --git a/docs/images/releasebot.png b/docs/images/releasebot.png deleted file mode 100644 index 9ce1e7899..000000000 Binary files a/docs/images/releasebot.png and /dev/null differ diff --git a/docs/images/reviewapp-operator.png b/docs/images/reviewapp-operator.png deleted file mode 100644 index 479c16e13..000000000 Binary files a/docs/images/reviewapp-operator.png and /dev/null differ