You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zh...@apache.org on 2022/08/24 15:12:53 UTC
[incubator-devlake-website] branch main updated: docs: rearranged docs (#175)
This is an automated email from the ASF dual-hosted git repository.
zhangliang2022 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 91834c07 docs: rearranged docs (#175)
91834c07 is described below
commit 91834c07193b43c13ac88ee64a671bab8cebe140
Author: Yumeng Wang <yu...@merico.dev>
AuthorDate: Wed Aug 24 23:12:49 2022 +0800
docs: rearranged docs (#175)
* docs: rearranged docs
* fix: fixed two dead links
---
docs/DataModels/DevLakeDomainLayerSchema.md | 2 +-
docs/DataModels/_category_.json | 6 +++++-
docs/DeveloperManuals/_category_.json | 6 +++++-
docs/{QuickStart => GettingStarted}/DockerComposeSetup.md | 2 +-
docs/{QuickStart => GettingStarted}/HelmSetup.md | 0
docs/{QuickStart => GettingStarted}/KubernetesSetup.md | 0
docs/{QuickStart => GettingStarted}/TemporalSetup.md | 0
docs/GettingStarted/_category_.json | 8 ++++++++
docs/Glossary.md | 9 +++------
docs/LiveDemo/_category_.json | 6 +++++-
docs/Metrics/_category_.json | 5 +++--
docs/Overview/Introduction.md | 4 ++--
docs/Overview/_category_.json | 6 +++++-
docs/Plugins/_category_.json | 6 +++++-
docs/QuickStart/_category_.json | 4 ----
docs/{DataModels/DataSupport.md => SupportedDataSources.md} | 4 ++--
docs/UserManuals/_category_.json | 6 +++++-
docusaurus.config.js | 8 ++++----
18 files changed, 54 insertions(+), 28 deletions(-)
diff --git a/docs/DataModels/DevLakeDomainLayerSchema.md b/docs/DataModels/DevLakeDomainLayerSchema.md
index 3e63afe7..00896bef 100644
--- a/docs/DataModels/DevLakeDomainLayerSchema.md
+++ b/docs/DataModels/DevLakeDomainLayerSchema.md
@@ -15,7 +15,7 @@ Domain layer schema itself includes 2 logical layers: a `DWD` layer and a `DWM`
## Use Cases
-1. [All metrics](../category/metrics) from pre-built dashboards are based on this data schema.
+1. [All metrics](../Metrics) from pre-built dashboards are based on this data schema.
2. As a user, you can create your own customized dashboards based on this data schema.
3. As a contributor, you can refer to this data schema while working on the ETL logic when adding/updating data source plugins.
diff --git a/docs/DataModels/_category_.json b/docs/DataModels/_category_.json
index 7420a65e..ae28c626 100644
--- a/docs/DataModels/_category_.json
+++ b/docs/DataModels/_category_.json
@@ -1,4 +1,8 @@
{
"label": "Data Models",
- "position": 7
+ "position": 6,
+ "link":{
+ "type": "generated-index",
+ "slug": "DataModels"
+ }
}
diff --git a/docs/DeveloperManuals/_category_.json b/docs/DeveloperManuals/_category_.json
index 4c436332..f921ae47 100644
--- a/docs/DeveloperManuals/_category_.json
+++ b/docs/DeveloperManuals/_category_.json
@@ -1,4 +1,8 @@
{
"label": "Developer Manuals",
- "position": 6
+ "position": 8,
+ "link":{
+ "type": "generated-index",
+ "slug": "DeveloperManuals"
+ }
}
diff --git a/docs/QuickStart/DockerComposeSetup.md b/docs/GettingStarted/DockerComposeSetup.md
similarity index 95%
rename from docs/QuickStart/DockerComposeSetup.md
rename to docs/GettingStarted/DockerComposeSetup.md
index 292308e3..bde5053e 100644
--- a/docs/QuickStart/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -25,7 +25,7 @@ sidebar_position: 1
- Please follow the [turorial](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](../DataModels/DataSupport.md) stored in our database.
+ - We use [Grafana](https://grafana.com/) as a visualization tool to build charts for the [data](../SupportedDataSources.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](../UserManuals/Dashboards/GrafanaUserGuide.md).
diff --git a/docs/QuickStart/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
similarity index 100%
rename from docs/QuickStart/HelmSetup.md
rename to docs/GettingStarted/HelmSetup.md
diff --git a/docs/QuickStart/KubernetesSetup.md b/docs/GettingStarted/KubernetesSetup.md
similarity index 100%
rename from docs/QuickStart/KubernetesSetup.md
rename to docs/GettingStarted/KubernetesSetup.md
diff --git a/docs/QuickStart/TemporalSetup.md b/docs/GettingStarted/TemporalSetup.md
similarity index 100%
rename from docs/QuickStart/TemporalSetup.md
rename to docs/GettingStarted/TemporalSetup.md
diff --git a/docs/GettingStarted/_category_.json b/docs/GettingStarted/_category_.json
new file mode 100644
index 00000000..063400ae
--- /dev/null
+++ b/docs/GettingStarted/_category_.json
@@ -0,0 +1,8 @@
+{
+ "label": "Getting Started",
+ "position": 2,
+ "link":{
+ "type": "generated-index",
+ "slug": "GettingStarted"
+ }
+}
diff --git a/docs/Glossary.md b/docs/Glossary.md
index 6d516b9f..c3bad3dc 100644
--- a/docs/Glossary.md
+++ b/docs/Glossary.md
@@ -1,10 +1,7 @@
---
-sidebar_position: 10
+sidebar_position: 7
title: "Glossary"
linkTitle: "Glossary"
-tags: []
-categories: []
-weight: 6
description: >
DevLake Glossary
---
@@ -46,7 +43,7 @@ You can set up a new data connection either during the first step of creating a
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](./DataModels/DataSupport.md).
+To learn more about the default data scope of all data sources and data plugins, please refer to [Supported Data Sources](./SupportedDataSources.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.**
@@ -81,7 +78,7 @@ 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](./DataModels/DataSupport.md).
+For detailed information about the relationship between data sources and data plugins, please refer to [Supported Data Sources](./SupportedDataSources.md).
### Pipelines
diff --git a/docs/LiveDemo/_category_.json b/docs/LiveDemo/_category_.json
index 65d519fa..b6dd7fd6 100644
--- a/docs/LiveDemo/_category_.json
+++ b/docs/LiveDemo/_category_.json
@@ -1,4 +1,8 @@
{
"label": "Live Demo",
- "position": 11
+ "position": 11,
+ "link":{
+ "type": "generated-index",
+ "slug": "LiveDemo"
+ }
}
diff --git a/docs/Metrics/_category_.json b/docs/Metrics/_category_.json
index c0404058..e944147d 100644
--- a/docs/Metrics/_category_.json
+++ b/docs/Metrics/_category_.json
@@ -1,7 +1,8 @@
{
"label": "Metrics",
- "position": 4,
+ "position": 5,
"link":{
- "type": "generated-index"
+ "type": "generated-index",
+ "slug": "Metrics"
}
}
diff --git a/docs/Overview/Introduction.md b/docs/Overview/Introduction.md
index 3fe079ed..4b692ff2 100755
--- a/docs/Overview/Introduction.md
+++ b/docs/Overview/Introduction.md
@@ -11,12 +11,12 @@ Apache DevLake is designed for developer teams looking to make better sense of t
## What can be accomplished with DevLake?
1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard [data model](../DataModels/DevLakeDomainLayerSchema.md).
-2. Visualize out-of-the-box [engineering metrics](../category/metrics) in a series of use-case driven dashboards
+2. Visualize out-of-the-box [engineering metrics](../Metrics) in a series of use-case driven dashboards
3. Easily extend DevLake to support your data sources, metrics, and dashboards with a flexible [framework](Architecture.md) for data collection and ETL (Extract, Transform, Load).
## How do I use DevLake?
### 1. Set up DevLake
-You can easily set up Apache DevLake by following our step-by step instructions for [Docker Compose setup](../QuickStart/DockerComposeSetup.md) or [Kubernetes setup](../QuickStart/KubernetesSetup.md).
+You can easily set up Apache DevLake by following our step-by step instructions for [Docker Compose setup](../GettingStarted/DockerComposeSetup.md) or [Kubernetes setup](../GettingStarted/KubernetesSetup.md).
### 2. Create a Blueprint
The DevLake Configuration UI will guide you through the process (a Blueprint) to define the data connections, data scope, transformation and sync frequency of the data you wish to collect.
diff --git a/docs/Overview/_category_.json b/docs/Overview/_category_.json
index e224ed81..3e819ddc 100644
--- a/docs/Overview/_category_.json
+++ b/docs/Overview/_category_.json
@@ -1,4 +1,8 @@
{
"label": "Overview",
- "position": 1
+ "position": 1,
+ "link":{
+ "type": "generated-index",
+ "slug": "Overview"
+ }
}
diff --git a/docs/Plugins/_category_.json b/docs/Plugins/_category_.json
index 72c1aa5f..bbea8d59 100644
--- a/docs/Plugins/_category_.json
+++ b/docs/Plugins/_category_.json
@@ -1,4 +1,8 @@
{
"label": "Plugins",
- "position": 9
+ "position": 9,
+ "link":{
+ "type": "generated-index",
+ "slug": "Plugins"
+ }
}
diff --git a/docs/QuickStart/_category_.json b/docs/QuickStart/_category_.json
deleted file mode 100644
index 877a378f..00000000
--- a/docs/QuickStart/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Getting Started",
- "position": 2
-}
diff --git a/docs/DataModels/DataSupport.md b/docs/SupportedDataSources.md
similarity index 98%
rename from docs/DataModels/DataSupport.md
rename to docs/SupportedDataSources.md
index a92e8d76..12bdc1a3 100644
--- a/docs/DataModels/DataSupport.md
+++ b/docs/SupportedDataSources.md
@@ -2,7 +2,7 @@
title: "Supported Data Sources"
description: >
Data sources that DevLake supports
-sidebar_position: 1
+sidebar_position: 4
---
@@ -23,7 +23,7 @@ DevLake supports the following data sources. The data from each data source is c
## Data Collection Scope By Each Plugin
-This table shows the entities collected by each plugin. Domain layer entities in this table are consistent with the entities [here](./DevLakeDomainLayerSchema.md).
+This table shows the entities collected by each plugin. Domain layer entities in this table are consistent with the entities [here](./DataModels/DevLakeDomainLayerSchema.md).
| Domain Layer Entities | ae | gitextractor | github | gitlab | jenkins | jira | refdiff | tapd |
| --------------------- | -------------- | ------------ | -------------- | ------- | ------- | ------- | ------- | ------- |
diff --git a/docs/UserManuals/_category_.json b/docs/UserManuals/_category_.json
index b47bdfd7..23ce768a 100644
--- a/docs/UserManuals/_category_.json
+++ b/docs/UserManuals/_category_.json
@@ -1,4 +1,8 @@
{
"label": "User Manuals",
- "position": 3
+ "position": 3,
+ "link":{
+ "type": "generated-index",
+ "slug": "UserManuals"
+ }
}
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 55ed8b63..f6d3a841 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -184,8 +184,8 @@ const versions = require('./versions.json');
title: 'Docs',
items: [
{
- label: 'Quick Start',
- to: 'docs/QuickStart/DockerComposeSetup',
+ label: 'Getting Started',
+ to: 'docs/GettingStarted',
},
{
label: 'Data Models',
@@ -193,11 +193,11 @@ const versions = require('./versions.json');
},
{
label: 'Engineering Metrics',
- to: 'docs/category/Metrics',
+ to: 'docs/Metrics',
},
{
label: 'Dashboards (Live Demo)',
- to: 'docs/LiveDemo/GitHubBasic',
+ to: 'docs/LiveDemo',
},
],
},