hezyin commented on code in PR #463:
URL:
https://github.com/apache/incubator-devlake-website/pull/463#discussion_r1130547058
##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -34,11 +34,11 @@ Support for database schema migration was introduced to
DevLake in v0.10.0. From
<br/>
## FAQ
-### Can I use an external Database service instead of running Database in
Docker?
+### Can I use a managed Cloud database service instead of running database in
Docker??
Review Comment:
There's an extra "?"
##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -34,11 +34,11 @@ Support for database schema migration was introduced to
DevLake in v0.10.0. From
<br/>
## FAQ
-### Can I use an external Database service instead of running Database in
Docker?
+### Can I use a managed Cloud database service instead of running database in
Docker??
- Yes, you can simply comment out the 'mysql' part in 'docker-compose.yml'
and update some configurations in '.env' before you run docker compose up -d,
here are the steps:
+Yes, you can simply comment out the 'mysql' part in 'docker-compose.yml' and
update some configurations in '.env' before you run docker compose up -d, here
are the steps:
Review Comment:
=> "Yes, please follow the steps below:" (this is to simplify this
paragraph, otherwise you also need to mention the changes in the 'grafana'
section)
##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -80,12 +89,11 @@
DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&p
# collation-server=utf8mb4_bin
```
-
-5. Final step: `docker compose up -d`
+6. Final step: `docker compose up -d`
### Can I use an external Grafana instead of running Grafana in Docker?
Review Comment:
I think it's missing two steps:
1. How do users connect their own Grafana to our database?
2. How do they import JSON dashboards to their Grafana instance?
##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -57,21 +57,30 @@ Support for database schema migration was introduced to
DevLake in v0.10.0. From
--collation-server=utf8mb4_bin
```
-2. Comment out the 'mysql' volume:
+2. Comment out the 'mysql' volume in `docker-compose.yml`:
```yaml
volumes:
mysql-storage:
```
-3. Comment out the 'depends_on mysql' part:
+3. Comment out the 'depends_on mysql' part in `docker-compose.yml`:
```yaml
depends_on:
- mysql
```
-4. Set DB_URL to your own DB_URL in .env
+4. Edit `MYSQL_*` inside 'grafana.environment' part in `docker-compose.yml`:
+
+```yaml
+ MYSQL_URL: DB_URL:DB_PORT
Review Comment:
@warren830 For each of these env vars, please let users know what they need
to provide. Feel free to use
https://devlake.apache.org/docs/GettingStarted/HelmSetup#faq as a reference.
##########
versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md:
##########
@@ -36,11 +36,11 @@ Support for database schema migration was introduced to
DevLake in v0.10.0. From
<br/>
## FAQ
-### Can I use an external Database service instead of running Database in
Docker?
Review Comment:
Please replicate all changes to this file as well.
##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -34,11 +34,11 @@ Support for database schema migration was introduced to
DevLake in v0.10.0. From
<br/>
## FAQ
-### Can I use an external Database service instead of running Database in
Docker?
+### Can I use a managed Cloud database service instead of running database in
Docker??
- Yes, you can simply comment out the 'mysql' part in 'docker-compose.yml'
and update some configurations in '.env' before you run docker compose up -d,
here are the steps:
+Yes, you can simply comment out the 'mysql' part in 'docker-compose.yml' and
update some configurations in '.env' before you run docker compose up -d, here
are the steps:
-1. Comment out mysql part:
+1. Comment out 'mysql' part in `docker-compose.yml`:
Review Comment:
"Comment out 'mysql' part..." => "Comment out the 'mysql' section..."
##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -57,21 +57,30 @@ Support for database schema migration was introduced to
DevLake in v0.10.0. From
--collation-server=utf8mb4_bin
```
-2. Comment out the 'mysql' volume:
+2. Comment out the 'mysql' volume in `docker-compose.yml`:
```yaml
volumes:
mysql-storage:
```
-3. Comment out the 'depends_on mysql' part:
+3. Comment out the 'depends_on mysql' part in `docker-compose.yml`:
```yaml
depends_on:
- mysql
```
-4. Set DB_URL to your own DB_URL in .env
+4. Edit `MYSQL_*` inside 'grafana.environment' part in `docker-compose.yml`:
Review Comment:
=> "4. Provide your managed cloud database connection info in the 'grafana'
section in `docker-compose.yml`"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
