Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add FAQ page #30

Merged
merged 1 commit into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
- [Terraformガイドライン](./ja/developer_guidelines/terraform_guidelines.md)
- [Terraform Modules](./terraform_modules/README.md)
- [DBスキーマ](./schema/README.md)
- [FAQ](./ja/developer_guidelines/faq.md)

### OpenAPI仕様書

Expand Down
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ By using it in conjunction with various OSS provided by [@oqtopus-team](https://
- [Terraform Guidelines](./en/developer_guidelines/terraform_guidelines.md)
- [Terraform Modules](./terraform_modules/README.md)
- [DB Schema](./schema/README.md)
- [FAQ](./en/developer_guidelines/faq.md)

### OpenAPI Specifications

Expand Down
7 changes: 7 additions & 0 deletions docs/en/developer_guidelines/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# FAQ

This document provides answers to frequently asked questions during development.

Q. Where do I set the initial values for the development environment database?

A. Initialization scripts are provided under `/backend/db/init`. These scripts are executed when starting the local environment database. If you need to set initial values beforehand, please edit these scripts.
1 change: 1 addition & 0 deletions docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ By using it in conjunction with various OSS provided by [@oqtopus-team](https://
- [Terraform Guidelines](./en/developer_guidelines/terraform_guidelines.md)
- [Terraform Modules](./terraform_modules/README.md)
- [DB Schema](./schema/README.md)
- [FAQ](./en/developer_guidelines/faq.md)

### OpenAPI Specifications

Expand Down
8 changes: 8 additions & 0 deletions docs/ja/developer_guidelines/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# FAQ

開発を進めるうえでよくある質問についての回答をまとめています。

Q. 開発環境DBの初期値はどこで設定しますか?

A. `/backend/db/init`配下に初期化用スクリプトを用意しています。ローカル環境のDBを立ち上げる際にこちらのスクリプトが実行されます。
事前に初期値を設定する場合は、このスクリプトを編集してください。
1 change: 0 additions & 1 deletion docs/ja/developer_guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,3 @@ docs: Update README.md

> [!NOTE]
> 上記のようにマージを行うことで、煩雑なコミットが`main`ブランチに残らないため、履歴がシンプルになり、リリース時のトラブルを防ぐことができます。

1 change: 1 addition & 0 deletions docs/ja/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
- [Terraformガイドライン](./ja/developer_guidelines/terraform_guidelines.md)
- [Terraform Modules](./terraform_modules/README.md)
- [DBスキーマ](./schema/README.md)
- [FAQ](./ja/developer_guidelines/faq.md)

### OpenAPI仕様書

Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ nav:
- devices: schema/devices.md
- results: schema/results.md
- tasks: schema/tasks.md
- FAQ: developer_guidelines/faq.md
- OpenAPI Specification:
- User API: oas/user/README.md
- Provider API: oas/provider/README.md
Expand Down Expand Up @@ -94,6 +95,7 @@ plugins:
Terraform Guidelines: Terraformガイドライン
Terraform Modules: Terraformモジュール
DB Schema: DBスキーマ
FAQ: FAQ

OpenAPI Specification: OpenAPI仕様書
UserAPI: ユーザーAPI
Expand Down
Loading