[incubator-devlake-website] 06/06: enhanced GettingStarted manuals

[yu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git

commit 0efe1466e2469ba0b8ceb9d48508ff4fe27acd48
Author: Keon Amini <ke...@skael.com>
AuthorDate: Thu Aug 25 20:16:38 2022 -0500

    enhanced GettingStarted manuals
---
 docs/GettingStarted/DockerComposeSetup.md | 4 ++--
 docs/GettingStarted/HelmSetup.md          | 1 +
 docs/GettingStarted/KubernetesSetup.md    | 1 +
 docs/GettingStarted/TemporalSetup.md      | 4 ++--
 docs/UserManuals/ConfigUI/GitHub.md       | 2 +-
 5 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/docs/GettingStarted/DockerComposeSetup.md b/docs/GettingStarted/DockerComposeSetup.md
index bde5053e..c17bb9f5 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -16,13 +16,13 @@ sidebar_position: 1
 - Commands written `like this` are to be run in your terminal.
 
 1. Download `docker-compose.yml` and `env.example` from [latest release page](https://github.com/apache/incubator-devlake/releases/latest) into a folder.
-2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal.
+2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. This file contains the environment variables that the Devlake server will use. Additional ones can be found in the compose file(s).
 3. Run `docker-compose up -d` to launch DevLake.
 
 ## Configure and collect data
 
 1. Visit `config-ui` at `http://localhost:4000` in your browser to configure and collect data.
-   - Please follow the [turorial](UserManuals/ConfigUI/Tutorial.md)
+   - Please follow the [tutorial](UserManuals/ConfigUI/Tutorial.md)
    - `devlake` takes a while to fully boot up. if `config-ui` complaining about api being unreachable, please wait a few seconds and try refreshing the page.
 2. Click *View Dashboards* button in the top left when done, or visit `localhost:3002` (username: `admin`, password: `admin`).
    - We use [Grafana](https://grafana.com/) as a visualization tool to build charts for the [data](../SupportedDataSources.md) stored in our database.
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index c8747f05..e8920b4a 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -99,6 +99,7 @@ Some useful parameters for the chart, you could also check them in values.yaml
 | lake.image.repository  | repository for lake's image | mericodev/lake  |
 | lake.image.tag  | image tag for lake's image | latest  |
 | lake.image.pullPolicy  | pullPolicy for lake's image | Always  |
+| lake.loggingDir | the root logging directory of Devlake | /app/logs | 
 | ui.image.repository  | repository for ui's image | mericodev/config-ui  |
 | ui.image.tag  | image tag for ui's image | latest  |
 | ui.image.pullPolicy  | pullPolicy for ui's image | Always  |
diff --git a/docs/GettingStarted/KubernetesSetup.md b/docs/GettingStarted/KubernetesSetup.md
index b074dfa0..f87d5ac1 100644
--- a/docs/GettingStarted/KubernetesSetup.md
+++ b/docs/GettingStarted/KubernetesSetup.md
@@ -27,6 +27,7 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak
      * `ADMIN_USER`/`ADMIN_PASS`: Not required, but highly recommended
    - Settings used by `devlake`:
      * `DB_URL`: update this value if  `MYSQL_USER`, `MYSQL_PASSWORD` or `MYSQL_DATABASE` were changed
+     * `LOGGING_DIR`: the directory of logs for Devlake - you likely don't need to change it.
 3. The `devlake` deployment store its configuration in `/app/.env`. In our sample yaml, we use `hostPath` volume, so please make sure directory `/var/lib/devlake` exists on your k8s workers, or employ other techniques to persist `/app/.env` file. Please do NOT mount the entire `/app` directory, because plugins are located in `/app/bin` folder.
 4. Finally, execute the following command and DevLake should be up and running:
    ```sh
diff --git a/docs/GettingStarted/TemporalSetup.md b/docs/GettingStarted/TemporalSetup.md
index c5b91c61..58132999 100644
--- a/docs/GettingStarted/TemporalSetup.md
+++ b/docs/GettingStarted/TemporalSetup.md
@@ -31,5 +31,5 @@ But, be careful, many API services like JIRA/GITHUB have a request rate limit me
 
 ### How to setup
 
-1. Clone and fire up  [temporalio](https://temporal.io/) services
-2. Clone this repo, and fire up DevLake with command `docker-compose -f docker-compose-temporal.yml up -d`
\ No newline at end of file
+1. Clone and fire up the [temporalio](https://temporal.io/) services
+2. Clone this repo, and fire up DevLake with command `docker-compose -f deployment/temporal/docker-compose-temporal.yml up -d`
\ No newline at end of file
diff --git a/docs/UserManuals/ConfigUI/GitHub.md b/docs/UserManuals/ConfigUI/GitHub.md
index d775f7b1..aaae0da2 100644
--- a/docs/UserManuals/ConfigUI/GitHub.md
+++ b/docs/UserManuals/ConfigUI/GitHub.md
@@ -33,7 +33,7 @@ Click `Test Connection`, if the connection is successful, click `Save Connection
 Enter the GitHub repos to collect. If you want to collect more than 1 repo, please separate repos with comma. For example, "apache/incubator-devlake,apache/incubator-devlake-website".
 
 #### Data Entities
-Usually, you don't have to modify this part. However, if you don't want to collect certain GitHub entities, you can unselect some entities to accerlerate the collection speed.
+Usually, you don't have to modify this part. However, if you don't want to collect certain GitHub entities, you can unselect some entities to accelerate the collection speed.
 - Issue Tracking: GitHub issues, issue comments, issue labels, etc.
 - Source Code Management: GitHub repos, refs, commits, etc.
 - Code Review: GitHub PRs, PR comments and reviews, etc.