This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 757ba5e645 fix: content to upgrade DevLake (#513)
757ba5e645 is described below
commit 757ba5e645e593854d1cdbd66966cc25d503c8b8
Author: Louis.z <[email protected]>
AuthorDate: Sat May 6 22:29:43 2023 +0800
fix: content to upgrade DevLake (#513)
* fix: content to upgrade DevLake
* fix: add steps to upgrade by docker-compose
* fix: add steps to upgrade by docker-compose
* fix: add backquotes back
* fix: add back backquotes in v0.16
---------
Co-authored-by: Startrekzky <[email protected]>
---
docs/GettingStarted/DockerComposeSetup.md | 14 +++++++-------
docs/GettingStarted/HelmSetup.md | 2 ++
docs/GettingStarted/Upgrade.md | 2 +-
.../version-v0.16/GettingStarted/DockerComposeSetup.md | 14 ++++++++------
versioned_docs/version-v0.16/GettingStarted/HelmSetup.md | 1 +
.../version-v0.16}/GettingStarted/Upgrade.md | 2 +-
6 files changed, 20 insertions(+), 15 deletions(-)
diff --git a/docs/GettingStarted/DockerComposeSetup.md
b/docs/GettingStarted/DockerComposeSetup.md
index b9ca58f5d1..cd487b4de6 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -12,26 +12,26 @@ sidebar_position: 1
## Launch DevLake
-Commands written `like this` are to be run in your terminal.
-
1. Download `docker-compose.yml` and `env.example` from the [latest
release](https://github.com/apache/incubator-devlake/releases/tag/v0.16.1-beta1)
into a folder.
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` if the version of Docker Desktop is too low to
use `docker compose up -d`.
## Collect data and view dashboards
-1. Visit `config-ui` at `http://localhost:4000` in your browser to configure
DevLake and collect data.
+1. Visit "config-ui" at `http://localhost:4000` in your browser to configure
DevLake and collect data.
- Please follow the [tutorial](Configuration/Tutorial.md)
- - `devlake` container takes a while to fully boot up. If `config-ui`
complains about API being unreachable, please wait a few seconds and refresh
the page.
-2. To view dashboards, click _View Dashboards_ button in the top left corner,
or visit `localhost:3002` (username: `admin`, password: `admin`).
+ - "devlake" container takes a while to fully boot up. If "config-ui"
complains about API being unreachable, please wait a few seconds and refresh
the page.
+2. To view dashboards, click _View Dashboards_ button in the top left corner,
or visit `localhost:3002` (username: "admin", password: "admin").
- We use [Grafana](https://grafana.com/) to visualize the DevOps
[data](/Overview/SupportedDataSources.md) and build dashboards.
- For how to customize and provision dashboards, please see our [Grafana
doc](../Configuration/Dashboards/GrafanaUserGuide.md).
## Upgrade to a newer version
-Support for database schema migration was introduced to DevLake in v0.10.0.
From v0.10.0 onwards, users can upgrade their instance smoothly to a newer
version. However, versions prior to v0.10.0 do not support upgrading to a newer
version with a different database schema.
+1. Run `docker-compose down` to stop services;
+2. Open file "docker-compose.yml". Change the image tags of "grafana",
"devlake" and "config-ui" to the new version, and save;
+3. Run `docker-compose up -d` start DevLake services.
-<br/>
+Please check the [upgrade doc](Upgrade.md) for more information.
## FAQ
### Can I use a managed cloud database service instead of running database in
Docker?
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index eb67285447..2dbefd4bfd 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -50,6 +50,8 @@ helm repo update
helm upgrade --install devlake devlake/devlake --version=0.16.1-beta1
```
+Please check the [upgrade doc](Upgrade.md) for more information.
+
### Uninstall
To uninstall/delete the `devlake` release:
diff --git a/docs/GettingStarted/Upgrade.md b/docs/GettingStarted/Upgrade.md
index dc836933c6..7709a48f9b 100644
--- a/docs/GettingStarted/Upgrade.md
+++ b/docs/GettingStarted/Upgrade.md
@@ -1,6 +1,6 @@
---
title: "Upgrade"
-sidebar_position: 9
+sidebar_position: 3
description: How to upgrade your Apache DevLake to a newer version
---
diff --git a/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
b/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
index bf2184856f..0261b609b6 100644
--- a/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.16/GettingStarted/DockerComposeSetup.md
@@ -12,7 +12,7 @@ sidebar_position: 1
## Launch DevLake
-Commands written `like this` are to be run in your terminal.
+Commands written `like this` are to be run in your terminal or pasted in the
web browser.
1. Download `docker-compose.yml` and `env.example` from the [latest
release](https://github.com/apache/incubator-devlake/releases/tag/v0.16.1-beta1)
into a folder.
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).
@@ -20,18 +20,20 @@ Commands written `like this` are to be run in your terminal.
## Collect data and view dashboards
-1. Visit `config-ui` at `http://localhost:4000` in your browser to configure
DevLake and collect data.
+1. Visit "config-ui" at `http://localhost:4000` in your browser to configure
DevLake and collect data.
- Please follow the [tutorial](Configuration/Tutorial.md)
- - `devlake` container takes a while to fully boot up. If `config-ui`
complains about API being unreachable, please wait a few seconds and refresh
the page.
-2. To view dashboards, click _View Dashboards_ button in the top left corner,
or visit `localhost:3002` (username: `admin`, password: `admin`).
+ - "devlake" container takes a while to fully boot up. If "config-ui"
complains about API being unreachable, please wait a few seconds and refresh
the page.
+2. To view dashboards, click _View Dashboards_ button in the top left corner,
or visit `localhost:3002` (username: "admin", password: "admin").
- We use [Grafana](https://grafana.com/) to visualize the DevOps
[data](/Overview/SupportedDataSources.md) and build dashboards.
- For how to customize and provision dashboards, please see our [Grafana
doc](../Configuration/Dashboards/GrafanaUserGuide.md).
## Upgrade to a newer version
-Support for database schema migration was introduced to DevLake in v0.10.0.
From v0.10.0 onwards, users can upgrade their instance smoothly to a newer
version. However, versions prior to v0.10.0 do not support upgrading to a newer
version with a different database schema.
+1. Run `docker-compose down` to stop services;
+2. Open file "docker-compose.yml". Change the image tags of "grafana",
"devlake" and "config-ui" to the new version, and save;
+3. Run `docker-compose up -d` start DevLake services.
-<br/>
+Please check the [upgrade doc](Upgrade.md) for more information.
## FAQ
### Can I use an external Database service instead of running Database in
Docker?
diff --git a/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
b/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
index 193ca62aad..7fa2668d15 100644
--- a/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.16/GettingStarted/HelmSetup.md
@@ -49,6 +49,7 @@ Grafana URL `http://YOUR-NODE-IP:30091`
helm repo update
helm upgrade --install devlake devlake/devlake --version=0.16.1-beta1
```
+Please check the [upgrade doc](Upgrade.md) for more information.
### Uninstall
diff --git a/docs/GettingStarted/Upgrade.md
b/versioned_docs/version-v0.16/GettingStarted/Upgrade.md
similarity index 99%
copy from docs/GettingStarted/Upgrade.md
copy to versioned_docs/version-v0.16/GettingStarted/Upgrade.md
index dc836933c6..7709a48f9b 100644
--- a/docs/GettingStarted/Upgrade.md
+++ b/versioned_docs/version-v0.16/GettingStarted/Upgrade.md
@@ -1,6 +1,6 @@
---
title: "Upgrade"
-sidebar_position: 9
+sidebar_position: 3
description: How to upgrade your Apache DevLake to a newer version
---
