You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by he...@apache.org on 2023/02/10 16:22:19 UTC
[incubator-devlake-website] branch main updated: fix: revert v0.15 docs (#428)
This is an automated email from the ASF dual-hosted git repository.
hez 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 f2f6b4631d fix: revert v0.15 docs (#428)
f2f6b4631d is described below
commit f2f6b4631daefb504b209c7f6957984b66b80882
Author: Louis.z <lo...@gmail.com>
AuthorDate: Sat Feb 11 00:22:13 2023 +0800
fix: revert v0.15 docs (#428)
Co-authored-by: Startrekzky <ka...@merico.dev>
---
.../Configuration/Dashboards/_category_.json | 4 ---
.../DataModels/DevLakeDomainLayerSchema.md | 4 +--
.../DeveloperManuals/DeveloperSetup.md | 8 ++---
.../version-v0.15/DeveloperManuals/UnitTest.md | 42 ----------------------
.../GettingStarted/DockerComposeSetup.md | 4 +--
.../version-v0.15/Overview/SupportedDataSources.md | 2 +-
versioned_docs/version-v0.15/Plugins/bitbucket.md | 4 +--
versioned_docs/version-v0.15/Plugins/github.md | 4 +--
versioned_docs/version-v0.15/Plugins/gitlab.md | 4 +--
versioned_docs/version-v0.15/Plugins/jenkins.md | 4 +--
versioned_docs/version-v0.15/Plugins/jira.md | 4 +--
versioned_docs/version-v0.15/Plugins/refdiff.md | 2 +-
versioned_docs/version-v0.15/Plugins/tapd.md | 4 +--
versioned_docs/version-v0.15/Plugins/webhook.md | 4 +--
versioned_docs/version-v0.15/Plugins/zentao.md | 4 +--
.../version-v0.15/Troubleshooting/Configuration.md | 2 +-
.../ConfigUI}/AdvancedMode.md | 4 +--
.../ConfigUI}/BitBucket.md | 2 +-
.../ConfigUI}/GitHub.md | 5 ++-
.../ConfigUI}/GitLab.md | 2 +-
.../ConfigUI}/Jenkins.md | 3 +-
.../ConfigUI}/Jira.md | 2 +-
.../ConfigUI}/Tapd.md | 2 +-
.../ConfigUI}/Tutorial.md | 3 ++
.../ConfigUI}/Zentao.md | 2 +-
.../UserManuals/ConfigUI/_category_.json | 4 +++
.../ConfigUI}/webhook.md | 2 +-
.../version-v0.15/{ => UserManuals}/DORA.md | 10 +++---
.../Dashboards/AccessControl.md | 0
.../Dashboards/GrafanaUserGuide.md | 0
.../UserManuals/Dashboards/_category_.json | 4 +++
.../TeamConfiguration.md | 0
.../{Configuration => UserManuals}/_category_.json | 4 +--
33 files changed, 55 insertions(+), 94 deletions(-)
diff --git a/versioned_docs/version-v0.15/Configuration/Dashboards/_category_.json b/versioned_docs/version-v0.15/Configuration/Dashboards/_category_.json
deleted file mode 100644
index 37da75a8c7..0000000000
--- a/versioned_docs/version-v0.15/Configuration/Dashboards/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Dashboard Configuration",
- "position": 10
-}
diff --git a/versioned_docs/version-v0.15/DataModels/DevLakeDomainLayerSchema.md b/versioned_docs/version-v0.15/DataModels/DevLakeDomainLayerSchema.md
index 78c0539ec8..5450c74868 100644
--- a/versioned_docs/version-v0.15/DataModels/DevLakeDomainLayerSchema.md
+++ b/versioned_docs/version-v0.15/DataModels/DevLakeDomainLayerSchema.md
@@ -498,7 +498,7 @@ A cicd_task is a single job of ci/cd.
### Project Metric Entities
-#### project_pr_metrics
+#### project_pr_metrics
| **field** | **type** | **length** | **description** | **key** |
| :-------- | :-------- |:-----------|:---------------------------------------------------------------------------------------| :-------- |
@@ -666,7 +666,7 @@ import "github.com/apache/incubator-devlake/models/domainlayer/domaininfo"
domaininfo := domaininfo.GetDomainTablesInfo()
for _, table := range domaininfo {
-// do something
+ // do something
}
```
diff --git a/versioned_docs/version-v0.15/DeveloperManuals/DeveloperSetup.md b/versioned_docs/version-v0.15/DeveloperManuals/DeveloperSetup.md
index b228880a1a..064af5109d 100644
--- a/versioned_docs/version-v0.15/DeveloperManuals/DeveloperSetup.md
+++ b/versioned_docs/version-v0.15/DeveloperManuals/DeveloperSetup.md
@@ -23,7 +23,7 @@ The following guide will walk through how to run DevLake's frontend (`config-ui`
1. Navigate to where you would like to install this project and clone the repository:
```sh
- git clone https://github.com/apache/incubator-devlake.git
+ git clone https://github.com/apache/incubator-devlake
cd incubator-devlake
```
@@ -34,9 +34,7 @@ The following guide will walk through how to run DevLake's frontend (`config-ui`
3. Install Go packages
```sh
- cd backend
go get
- cd ..
```
4. Copy the sample config file to new local file:
@@ -69,7 +67,7 @@ The following guide will walk through how to run DevLake's frontend (`config-ui`
For common errors, please see [Troubleshooting](#troubleshotting).
8. Config UI is running at `localhost:4000`
- - For how to use Config UI, please refer to our [tutorial](Configuration/Tutorial.md)
+ - For how to use Config UI, please refer to our [tutorial](UserManuals/ConfigUI/Tutorial.md)
## Running Tests
@@ -99,7 +97,7 @@ All DevLake APIs (core service + plugin API) are documented with swagger. To see
To access Grafana, click *View Dashboards* button in the top left corner of Config UI, or visit `localhost:3002` (username: `admin`, password: `admin`).
-For provisioning, customizing, and creating dashboards, please refer to our [Grafana Doc](../Configuration/Dashboards/GrafanaUserGuide.md).
+For provisioning, customizing, and creating dashboards, please refer to our [Grafana Doc](../UserManuals/Dashboards/GrafanaUserGuide.md).
## Troubleshooting
diff --git a/versioned_docs/version-v0.15/DeveloperManuals/UnitTest.md b/versioned_docs/version-v0.15/DeveloperManuals/UnitTest.md
deleted file mode 100644
index b7599dd26e..0000000000
--- a/versioned_docs/version-v0.15/DeveloperManuals/UnitTest.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-title: "UnitTest Test Guide"
-description: >
- The steps to write UnitTest tests for plugins.
----
-
-# Introduction of UnitTest
-
-A unit test is a type of software testing that tests individual units or components of a software application. The goal of unit testing is to validate that each unit of the software performs as expected. Unit tests are typically written by developers as they work on the code, to ensure that the code they are writing is correct and behaves as intended.
-
-Unit tests are automated and are typically written in the same programming language as the code being tested. They are usually run as part of a continuous integration process, ensuring that changes to the codebase don't break existing functionality.
-
-Unit tests are typically small and focus on a specific function or method of the code. They are usually designed to run quickly and in isolation, so that any issues that are discovered can be easily traced back to the specific code that is causing the problem.
-
-# How to write UnitTest for golang
-
-Here are some resources for writing UnitTest for golang:
-
-- [Add a test - The Go Programming Language](https://go.dev/doc/tutorial/add-a-test)
-
-- [How To Write Unit Tests in Go | DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-write-unit-tests-in-go-using-go-test-and-the-testing-package)
-
-
-# Test case examples
-
-- [Source code](https://github.com/apache/incubator-devlake/blob/243cc8a80aa5b37828e2a142ac9f7e3269b7e1dc/backend/core/migration/migrator_test.go)
-
-# Recommended Libraries for writing UnitTest cases
-
-- [Library-1](https://github.com/stretchr/testify/tree/master/assert)
-- [Library-2](https://github.com/stretchr/testify/tree/master/mock)
-
-
-
-
-
-
-
-
-
-
-
diff --git a/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md b/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
index 00c2f0a8d6..7c592a85f2 100644
--- a/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
@@ -22,11 +22,11 @@ sidebar_position: 1
## Collect data and view dashboards
1. Visit `config-ui` at `http://localhost:4000` in your browser to configure DevLake and collect data.
- - Please follow the [tutorial](Configuration/Tutorial.md)
+ - Please follow the [tutorial](UserManuals/ConfigUI/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`).
- 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).
+ - For how to customize and provision dashboards, please see our [Grafana doc](../UserManuals/Dashboards/GrafanaUserGuide.md).
## Upgrade to a newer version
diff --git a/versioned_docs/version-v0.15/Overview/SupportedDataSources.md b/versioned_docs/version-v0.15/Overview/SupportedDataSources.md
index 20e6fbea3c..5d0669f0eb 100644
--- a/versioned_docs/version-v0.15/Overview/SupportedDataSources.md
+++ b/versioned_docs/version-v0.15/Overview/SupportedDataSources.md
@@ -29,7 +29,7 @@ Apache DevLake(incubating) supports the following data sources. The data from ea
This table shows the entities collected by each plugin. Domain layer entities in this table are consistent with the entities [here](/DataModels/DevLakeDomainLayerSchema.md).
✅ : Collect by default.
-💪 : Collect not by default. You need to add the corresponding subtasks to collect these entities in the [advanced mode](../Configuration/AdvancedMode.md).
+💪 : Collect not by default. You need to add the corresponding subtasks to collect these entities in the [advanced mode](../UserManuals/ConfigUI/AdvancedMode.md).
| Domain Layer Entities | ae | dora | gitextractor | incoming webhook | github | gitlab | jenkins | jira | refdiff | tapd |
| ------------------------------------------------------------------------------------------- | --- | ---- | ------------ | ---------------- | ------ | ------ | ------- | ---- | ------- | ---- |
diff --git a/versioned_docs/version-v0.15/Plugins/bitbucket.md b/versioned_docs/version-v0.15/Plugins/bitbucket.md
index b5a2979391..97e7f2025d 100644
--- a/versioned_docs/version-v0.15/Plugins/bitbucket.md
+++ b/versioned_docs/version-v0.15/Plugins/bitbucket.md
@@ -35,8 +35,8 @@ Metrics that can be calculated based on the data collected from bitbucket:
## Configuration
-- Configuring Bitbucket via [Config UI](/Configuration/BitBucket.md)
-- Configuring Bitbucket via Config UI's [advanced mode](/Configuration/AdvancedMode.md#9-BitBucket).
+- Configuring Bitbucket via [Config UI](/UserManuals/ConfigUI/BitBucket.md)
+- Configuring Bitbucket via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#9-BitBucket).
## API Sample Request
diff --git a/versioned_docs/version-v0.15/Plugins/github.md b/versioned_docs/version-v0.15/Plugins/github.md
index a57adee6bb..f8874548fb 100644
--- a/versioned_docs/version-v0.15/Plugins/github.md
+++ b/versioned_docs/version-v0.15/Plugins/github.md
@@ -56,8 +56,8 @@ Metrics that can be calculated based on the data collected from GitHub:
## Configuration
-- Configuring GitHub via [Config UI](/Configuration/GitHub.md)
-- Configuring GitHub via Config UI's [advanced mode](/Configuration/AdvancedMode.md#1-github).
+- Configuring GitHub via [Config UI](/UserManuals/ConfigUI/GitHub.md)
+- Configuring GitHub via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#1-github).
## API Sample Request
diff --git a/versioned_docs/version-v0.15/Plugins/gitlab.md b/versioned_docs/version-v0.15/Plugins/gitlab.md
index 03dc16925a..f4b5663b7a 100644
--- a/versioned_docs/version-v0.15/Plugins/gitlab.md
+++ b/versioned_docs/version-v0.15/Plugins/gitlab.md
@@ -49,8 +49,8 @@ Metrics that can be calculated based on the data collected from GitLab:
## Configuration
-- Configuring GitLab via [config-ui](/Configuration/GitLab.md).
-- Configuring GitLab via Config UI's [advanced mode](/Configuration/AdvancedMode.md#2-gitlab).
+- Configuring GitLab via [config-ui](/UserManuals/ConfigUI/GitLab.md).
+- Configuring GitLab via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#2-gitlab).
## API Sample Request
diff --git a/versioned_docs/version-v0.15/Plugins/jenkins.md b/versioned_docs/version-v0.15/Plugins/jenkins.md
index 6c2fcfea0a..13ab302736 100644
--- a/versioned_docs/version-v0.15/Plugins/jenkins.md
+++ b/versioned_docs/version-v0.15/Plugins/jenkins.md
@@ -34,8 +34,8 @@ Metrics that can be calculated based on the data collected from Jenkins:
## Configuration
-- Configuring Jenkins via [Config UI](/Configuration/Jenkins.md)
-- Configuring Jenkins via Config UI's [advanced mode](/Configuration/AdvancedMode.md#3-jenkins).
+- Configuring Jenkins via [Config UI](/UserManuals/ConfigUI/Jenkins.md)
+- Configuring Jenkins via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#3-jenkins).
## API Sample Request
diff --git a/versioned_docs/version-v0.15/Plugins/jira.md b/versioned_docs/version-v0.15/Plugins/jira.md
index 88e72e3a1f..ea2ef56d72 100644
--- a/versioned_docs/version-v0.15/Plugins/jira.md
+++ b/versioned_docs/version-v0.15/Plugins/jira.md
@@ -31,8 +31,8 @@ Metrics that can be calculated based on the data collected from Jira:
## Configuration
-- Configuring Jira via [config-ui](/Configuration/Jira.md).
-- Configuring Jira via Config UI's [advanced mode](/Configuration/AdvancedMode.md#4-jira).
+- Configuring Jira via [config-ui](/UserManuals/ConfigUI/Jira.md).
+- Configuring Jira via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#4-jira).
## API Sample Request
diff --git a/versioned_docs/version-v0.15/Plugins/refdiff.md b/versioned_docs/version-v0.15/Plugins/refdiff.md
index 73f7ed1fb3..01be58de5b 100644
--- a/versioned_docs/version-v0.15/Plugins/refdiff.md
+++ b/versioned_docs/version-v0.15/Plugins/refdiff.md
@@ -100,7 +100,7 @@ curl 'http://localhost:8080/pipelines' \
## How to use refdiff in DORA
-RefDiff can be called by the [DORA plugin](https://github.com/apache/incubator-devlake/tree/main/plugins/dora) to support the calculation of [DORA metrics](https://devlake.apache.org/docs/DORA). RefDiff has a subtask called 'calculateProjectDeploymentCommitsDiff'. This subtask takes the `project_name` from task options to calculate the commits diff between two consecutive deployments in this project. That is to say, refdiff will generate the relationship between `deployed commit(s)` and [...]
+RefDiff can be called by the [DORA plugin](https://github.com/apache/incubator-devlake/tree/main/plugins/dora) to support the calculation of [DORA metrics](https://devlake.apache.org/docs/UserManuals/DORA). RefDiff has a subtask called 'calculateProjectDeploymentCommitsDiff'. This subtask takes the `project_name` from task options to calculate the commits diff between two consecutive deployments in this project. That is to say, refdiff will generate the relationship between `deployed com [...]
```shell
curl 'http://localhost:8080/pipelines' \
diff --git a/versioned_docs/version-v0.15/Plugins/tapd.md b/versioned_docs/version-v0.15/Plugins/tapd.md
index d4fa912548..691f7a930d 100644
--- a/versioned_docs/version-v0.15/Plugins/tapd.md
+++ b/versioned_docs/version-v0.15/Plugins/tapd.md
@@ -20,5 +20,5 @@ Metrics that can be calculated based on the data collected from Tapd:
## Configuration
-- Configuring Tapd via [config-ui](/Configuration/Tapd.md).
-- Configuring Tapd via Config UI's [advanced mode](/Configuration/AdvancedMode.md#6-tapd).
+- Configuring Tapd via [config-ui](/UserManuals/ConfigUI/Tapd.md).
+- Configuring Tapd via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#6-tapd).
diff --git a/versioned_docs/version-v0.15/Plugins/webhook.md b/versioned_docs/version-v0.15/Plugins/webhook.md
index 3d180f29dd..e11d6dd84f 100644
--- a/versioned_docs/version-v0.15/Plugins/webhook.md
+++ b/versioned_docs/version-v0.15/Plugins/webhook.md
@@ -33,7 +33,7 @@ Metrics that can be calculated based on the data collected from Incoming Webhook
## Configuration
-- Configuring Incoming Webhooks via [Config UI](/Configuration/webhook.md)
+- Configuring Incoming Webhooks via [Config UI](/UserManuals/ConfigUI/webhook.md)
## API Sample Request
@@ -67,7 +67,7 @@ curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -d '{
}'
```
-If you have set a [username/password](GettingStarted/Authentication.md) for Config UI, you'll need to add them to the curl command to register a `deployment`:
+If you have set a [username/password](https://devlake.apache.org/docs/UserManuals/Authentication) for Config UI, you'll need to add them to the curl command to register a `deployment`:
```
curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u 'username:password' -d '{
diff --git a/versioned_docs/version-v0.15/Plugins/zentao.md b/versioned_docs/version-v0.15/Plugins/zentao.md
index 43d6398d49..72d157ae4d 100644
--- a/versioned_docs/version-v0.15/Plugins/zentao.md
+++ b/versioned_docs/version-v0.15/Plugins/zentao.md
@@ -20,5 +20,5 @@ Metrics that can be calculated based on the data collected from Zentao:
## Configuration
-- Configuring Zentao via [config-ui](/Configuration/Zentao.md).
-- Configuring Zentao via Config UI's [advanced mode](/Configuration/AdvancedMode.md#8-zentao).
+- Configuring Zentao via [config-ui](/UserManuals/ConfigUI/Zentao.md).
+- Configuring Zentao via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md#8-zentao).
diff --git a/versioned_docs/version-v0.15/Troubleshooting/Configuration.md b/versioned_docs/version-v0.15/Troubleshooting/Configuration.md
index fbe71e76c3..7db538989e 100644
--- a/versioned_docs/version-v0.15/Troubleshooting/Configuration.md
+++ b/versioned_docs/version-v0.15/Troubleshooting/Configuration.md
@@ -10,7 +10,7 @@ description: >
| Error code | An example | Causes | Solutions |
| ---------- | ----------------------------|--------|-----------|
| 429 | subtask collectAPiPipelines ended unexpectedly caused: Error waiting for async Collector execution caused by: retry exceeded 3 times calling projects/{projectId}/pipelines {429} | This error exmaple is caused by GitLab's Pipeline APIs. These APIs are implemented via Cloudflare, which is different from other GitLab entities. | Two ways: <br/> - Enable `fixed rate limit` in the GitLab connection, lower the API rates to 2,000. If it works, you can try increase the rates to ac [...]
-| 403 | error: preparing task data for gitextractor caused by: unexpected http status code: 403 | This is usually caused by the permission of your tokens. For example, if you're using an un-supported auth method, or using a token without ticking permissions to certain entities you want to collect. | Find the supported authentication methods and token permissions that should be selected in the corresponding plugin's Config UI manuals, for example, [configuring GitHub](/docs/Configu [...]
+| 403 | error: preparing task data for gitextractor caused by: unexpected http status code: 403 | This is usually caused by the permission of your tokens. For example, if you're using an un-supported auth method, or using a token without ticking permissions to certain entities you want to collect. | Find the supported authentication methods and token permissions that should be selected in the corresponding plugin's Config UI manuals, for example, [configuring GitHub](UserManuals/C [...]
| 1406 | subtask extractApiBuilds ended unexpectedly caused by: error adding the result to batch caused by: Error 1406: Data too long for column 'full_display_name' at row 138. See bug [#4053](https://github.com/apache/incubator-devlake/issues/4053) | This is usually thrown by MySQL because a certain value is too long | A work-around is to manually change the field length to varchar(255) or longer in MySQL. Also, please put up a [bug](https://github.com/apache/incubator-devlake/iss [...]
diff --git a/versioned_docs/version-v0.15/Configuration/AdvancedMode.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/AdvancedMode.md
similarity index 99%
rename from versioned_docs/version-v0.15/Configuration/AdvancedMode.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/AdvancedMode.md
index 6377d51644..d9f3823aec 100644
--- a/versioned_docs/version-v0.15/Configuration/AdvancedMode.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/AdvancedMode.md
@@ -1,6 +1,6 @@
---
-title: "Blueprint Advanced Mode"
-sidebar_position: 8
+title: "Using Advanced Mode"
+sidebar_position: 7
description: >
Using the advanced mode of Config-UI
---
diff --git a/versioned_docs/version-v0.15/Configuration/BitBucket.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/BitBucket.md
similarity index 98%
rename from versioned_docs/version-v0.15/Configuration/BitBucket.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/BitBucket.md
index 871b2e9c86..317be3e8d7 100644
--- a/versioned_docs/version-v0.15/Configuration/BitBucket.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/BitBucket.md
@@ -1,5 +1,5 @@
---
-title: "BitBucket(Beta)"
+title: "Configuring BitBucket(Beta)"
sidebar_position: 2
description: Config UI instruction for BitBucket(Cloud)
---
diff --git a/versioned_docs/version-v0.15/Configuration/GitHub.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md
similarity index 98%
rename from versioned_docs/version-v0.15/Configuration/GitHub.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md
index eff040331a..c80152260f 100644
--- a/versioned_docs/version-v0.15/Configuration/GitHub.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md
@@ -1,5 +1,5 @@
---
-title: "GitHub"
+title: "Configuring GitHub"
sidebar_position: 2
description: Config UI instruction for GitHub
---
@@ -120,8 +120,7 @@ If you're using GitHub Action to conduct `deployments`, please select "Detect De
- Deployment: A GitHub Action job with a name that matches the given regEx will be considered as a deployment.
- Production: A GitHub Action job with a name that matches the given regEx will be considered a job in the production environment.
-A GitHub workflow run has many jobs. Each GitHub workflow run is converted to a
-cicd_pipeline in the domain layer and each GitHub Action job is converted to a cicd_task in the domain layer.
+A GitHub workflow run has many jobs. Each GitHub workflow run is converted to a cicd_pipeline in the domain layer and each GitHub Action job is converted to a cicd_task in the domain layer.
diff --git a/versioned_docs/version-v0.15/Configuration/GitLab.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitLab.md
similarity index 99%
rename from versioned_docs/version-v0.15/Configuration/GitLab.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/GitLab.md
index 69558b2974..f1db518f2b 100644
--- a/versioned_docs/version-v0.15/Configuration/GitLab.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitLab.md
@@ -1,5 +1,5 @@
---
-title: "GitLab"
+title: "Configuring GitLab"
sidebar_position: 3
description: Config UI instruction for GitLab
---
diff --git a/versioned_docs/version-v0.15/Configuration/Jenkins.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Jenkins.md
similarity index 99%
rename from versioned_docs/version-v0.15/Configuration/Jenkins.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/Jenkins.md
index 45a301381a..260348e53e 100644
--- a/versioned_docs/version-v0.15/Configuration/Jenkins.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Jenkins.md
@@ -1,5 +1,5 @@
---
-title: "Jenkins"
+title: "Configuring Jenkins"
sidebar_position: 5
description: Config UI instruction for Jenkins
---
@@ -51,7 +51,6 @@ Jenkins only supports `CI/CD` domain entities, transformed from Jenkins builds a
- CI/CD: Jenkins builds, stages, etc.
### Step 3 - Adding Transformation Rules (Optional)
-
This set of configurations is used for calculating [DORA metrics](../DORA.md).
If you'd like to define `deployments` with Jenkins, please select "Detect Deployment from Jenkins Builds", and provide the following regexes
diff --git a/versioned_docs/version-v0.15/Configuration/Jira.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Jira.md
similarity index 99%
rename from versioned_docs/version-v0.15/Configuration/Jira.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/Jira.md
index f0d4732747..f9aaf2683a 100644
--- a/versioned_docs/version-v0.15/Configuration/Jira.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Jira.md
@@ -1,5 +1,5 @@
---
-title: "Jira"
+title: "Configuring Jira"
sidebar_position: 4
description: Config UI instruction for Jira
---
diff --git a/versioned_docs/version-v0.15/Configuration/Tapd.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Tapd.md
similarity index 97%
rename from versioned_docs/version-v0.15/Configuration/Tapd.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/Tapd.md
index cf62019b0f..c65270d449 100644
--- a/versioned_docs/version-v0.15/Configuration/Tapd.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Tapd.md
@@ -1,5 +1,5 @@
---
-title: "TAPD(Beta)"
+title: "Configuring TAPD(Beta)"
sidebar_position: 6
description: Config UI instruction for Tapd
---
diff --git a/versioned_docs/version-v0.15/Configuration/Tutorial.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Tutorial.md
similarity index 97%
rename from versioned_docs/version-v0.15/Configuration/Tutorial.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/Tutorial.md
index 1478881940..00f29ee5e1 100644
--- a/versioned_docs/version-v0.15/Configuration/Tutorial.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Tutorial.md
@@ -68,6 +68,9 @@ In the current version, the Blueprint editing feature **allows** editing:
- The data scope of a connection
- The data entities of the data scope
- The transformation rules of any data scope
+
+and currently does **NOT allow**:
+- Adding or deleting connections of an existing Blueprint (will be available in the future)
- Editing any connections
Please note:
diff --git a/versioned_docs/version-v0.15/Configuration/Zentao.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Zentao.md
similarity index 97%
rename from versioned_docs/version-v0.15/Configuration/Zentao.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/Zentao.md
index 316e0dea1c..d8cfde289a 100644
--- a/versioned_docs/version-v0.15/Configuration/Zentao.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/Zentao.md
@@ -1,5 +1,5 @@
---
-title: "Zentao(Beta)"
+title: "Configuring Zentao(Beta)"
sidebar_position: 6
description: Config UI instruction for Zentao
---
diff --git a/versioned_docs/version-v0.15/UserManuals/ConfigUI/_category_.json b/versioned_docs/version-v0.15/UserManuals/ConfigUI/_category_.json
new file mode 100644
index 0000000000..62f99d484f
--- /dev/null
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Config UI",
+ "position": 4
+}
diff --git a/versioned_docs/version-v0.15/Configuration/webhook.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/webhook.md
similarity index 98%
rename from versioned_docs/version-v0.15/Configuration/webhook.md
rename to versioned_docs/version-v0.15/UserManuals/ConfigUI/webhook.md
index 97540285bb..9616feab99 100644
--- a/versioned_docs/version-v0.15/Configuration/webhook.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/webhook.md
@@ -1,5 +1,5 @@
---
-title: "Incoming Webhook"
+title: "Configuring Incoming Webhook"
sidebar_position: 7
description: Config UI instruction for Webhook
---
diff --git a/versioned_docs/version-v0.15/DORA.md b/versioned_docs/version-v0.15/UserManuals/DORA.md
similarity index 96%
rename from versioned_docs/version-v0.15/DORA.md
rename to versioned_docs/version-v0.15/UserManuals/DORA.md
index 8d3b9e9126..81ac826b2b 100644
--- a/versioned_docs/version-v0.15/DORA.md
+++ b/versioned_docs/version-v0.15/UserManuals/DORA.md
@@ -1,6 +1,6 @@
---
title: "DORA"
-sidebar_position: 4
+sidebar_position: 7
description: >
DORA Metrics
---
@@ -44,7 +44,7 @@ You can set up DORA metrics in DevLake in a few steps:
DevLake now supports Jenkins, GitHub Action and GitLabCI as data sources for `deployments` data; Jira, GitHub issues, and TAPD as the sources for `incidents` data; Github PRs, GitLab MRs as the sources for `changes` data.
-If your CI/CD tools are not listed on the [Supported Data Sources](https://devlake.apache.org/docs/SupportedDataSources) page, have no fear! DevLake provides incoming webhooks to push your `deployments` data to DevLake. The webhook configuration doc can be found [here](https://devlake.apache.org/docs/Configuration/webhook/).
+If your CI/CD tools are not listed on the [Supported Data Sources](https://devlake.apache.org/docs/SupportedDataSources) page, have no fear! DevLake provides incoming webhooks to push your `deployments` data to DevLake. The webhook configuration doc can be found [here](https://devlake.apache.org/docs/UserManuals/ConfigUI/webhook/).
## A real-world example
@@ -86,7 +86,7 @@ In the next section, we'll demonstrate how to configure DevLake to implement DOR
6. Choose sync frequency, click 'Save and Run Now' to start data collection. The time to completion varies by data source and depends on the volume of data.
-For more details, please refer to our [blueprint manuals](https://devlake.apache.org/docs/Configuration/Tutorial).
+For more details, please refer to our [blueprint manuals](https://devlake.apache.org/docs/UserManuals/ConfigUI/Tutorial).
### Collect CircleCI data via `webhook`
@@ -144,7 +144,7 @@ Using CircleCI as an example, we demonstrate how to actively push data to DevLak
- build
- deploy
```
- If you have set a [username/password](GettingStarted/Authentication.md) for Config UI, you need to add them to the curl to register a deployment:
+ If you have set a [username/password](https://devlake.apache.org/docs/UserManuals/Authentication) for Config UI, you need to add them to the curl to register a deployment:
```
curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u 'username:password' -d '{
@@ -172,7 +172,7 @@ For a breakdown of each metric's SQL query, please refer to the corresponding me
- [Median Time to Restore Service](https://devlake.apache.org/docs/Metrics/MTTR)
- [Change Failure Rate](https://devlake.apache.org/docs/Metrics/CFR)
-If you aren't familiar with Grafana, please refer to our [Grafana doc](Configuration/Dashboards/GrafanaUserGuide.md), or jump into Slack for help.
+If you aren't familiar with Grafana, please refer to our [Grafana doc](./Dashboards/GrafanaUserGuide.md), or jump into Slack for help.
<br/>
diff --git a/versioned_docs/version-v0.15/Configuration/Dashboards/AccessControl.md b/versioned_docs/version-v0.15/UserManuals/Dashboards/AccessControl.md
similarity index 100%
rename from versioned_docs/version-v0.15/Configuration/Dashboards/AccessControl.md
rename to versioned_docs/version-v0.15/UserManuals/Dashboards/AccessControl.md
diff --git a/versioned_docs/version-v0.15/Configuration/Dashboards/GrafanaUserGuide.md b/versioned_docs/version-v0.15/UserManuals/Dashboards/GrafanaUserGuide.md
similarity index 100%
rename from versioned_docs/version-v0.15/Configuration/Dashboards/GrafanaUserGuide.md
rename to versioned_docs/version-v0.15/UserManuals/Dashboards/GrafanaUserGuide.md
diff --git a/versioned_docs/version-v0.15/UserManuals/Dashboards/_category_.json b/versioned_docs/version-v0.15/UserManuals/Dashboards/_category_.json
new file mode 100644
index 0000000000..0db83c6e9b
--- /dev/null
+++ b/versioned_docs/version-v0.15/UserManuals/Dashboards/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Dashboards",
+ "position": 5
+}
diff --git a/versioned_docs/version-v0.15/Configuration/TeamConfiguration.md b/versioned_docs/version-v0.15/UserManuals/TeamConfiguration.md
similarity index 100%
rename from versioned_docs/version-v0.15/Configuration/TeamConfiguration.md
rename to versioned_docs/version-v0.15/UserManuals/TeamConfiguration.md
diff --git a/versioned_docs/version-v0.15/Configuration/_category_.json b/versioned_docs/version-v0.15/UserManuals/_category_.json
similarity index 54%
rename from versioned_docs/version-v0.15/Configuration/_category_.json
rename to versioned_docs/version-v0.15/UserManuals/_category_.json
index 96a3608ba7..23ce768a59 100644
--- a/versioned_docs/version-v0.15/Configuration/_category_.json
+++ b/versioned_docs/version-v0.15/UserManuals/_category_.json
@@ -1,8 +1,8 @@
{
- "label": "Configuration",
+ "label": "User Manuals",
"position": 3,
"link":{
"type": "generated-index",
- "slug": "Configuration"
+ "slug": "UserManuals"
}
}