You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2022/07/04 13:43:55 UTC
[incubator-devlake-website] branch main updated: updated docs order again (#102)
This is an automated email from the ASF dual-hosted git repository.
klesh 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 5be9029 updated docs order again (#102)
5be9029 is described below
commit 5be90298c3499ddedc7f6985b3359696f140314b
Author: Yumeng Wang <yu...@merico.dev>
AuthorDate: Mon Jul 4 21:43:51 2022 +0800
updated docs order again (#102)
* updated becoming a committer doc
* docs: updated doc order
* docs: updated doc order
* docs: udpated doc order again
---
.../AverageRequirementLeadTime.md | 0
.../CommitCountByAuthor.md | 0
.../DetailedBugInfo.md | 0
docs/{08-Dashboards => Dashboards}/GitHubBasic.md | 0
.../GitHubReleaseQualityAndContributionAnalysis.md | 0
docs/{08-Dashboards => Dashboards}/Jenkins.md | 0
.../WeeklyBugRetro.md | 0
docs/{08-Dashboards => Dashboards}/_category_.json | 2 +-
.../01-DevLakeDomainLayerSchema.md | 0
.../02-DataSupport.md | 0
docs/{05-DataModels => DataModels}/_category_.json | 0
.../04-DeveloperSetup.md | 16 ++++++------
.../MIGRATIONS.md | 0
.../NOTIFICATION.md | 0
docs/DeveloperManuals/_category_.json | 4 +++
...EngineeringMetrics.md => EngineeringMetrics.md} | 2 --
docs/{07-Glossary.md => Glossary.md} | 27 +++++++++++----------
docs/{01-Overview => Overview}/01-WhatIsDevLake.md | 4 +--
docs/{01-Overview => Overview}/02-Architecture.md | 0
docs/{01-Overview => Overview}/03-Roadmap.md | 5 ++--
docs/{01-Overview => Overview}/_category_.json | 0
docs/{03-Plugins => Plugins}/_category_.json | 2 +-
docs/{03-Plugins => Plugins}/dbt.md | 0
docs/{03-Plugins => Plugins}/feishu.md | 0
docs/{03-Plugins => Plugins}/gitee.md | 0
docs/{03-Plugins => Plugins}/gitextractor.md | 0
.../github-connection-in-config-ui.png | Bin
docs/{03-Plugins => Plugins}/github.md | 0
.../gitlab-connection-in-config-ui.png | Bin
docs/{03-Plugins => Plugins}/gitlab.md | 0
docs/{03-Plugins => Plugins}/jenkins.md | 0
.../jira-connection-config-ui.png | Bin
.../jira-more-setting-in-config-ui.png | Bin
docs/{03-Plugins => Plugins}/jira.md | 0
docs/{03-Plugins => Plugins}/refdiff.md | 0
docs/{03-Plugins => Plugins}/tapd.md | 0
.../{02-QuickStart => QuickStart}/01-LocalSetup.md | 16 ++++++------
.../02-KubernetesSetup.md | 0
docs/{02-QuickStart => QuickStart}/_category_.json | 0
.../03-TemporalSetup.md | 3 ++-
docs/{04-UserManuals => UserManuals}/GRAFANA.md | 1 +
.../_category_.json | 2 +-
.../create-pipeline-in-advanced-mode.md | 1 +
.../github-user-guide-v0.10.0.md | 1 +
.../recurring-pipeline.md | 1 +
45 files changed, 47 insertions(+), 40 deletions(-)
diff --git a/docs/08-Dashboards/AverageRequirementLeadTime.md b/docs/Dashboards/AverageRequirementLeadTime.md
similarity index 100%
rename from docs/08-Dashboards/AverageRequirementLeadTime.md
rename to docs/Dashboards/AverageRequirementLeadTime.md
diff --git a/docs/08-Dashboards/CommitCountByAuthor.md b/docs/Dashboards/CommitCountByAuthor.md
similarity index 100%
rename from docs/08-Dashboards/CommitCountByAuthor.md
rename to docs/Dashboards/CommitCountByAuthor.md
diff --git a/docs/08-Dashboards/DetailedBugInfo.md b/docs/Dashboards/DetailedBugInfo.md
similarity index 100%
rename from docs/08-Dashboards/DetailedBugInfo.md
rename to docs/Dashboards/DetailedBugInfo.md
diff --git a/docs/08-Dashboards/GitHubBasic.md b/docs/Dashboards/GitHubBasic.md
similarity index 100%
rename from docs/08-Dashboards/GitHubBasic.md
rename to docs/Dashboards/GitHubBasic.md
diff --git a/docs/08-Dashboards/GitHubReleaseQualityAndContributionAnalysis.md b/docs/Dashboards/GitHubReleaseQualityAndContributionAnalysis.md
similarity index 100%
rename from docs/08-Dashboards/GitHubReleaseQualityAndContributionAnalysis.md
rename to docs/Dashboards/GitHubReleaseQualityAndContributionAnalysis.md
diff --git a/docs/08-Dashboards/Jenkins.md b/docs/Dashboards/Jenkins.md
similarity index 100%
rename from docs/08-Dashboards/Jenkins.md
rename to docs/Dashboards/Jenkins.md
diff --git a/docs/08-Dashboards/WeeklyBugRetro.md b/docs/Dashboards/WeeklyBugRetro.md
similarity index 100%
rename from docs/08-Dashboards/WeeklyBugRetro.md
rename to docs/Dashboards/WeeklyBugRetro.md
diff --git a/docs/08-Dashboards/_category_.json b/docs/Dashboards/_category_.json
similarity index 71%
rename from docs/08-Dashboards/_category_.json
rename to docs/Dashboards/_category_.json
index a15002e..b27df44 100644
--- a/docs/08-Dashboards/_category_.json
+++ b/docs/Dashboards/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Dashboards (Live Demo)",
- "position": 8
+ "position": 9
}
diff --git a/docs/05-DataModels/01-DevLakeDomainLayerSchema.md b/docs/DataModels/01-DevLakeDomainLayerSchema.md
similarity index 100%
rename from docs/05-DataModels/01-DevLakeDomainLayerSchema.md
rename to docs/DataModels/01-DevLakeDomainLayerSchema.md
diff --git a/docs/05-DataModels/02-DataSupport.md b/docs/DataModels/02-DataSupport.md
similarity index 100%
rename from docs/05-DataModels/02-DataSupport.md
rename to docs/DataModels/02-DataSupport.md
diff --git a/docs/05-DataModels/_category_.json b/docs/DataModels/_category_.json
similarity index 100%
rename from docs/05-DataModels/_category_.json
rename to docs/DataModels/_category_.json
diff --git a/docs/02-QuickStart/04-DeveloperSetup.md b/docs/DeveloperManuals/04-DeveloperSetup.md
similarity index 85%
rename from docs/02-QuickStart/04-DeveloperSetup.md
rename to docs/DeveloperManuals/04-DeveloperSetup.md
index b3292fb..62cc1e5 100644
--- a/docs/02-QuickStart/04-DeveloperSetup.md
+++ b/docs/DeveloperManuals/04-DeveloperSetup.md
@@ -24,7 +24,7 @@ description: >
2. Install dependencies for plugins:
- - [RefDiff](../03-Plugins/refdiff.md#development)
+ - [RefDiff](../Plugins/refdiff.md#development)
3. Install Go packages
@@ -71,10 +71,10 @@ description: >
- Navigate to desired plugins pages on the Integrations page
- Enter the required information for the plugins you intend to use.
- Refer to the following for more details on how to configure each one:
- - [Jira](../03-Plugins/jira.md)
- - [GitLab](../03-Plugins/gitlab.md)
- - [Jenkins](../03-Plugins/jenkins.md)
- - [GitHub](../03-Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../04-UserManuals/github-user-guide-v0.10.0.md) which covers the following steps in detail.
+ - [Jira](../Plugins/jira.md)
+ - [GitLab](../Plugins/gitlab.md)
+ - [Jenkins](../Plugins/jenkins.md)
+ - [GitHub](../Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/github-user-guide-v0.10.0.md) which covers the following steps in detail.
- Submit the form to update the values by clicking on the **Save Connection** button on each form page
9. Visit `localhost:4000/pipelines/create` to RUN a Pipeline and trigger data collection.
@@ -107,14 +107,14 @@ description: >
]
```
- Please refer to [Pipeline Advanced Mode](../04-UserManuals/create-pipeline-in-advanced-mode.md) for in-depth explanation.
+ Please refer to [Pipeline Advanced Mode](../UserManuals/create-pipeline-in-advanced-mode.md) for in-depth explanation.
10. Click *View Dashboards* button in the top left when done, or visit `localhost:3002` (username: `admin`, password: `admin`).
We use <a href="https://grafana.com/" target="_blank">Grafana</a> as a visualization tool to build charts for the <a href="https://github.com/merico-dev/lake/wiki/DataModel.Domain-layer-schema">data stored in our database</a>. Using SQL queries, we can add panels to build, save, and edit customized dashboards.
- All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../04-UserManuals/GRAFANA.md).
+ All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GRAFANA.md).
11. (Optional) To run the tests:
@@ -122,5 +122,5 @@ description: >
make test
```
-12. For DB migrations, please refer to [Migration Doc](../04-UserManuals/MIGRATIONS.md).
+12. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/MIGRATIONS.md).
<br/><br/><br/>
diff --git a/docs/04-UserManuals/MIGRATIONS.md b/docs/DeveloperManuals/MIGRATIONS.md
similarity index 100%
rename from docs/04-UserManuals/MIGRATIONS.md
rename to docs/DeveloperManuals/MIGRATIONS.md
diff --git a/docs/04-UserManuals/NOTIFICATION.md b/docs/DeveloperManuals/NOTIFICATION.md
similarity index 100%
rename from docs/04-UserManuals/NOTIFICATION.md
rename to docs/DeveloperManuals/NOTIFICATION.md
diff --git a/docs/DeveloperManuals/_category_.json b/docs/DeveloperManuals/_category_.json
new file mode 100644
index 0000000..fe67a68
--- /dev/null
+++ b/docs/DeveloperManuals/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Developer Manuals",
+ "position": 4
+}
diff --git a/docs/06-EngineeringMetrics.md b/docs/EngineeringMetrics.md
similarity index 99%
rename from docs/06-EngineeringMetrics.md
rename to docs/EngineeringMetrics.md
index 54debf3..2d9a42a 100644
--- a/docs/06-EngineeringMetrics.md
+++ b/docs/EngineeringMetrics.md
@@ -3,8 +3,6 @@ sidebar_position: 06
title: "Engineering Metrics"
linkTitle: "Engineering Metrics"
tags: []
-categories: []
-weight: 40000
description: >
The definition, values and data required for the 20+ engineering metrics supported by DevLake.
---
diff --git a/docs/07-Glossary.md b/docs/Glossary.md
similarity index 70%
rename from docs/07-Glossary.md
rename to docs/Glossary.md
index 1789a8f..dc348f6 100644
--- a/docs/07-Glossary.md
+++ b/docs/Glossary.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 07
+sidebar_position: 8
title: "Glossary"
linkTitle: "Glossary"
tags: []
@@ -18,9 +18,9 @@ The following terms are arranged in the order of their appearance in the actual
### Blueprints
**A blueprint is the plan that covers all the work to get your raw data ready for query and metric computation in the dashboards.** Creating a blueprint consists of four steps:
-1. **Adding [Data Connections](07-Glossary.md#data-connections)**: For each [data source](07-Glossary.md#data-sources), one or more data connections can be added to a single blueprint, depending on the data you want to sync to DevLake.
-2. **Setting the [Data Scope](07-Glossary.md#data-scope)**: For each data connection, you need to configure the scope of data, such as GitHub projects, Jira boards, and their corresponding [data entities](07-Glossary.md#data-entities).
-3. **Adding [Transformation Rules](07-Glossary.md#transformation-rules) (optional)**: You can optionally apply transformation for the data scope you have just selected, in order to view more advanced metrics.
+1. **Adding [Data Connections](Glossary.md#data-connections)**: For each [data source](Glossary.md#data-sources), one or more data connections can be added to a single blueprint, depending on the data you want to sync to DevLake.
+2. **Setting the [Data Scope](Glossary.md#data-scope)**: For each data connection, you need to configure the scope of data, such as GitHub projects, Jira boards, and their corresponding [data entities](Glossary.md#data-entities).
+3. **Adding [Transformation Rules](Glossary.md#transformation-rules) (optional)**: You can optionally apply transformation for the data scope you have just selected, in order to view more advanced metrics.
3. **Setting the Sync Frequency**: You can specify the sync frequency for your blueprint to achieve recurring data syncs and transformation. Alternatively, you can set the frequency to manual if you wish to run the tasks in the blueprint manually.
The relationship among Blueprint, Data Connections, Data Scope and Transformation Rules is explained as follows:
@@ -34,7 +34,7 @@ The relationship among Blueprint, Data Connections, Data Scope and Transformatio
### Data Sources
**A data source is a specific DevOps tool from which you wish to sync your data, such as GitHub, GitLab, Jira and Jenkins.**
-DevLake normally uses one [data plugin](07-Glossary.md#data-plugins) to pull data for a single data source. However, in some cases, DevLake uses multiple data plugins for one data source for the purpose of improved sync speed, among many other advantages. For instance, when you pull data from GitHub or GitLab, aside from the GitHub or GitLab plugin, Git Extractor is also used to pull data from the repositories. In this case, DevLake still refers GitHub or GitLab as a single data source.
+DevLake normally uses one [data plugin](Glossary.md#data-plugins) to pull data for a single data source. However, in some cases, DevLake uses multiple data plugins for one data source for the purpose of improved sync speed, among many other advantages. For instance, when you pull data from GitHub or GitLab, aside from the GitHub or GitLab plugin, Git Extractor is also used to pull data from the repositories. In this case, DevLake still refers GitHub or GitLab as a single data source.
### Data Connections
**A data connection is a specific instance of a data source that stores information such as `endpoint` and `auth`.** A single data source can have one or more data connections (e.g. two Jira instances). Currently, DevLake supports one data connection for GitHub, GitLab and Jenkins, and multiple connections for Jira.
@@ -42,18 +42,18 @@ DevLake normally uses one [data plugin](07-Glossary.md#data-plugins) to pull dat
You can set up a new data connection either during the first step of creating a blueprint, or in the Connections page that can be accessed from the navigation bar. Because one single data connection can be reused in multiple blueprints, you can update the information of a particular data connection in Connections, to ensure all its associated blueprints will run properly. For example, you may want to update your GitHub token in a data connection if it goes expired.
### Data Scope
-**In a blueprint, each data connection can have multiple sets of data scope configurations, including GitHub or GitLab projects, Jira boards and their corresponding[data entities](07-Glossary.md#data-entities).** The fields for data scope configuration vary according to different data sources.
+**In a blueprint, each data connection can have multiple sets of data scope configurations, including GitHub or GitLab projects, Jira boards and their corresponding[data entities](Glossary.md#data-entities).** The fields for data scope configuration vary according to different data sources.
Each set of data scope refers to one GitHub or GitLab project, or one Jira board and the data entities you would like to sync for them, for the convenience of applying transformation in the next step. For instance, if you wish to sync 5 GitHub projects, you will have 5 sets of data scope for GitHub.
-To learn more about the default data scope of all data sources and data plugins, please refer to [Data Support](./05-DataModels/02-DataSupport.md).
+To learn more about the default data scope of all data sources and data plugins, please refer to [Data Support](./DataModels/02-DataSupport.md).
### Data Entities
**Data entities refer to the data fields from one of the five data domains: Issue Tracking, Source Code Management, Code Review, CI/CD and Cross-Domain.**
For instance, if you wish to pull Source Code Management data from GitHub and Issue Tracking data from Jira, you can check the corresponding data entities during setting the data scope of these two data connections.
-To learn more details, please refer to [Domain Layer Schema](./05-DataModels/01-DevLakeDomainLayerSchema.md).
+To learn more details, please refer to [Domain Layer Schema](./DataModels/01-DevLakeDomainLayerSchema.md).
### Transformation Rules
**Transformation rules are a collection of methods that allow you to customize how DevLake normalizes raw data for query and metric computation.** Each set of data scope is strictly accompanied with one set of transformation rules. However, for your convenience, transformation rules can also be duplicated across different sets of data scope.
@@ -61,12 +61,12 @@ To learn more details, please refer to [Domain Layer Schema](./05-DataModels/01-
DevLake uses these normalized values in the transformation to design more advanced dashboards, such as the Weekly Bug Retro dashboard. Although configuring transformation rules is not mandatory, if you leave the rules blank or have not configured correctly, only the basic dashboards (e.g. GitHub Basic Metrics) will be displayed as expected, while the advanced dashboards will not.
### Historical Runs
-**A historical run of a blueprint is an actual execution of the data collection and transformation [tasks](07-Glossary.md#tasks) defined in the blueprint at its creation.** A list of historical runs of a blueprint is the entire running history of that blueprint, whether executed automatically or manually. Historical runs can be triggered in three ways:
+**A historical run of a blueprint is an actual execution of the data collection and transformation [tasks](Glossary.md#tasks) defined in the blueprint at its creation.** A list of historical runs of a blueprint is the entire running history of that blueprint, whether executed automatically or manually. Historical runs can be triggered in three ways:
- By the blueprint automatically according to its schedule in the Regular Mode of the Configuration UI
- By running the JSON in the Advanced Mode of the Configuration UI
- By calling the API `/pipelines` endpoint manually
-However, the name Historical Runs is only used in the Configuration UI. In DevLake API, they are called [pipelines](07-Glossary.md#pipelines).
+However, the name Historical Runs is only used in the Configuration UI. In DevLake API, they are called [pipelines](Glossary.md#pipelines).
## In Configuration UI (Advanced Mode) and API
@@ -81,21 +81,22 @@ Data Transformation Plugins transform the data pulled by other Data Collection P
Although the names of the data plugins are not displayed in the regular mode of DevLake Configuration UI, they can be used directly in JSON in the Advanced Mode.
-For detailed information about the relationship between data sources and data plugins, please refer to [Data Support](./05-DataModels/02-DataSupport.md).
+For detailed information about the relationship between data sources and data plugins, please refer to [Data Support](./DataModels/02-DataSupport.md).
### Pipelines
-**A pipeline is an orchestration of [tasks](07-Glossary.md#tasks) of data `collection`, `extraction`, `conversion` and `enrichment`, defined in the DevLake API.** A pipeline is composed of one or multiple [stages](07-Glossary.md#stages) that are executed in a sequential order. Any error occurring during the execution of any stage, task or subtask will cause the immediate fail of the pipeline.
+**A pipeline is an orchestration of [tasks](Glossary.md#tasks) of data `collection`, `extraction`, `conversion` and `enrichment`, defined in the DevLake API.** A pipeline is composed of one or multiple [stages](Glossary.md#stages) that are executed in a sequential order. Any error occurring during the execution of any stage, task or subtask will cause the immediate fail of the pipeline.
The composition of a pipeline is explained as follows:
Notice: **You can manually orchestrate the pipeline in Configuration UI Advanced Mode and the DevLake API; whereas in Configuration UI regular mode, an optimized pipeline orchestration will be automatically generated for you.**
+
### Stages
**A stages is a collection of tasks performed by data plugins.** Stages are executed in a sequential order in a pipeline.
### Tasks
-**A task is a collection of [subtasks](07-Glossary.md#subtasks) that perform any of the `collection`, `extraction`, `conversion` and `enrichment` jobs of a particular data plugin.** Tasks are executed in a parallel order in any stages.
+**A task is a collection of [subtasks](Glossary.md#subtasks) that perform any of the `collection`, `extraction`, `conversion` and `enrichment` jobs of a particular data plugin.** Tasks are executed in a parallel order in any stages.
### Subtasks
**A subtask is the minimal work unit in a pipeline that performs in any of the four roles: `Collectors`, `Extractors`, `Converters` and `Enrichers`.** Subtasks are executed in sequential orders.
diff --git a/docs/01-Overview/01-WhatIsDevLake.md b/docs/Overview/01-WhatIsDevLake.md
similarity index 86%
rename from docs/01-Overview/01-WhatIsDevLake.md
rename to docs/Overview/01-WhatIsDevLake.md
index 1d790fb..e3760f1 100755
--- a/docs/01-Overview/01-WhatIsDevLake.md
+++ b/docs/Overview/01-WhatIsDevLake.md
@@ -9,8 +9,8 @@ Apache DevLake is an open-source dev data platform that ingests, analyzes, and v
Apache DevLake is designed for developer teams looking to make better sense of their development process and to bring a more data-driven approach to their own practices. You can ask Apache DevLake many questions regarding your development process. Just connect and query.
## What can be accomplished with Apache DevLake?
-1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard [data model](../05-DataModels/01-DevLakeDomainLayerSchema.md).
-2. Visualize out-of-the-box engineering [metrics](../06-EngineeringMetrics.md) in a series of use-case driven dashboards
+1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard [data model](../DataModels/01-DevLakeDomainLayerSchema.md).
+2. Visualize out-of-the-box engineering [metrics](../EngineeringMetrics.md) in a series of use-case driven dashboards
3. Easily extend DevLake to support your data sources, metrics, and dashboards with a flexible [framework](02-Architecture.md) for data collection and ETL.
diff --git a/docs/01-Overview/02-Architecture.md b/docs/Overview/02-Architecture.md
similarity index 100%
rename from docs/01-Overview/02-Architecture.md
rename to docs/Overview/02-Architecture.md
diff --git a/docs/01-Overview/03-Roadmap.md b/docs/Overview/03-Roadmap.md
similarity index 54%
rename from docs/01-Overview/03-Roadmap.md
rename to docs/Overview/03-Roadmap.md
index ed4c507..f10b62e 100644
--- a/docs/01-Overview/03-Roadmap.md
+++ b/docs/Overview/03-Roadmap.md
@@ -24,8 +24,8 @@ Apache DevLake is currently under rapid development. You are more than welcome t
| Category | Features|
| --- | --- |
-| More data sources across different [DevOps domains](../05-DataModels/01-DevLakeDomainLayerSchema.md) (Goal No.1 & 2)| Features in **bold** are of higher priority <br/><br/> Issue/Task Management: <ul><li>**Jira server** [#886 (closed)](https://github.com/apache/incubator-devlake/issues/886)</li><li>**Jira data center** [#1687 (closed)](https://github.com/apache/incubator-devlake/issues/1687)</li><li>GitLab Issues [#715 (closed)](https://github.com/apache/incubator-devlake/issues/715)</ [...]
-| Improved data collection, [data models](../05-DataModels/01-DevLakeDomainLayerSchema.md) and data extensibility (Goal No.2)| Data Collection: <br/> <ul><li>Complete the logging system</li><li>Implement a good error handling mechanism during data collection</li></ul> Data Models:<ul><li>Introduce DBT to allow users to create and modify the domain layer schema. [#1479 (closed)](https://github.com/apache/incubator-devlake/issues/1479)</li><li>Design the data models for 5 new domains, plea [...]
+| More data sources across different [DevOps domains](../DataModels/01-DevLakeDomainLayerSchema.md) (Goal No.1 & 2)| Features in **bold** are of higher priority <br/><br/> Issue/Task Management: <ul><li>**Jira server** [#886 (closed)](https://github.com/apache/incubator-devlake/issues/886)</li><li>**Jira data center** [#1687 (closed)](https://github.com/apache/incubator-devlake/issues/1687)</li><li>GitLab Issues [#715 (closed)](https://github.com/apache/incubator-devlake/issues/715)</li> [...]
+| Improved data collection, [data models](../DataModels/01-DevLakeDomainLayerSchema.md) and data extensibility (Goal No.2)| Data Collection: <br/> <ul><li>Complete the logging system</li><li>Implement a good error handling mechanism during data collection</li></ul> Data Models:<ul><li>Introduce DBT to allow users to create and modify the domain layer schema. [#1479 (closed)](https://github.com/apache/incubator-devlake/issues/1479)</li><li>Design the data models for 5 new domains, please [...]
| Better user experience (Goal No.3) | For new users: <ul><li> Iterate on a clearer step-by-step guide to improve the pre-configuration experience.</li><li>Provide a new Config UI to reduce frictions for data configuration [#1700 (in-progress)](https://github.com/apache/incubator-devlake/issues/1700)</li><li> Showcase dashboard live demos to let users explore and learn about the dashboards. [#1784 (open)](https://github.com/apache/incubator-devlake/issues/1784)</li></ul>For returning use [...]
@@ -34,4 +34,3 @@ A roadmap is only useful when it captures real user needs. We are glad to hear f
Also, if you plan to work (or are already working) on a new or existing feature, tell us, so that we can update the roadmap accordingly. We are happy to share knowledge and context to help your feature land successfully.
<br/><br/><br/>
-
diff --git a/docs/01-Overview/_category_.json b/docs/Overview/_category_.json
similarity index 100%
rename from docs/01-Overview/_category_.json
rename to docs/Overview/_category_.json
diff --git a/docs/03-Plugins/_category_.json b/docs/Plugins/_category_.json
similarity index 61%
rename from docs/03-Plugins/_category_.json
rename to docs/Plugins/_category_.json
index 36011ea..534bad8 100644
--- a/docs/03-Plugins/_category_.json
+++ b/docs/Plugins/_category_.json
@@ -1,4 +1,4 @@
{
"label": "Plugins",
- "position": 3
+ "position": 7
}
diff --git a/docs/03-Plugins/dbt.md b/docs/Plugins/dbt.md
similarity index 100%
rename from docs/03-Plugins/dbt.md
rename to docs/Plugins/dbt.md
diff --git a/docs/03-Plugins/feishu.md b/docs/Plugins/feishu.md
similarity index 100%
rename from docs/03-Plugins/feishu.md
rename to docs/Plugins/feishu.md
diff --git a/docs/03-Plugins/gitee.md b/docs/Plugins/gitee.md
similarity index 100%
rename from docs/03-Plugins/gitee.md
rename to docs/Plugins/gitee.md
diff --git a/docs/03-Plugins/gitextractor.md b/docs/Plugins/gitextractor.md
similarity index 100%
rename from docs/03-Plugins/gitextractor.md
rename to docs/Plugins/gitextractor.md
diff --git a/docs/03-Plugins/github-connection-in-config-ui.png b/docs/Plugins/github-connection-in-config-ui.png
similarity index 100%
rename from docs/03-Plugins/github-connection-in-config-ui.png
rename to docs/Plugins/github-connection-in-config-ui.png
diff --git a/docs/03-Plugins/github.md b/docs/Plugins/github.md
similarity index 100%
rename from docs/03-Plugins/github.md
rename to docs/Plugins/github.md
diff --git a/docs/03-Plugins/gitlab-connection-in-config-ui.png b/docs/Plugins/gitlab-connection-in-config-ui.png
similarity index 100%
rename from docs/03-Plugins/gitlab-connection-in-config-ui.png
rename to docs/Plugins/gitlab-connection-in-config-ui.png
diff --git a/docs/03-Plugins/gitlab.md b/docs/Plugins/gitlab.md
similarity index 100%
rename from docs/03-Plugins/gitlab.md
rename to docs/Plugins/gitlab.md
diff --git a/docs/03-Plugins/jenkins.md b/docs/Plugins/jenkins.md
similarity index 100%
rename from docs/03-Plugins/jenkins.md
rename to docs/Plugins/jenkins.md
diff --git a/docs/03-Plugins/jira-connection-config-ui.png b/docs/Plugins/jira-connection-config-ui.png
similarity index 100%
rename from docs/03-Plugins/jira-connection-config-ui.png
rename to docs/Plugins/jira-connection-config-ui.png
diff --git a/docs/03-Plugins/jira-more-setting-in-config-ui.png b/docs/Plugins/jira-more-setting-in-config-ui.png
similarity index 100%
rename from docs/03-Plugins/jira-more-setting-in-config-ui.png
rename to docs/Plugins/jira-more-setting-in-config-ui.png
diff --git a/docs/03-Plugins/jira.md b/docs/Plugins/jira.md
similarity index 100%
rename from docs/03-Plugins/jira.md
rename to docs/Plugins/jira.md
diff --git a/docs/03-Plugins/refdiff.md b/docs/Plugins/refdiff.md
similarity index 100%
rename from docs/03-Plugins/refdiff.md
rename to docs/Plugins/refdiff.md
diff --git a/docs/03-Plugins/tapd.md b/docs/Plugins/tapd.md
similarity index 100%
rename from docs/03-Plugins/tapd.md
rename to docs/Plugins/tapd.md
diff --git a/docs/02-QuickStart/01-LocalSetup.md b/docs/QuickStart/01-LocalSetup.md
similarity index 76%
rename from docs/02-QuickStart/01-LocalSetup.md
rename to docs/QuickStart/01-LocalSetup.md
index 698cd30..9b81bc9 100644
--- a/docs/02-QuickStart/01-LocalSetup.md
+++ b/docs/QuickStart/01-LocalSetup.md
@@ -23,21 +23,21 @@ description: >
1. Visit `config-ui` at `http://localhost:4000` in your browser to configure data connections.
- Navigate to desired plugins on the Integrations page
- Please reference the following for more details on how to configure each one:<br/>
- - [Jira](../03-Plugins/jira.md)
- - [GitHub](../03-Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../04-UserManuals/github-user-guide-v0.10.0.md) which covers the following steps in detail.
- - [GitLab](../03-Plugins/gitlab.md)
- - [Jenkins](../03-Plugins/jenkins.md)
+ - [Jira](../Plugins/jira.md)
+ - [GitHub](../Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/github-user-guide-v0.10.0.md) which covers the following steps in detail.
+ - [GitLab](../Plugins/gitlab.md)
+ - [Jenkins](../Plugins/jenkins.md)
- Submit the form to update the values by clicking on the **Save Connection** button on each form page
- `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. Create pipelines to trigger data collection in `config-ui`
3. 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](../05-DataModels/02-DataSupport.md) stored in our database.
+ - We use [Grafana](https://grafana.com/) as a visualization tool to build charts for the [data](../DataModels/02-DataSupport.md) stored in our database.
- Using SQL queries, we can add panels to build, save, and edit customized dashboards.
- - All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../04-UserManuals/GRAFANA.md).
-4. To synchronize data periodically, users can set up recurring pipelines with DevLake's [pipeline blueprint](../04-UserManuals/recurring-pipeline.md) for details.
+ - All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GRAFANA.md).
+4. To synchronize data periodically, users can set up recurring pipelines with DevLake's [pipeline blueprint](../UserManuals/recurring-pipeline.md) for details.
#### 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. We recommend users to deploy a new instance if needed.
-<br/><br/><br/>
+<br/>
diff --git a/docs/02-QuickStart/02-KubernetesSetup.md b/docs/QuickStart/02-KubernetesSetup.md
similarity index 100%
rename from docs/02-QuickStart/02-KubernetesSetup.md
rename to docs/QuickStart/02-KubernetesSetup.md
diff --git a/docs/02-QuickStart/_category_.json b/docs/QuickStart/_category_.json
similarity index 100%
rename from docs/02-QuickStart/_category_.json
rename to docs/QuickStart/_category_.json
diff --git a/docs/02-QuickStart/03-TemporalSetup.md b/docs/UserManuals/03-TemporalSetup.md
similarity index 92%
rename from docs/02-QuickStart/03-TemporalSetup.md
rename to docs/UserManuals/03-TemporalSetup.md
index cb993c0..f893a83 100644
--- a/docs/02-QuickStart/03-TemporalSetup.md
+++ b/docs/UserManuals/03-TemporalSetup.md
@@ -1,7 +1,8 @@
---
title: "Temporal Setup"
+sidebar_position: 5
description: >
- The steps to install DevLake in develper mode.
+ The steps to install DevLake in Temporal mode.
---
diff --git a/docs/04-UserManuals/GRAFANA.md b/docs/UserManuals/GRAFANA.md
similarity index 99%
rename from docs/04-UserManuals/GRAFANA.md
rename to docs/UserManuals/GRAFANA.md
index a54c781..bd81651 100644
--- a/docs/04-UserManuals/GRAFANA.md
+++ b/docs/UserManuals/GRAFANA.md
@@ -1,5 +1,6 @@
---
title: "How to use Grafana"
+sidebar_position: 1
description: >
How to use Grafana
---
diff --git a/docs/04-UserManuals/_category_.json b/docs/UserManuals/_category_.json
similarity index 65%
rename from docs/04-UserManuals/_category_.json
rename to docs/UserManuals/_category_.json
index 60bb981..b47bdfd 100644
--- a/docs/04-UserManuals/_category_.json
+++ b/docs/UserManuals/_category_.json
@@ -1,4 +1,4 @@
{
"label": "User Manuals",
- "position": 4
+ "position": 3
}
diff --git a/docs/04-UserManuals/create-pipeline-in-advanced-mode.md b/docs/UserManuals/create-pipeline-in-advanced-mode.md
similarity index 99%
rename from docs/04-UserManuals/create-pipeline-in-advanced-mode.md
rename to docs/UserManuals/create-pipeline-in-advanced-mode.md
index d3ab3c1..14afd01 100644
--- a/docs/04-UserManuals/create-pipeline-in-advanced-mode.md
+++ b/docs/UserManuals/create-pipeline-in-advanced-mode.md
@@ -1,5 +1,6 @@
---
title: "Create Pipeline in Advanced Mode"
+sidebar_position: 2
description: >
Create Pipeline in Advanced Mode
---
diff --git a/docs/04-UserManuals/github-user-guide-v0.10.0.md b/docs/UserManuals/github-user-guide-v0.10.0.md
similarity index 99%
rename from docs/04-UserManuals/github-user-guide-v0.10.0.md
rename to docs/UserManuals/github-user-guide-v0.10.0.md
index 774e426..9a9014b 100644
--- a/docs/04-UserManuals/github-user-guide-v0.10.0.md
+++ b/docs/UserManuals/github-user-guide-v0.10.0.md
@@ -1,5 +1,6 @@
---
title: "GitHub User Guide v0.10.0"
+sidebar_position: 4
description: >
GitHub User Guide v0.10.0
---
diff --git a/docs/04-UserManuals/recurring-pipeline.md b/docs/UserManuals/recurring-pipeline.md
similarity index 94%
rename from docs/04-UserManuals/recurring-pipeline.md
rename to docs/UserManuals/recurring-pipeline.md
index bfa85dd..3e92349 100644
--- a/docs/04-UserManuals/recurring-pipeline.md
+++ b/docs/UserManuals/recurring-pipeline.md
@@ -1,5 +1,6 @@
---
title: "Create Recurring Pipelines"
+sidebar_position: 3
description: >
Create Recurring Pipelines
---