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
commit bb9b82908bf313c2b00af007ec2f2708f188f5d6 Author: yumengwang03 <[email protected]> AuthorDate: Wed Jul 13 22:45:59 2022 +0800 docs: updated versioning and tidied up docs --- .../index.md" | 2 +- community/Team/team.md | 30 +++--- .../make-contribution/fix-or-create-issues.md | 4 +- .../{02-DataSupport.md => DataSupport.md} | 7 +- .../DataModels/DevLakeDomainLayerSchema.md | 7 +- .../DeveloperManuals/DBMigration.md | 9 +- docs/DeveloperManuals/Dal.md | 2 +- .../DeveloperManuals/DeveloperSetup.md | 23 ++--- .../{NOTIFICATION.md => Notifications.md} | 3 +- .../{PluginCreate.md => PluginImplementation.md} | 6 +- docs/Glossary.md | 10 +- docs/Overview/01-WhatIsDevLake.md | 41 -------- .../Overview/Architecture.md | 8 +- .../Overview/Introduction.md | 18 ++-- docs/Overview/{03-Roadmap.md => Roadmap.md} | 11 +-- docs/Plugins/feishu.md | 2 - docs/Plugins/gitee.md | 2 - docs/Plugins/gitextractor.md | 6 +- docs/Plugins/github.md | 3 +- docs/Plugins/jenkins.md | 2 - docs/Plugins/refdiff.md | 2 - docs/Plugins/tapd.md | 6 +- .../{02-KubernetesSetup.md => KubernetesSetup.md} | 7 +- .../QuickStart/{01-LocalSetup.md => LocalSetup.md} | 27 +++--- .../UserManuals/AdvancedMode.md | 4 +- .../UserManuals/GitHubUserGuide.md | 6 +- .../UserManuals/GrafanaUserGuide.md | 4 +- ...recurring-pipeline.md => RecurringPipelines.md} | 4 +- ...-feature-user-guide.md => TeamConfiguration.md} | 18 ++-- .../{03-TemporalSetup.md => TemporalSetup.md} | 0 docusaurus.config.js | 10 +- src/components/HomepageFeatures.js | 6 +- static/img/{ => Architecture}/arch-component.svg | 0 static/img/{ => Architecture}/arch-dataflow.svg | 0 .../img/Community}/contributors/abhishek.jpeg | Bin .../img/Community}/contributors/anshimin.jpeg | Bin .../img/Community}/contributors/chengeyu.jpeg | Bin .../img/Community}/contributors/jibin.jpeg | Bin .../img/Community}/contributors/keonamini.jpeg | Bin .../img/Community}/contributors/lijiageng.jpeg | Bin .../img/Community}/contributors/lizhenlei.jpeg | Bin .../img/Community}/contributors/nikitakoselec.jpeg | Bin .../img/Community}/contributors/prajwalborkar.jpeg | Bin .../img/Community}/contributors/songdunyu.jpeg | Bin .../img/Community}/contributors/supeng.jpeg | Bin .../img/Community}/contributors/tanguiping.jpeg | Bin .../img/Community}/contributors/wangdanna.jpeg | Bin .../img/Community}/contributors/wangxiaolei.jpeg | Bin .../img/Community}/contributors/zhangxiangyu.jpeg | Bin .../screenshots/issue_page_screenshot.png | Bin .../img/{ => DomainLayerSchema}/schema-diagram.png | Bin static/img/{ => Glossary}/blueprint-erd.svg | 0 static/img/{ => Glossary}/pipeline-erd.svg | 0 static/img/{ => Homepage}/HighlyFlexible.svg | 0 static/img/{ => Homepage}/OutoftheboxAnalysis.svg | 0 static/img/{ => Homepage}/SilosConnected.svg | 0 static/img/{ => Introduction}/userflow1.svg | 0 static/img/{ => Introduction}/userflow2.svg | 0 static/img/{ => Introduction}/userflow3.png | Bin static/img/{ => Introduction}/userflow4.png | Bin static/img/{ => Plugins}/github-demo.png | Bin static/img/{ => Plugins}/jenkins-demo.png | Bin static/img/{ => Plugins}/jira-demo.png | Bin static/img/{ => Team}/teamflow1.png | Bin static/img/{ => Team}/teamflow2.png | Bin static/img/{ => Team}/teamflow3.png | Bin static/img/{ => Team}/teamflow4.png | Bin static/img/{ => Team}/teamflow5.png | Bin static/img/{ => Team}/teamflow6.png | Bin static/img/{ => Team}/teamflow7.png | Bin static/img/tutorial/docsVersionDropdown.png | Bin 25102 -> 0 bytes static/img/tutorial/localeDropdown.png | Bin 30020 -> 0 bytes versioned_docs/version-0.11/Glossary.md | 106 --------------------- .../Dashboards/AverageRequirementLeadTime.md | 0 .../Dashboards/CommitCountByAuthor.md | 0 .../Dashboards/DetailedBugInfo.md | 0 .../Dashboards/GitHubBasic.md | 0 .../GitHubReleaseQualityAndContributionAnalysis.md | 0 .../Dashboards/Jenkins.md | 0 .../Dashboards/WeeklyBugRetro.md | 0 .../Dashboards/_category_.json | 0 .../DataModels/DataSupport.md} | 7 +- .../DataModels/DevLakeDomainLayerSchema.md | 7 +- .../DataModels/_category_.json | 0 .../DeveloperManuals/DBMigration.md | 9 +- .../DeveloperManuals/Dal.md | 2 +- .../DeveloperManuals/DeveloperSetup.md | 23 ++--- .../DeveloperManuals/Notifications.md} | 3 +- .../DeveloperManuals/PluginImplementation.md} | 6 +- .../DeveloperManuals/_category_.json | 0 .../EngineeringMetrics.md | 0 .../version-v0.11.0/Overview/Architecture.md | 10 +- .../version-v0.11.0/Overview/Introduction.md | 16 ++++ .../Overview/Roadmap.md} | 11 +-- .../Overview/_category_.json | 0 .../dbt.md => version-v0.11.0/Plugins/Dbt.md} | 0 .../Plugins/Feishu.md} | 2 - .../Plugins/GitExtractor.md} | 6 +- .../Plugins/GitHub.md} | 3 +- .../Plugins/GitLab.md} | 0 .../gitee.md => version-v0.11.0/Plugins/Gitee.md} | 2 - .../Plugins/Jenkins.md} | 2 - .../jira.md => version-v0.11.0/Plugins/Jira.md} | 0 .../Plugins/RefDiff.md} | 2 - .../tapd.md => version-v0.11.0/Plugins/Tapd.md} | 6 +- .../Plugins/_category_.json | 0 .../Plugins/github-connection-in-config-ui.png | Bin .../Plugins/gitlab-connection-in-config-ui.png | Bin .../Plugins/jira-connection-config-ui.png | Bin .../Plugins/jira-more-setting-in-config-ui.png | Bin .../QuickStart/KubernetesSetup.md} | 7 +- .../QuickStart/LocalSetup.md} | 27 +++--- .../QuickStart/_category_.json | 0 .../version-v0.11.0/UserManuals/AdvancedMode.md | 4 +- .../version-v0.11.0/UserManuals/GitHubUserGuide.md | 6 +- .../UserManuals/GrafanaUserGuide.md | 4 +- .../UserManuals/RecurringPipelines.md} | 4 +- .../UserManuals/TeamConfiguration.md | 18 ++-- .../UserManuals/TemporalSetup.md} | 0 .../UserManuals/_category_.json | 0 ...sidebars.json => version-v0.11.0-sidebars.json} | 0 versions.json | 2 +- 122 files changed, 212 insertions(+), 373 deletions(-) diff --git "a/blog/2022-05-20-\345\246\202\344\275\225\350\264\241\347\214\256issues/index.md" "b/blog/2022-05-20-\345\246\202\344\275\225\350\264\241\347\214\256issues/index.md" index 9975a38..0e77e64 100644 --- "a/blog/2022-05-20-\345\246\202\344\275\225\350\264\241\347\214\256issues/index.md" +++ "b/blog/2022-05-20-\345\246\202\344\275\225\350\264\241\347\214\256issues/index.md" @@ -19,7 +19,7 @@ tags: [devlake, apache] ### 怎么做呢？这很简单! 进入我们的[问题页面](https://github.com/apache/incubator-devlake/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)，然后点击这里。我们所有的Good First Issue都列在这里! - + - 首先，寻找现有的issues，找到一个你喜欢的。 你可以通过评论"I'll take it!"来预订它。 diff --git a/community/Team/team.md b/community/Team/team.md index b3e8069..f8cd190 100644 --- a/community/Team/team.md +++ b/community/Team/team.md @@ -59,19 +59,19 @@ get merged into the codebase. We deeply appreciate your contribution! --- - + #### Danna Wang --- - + #### Geyu Chen --- - + ### New Contributors May 2022 @@ -79,70 +79,70 @@ get merged into the codebase. We deeply appreciate your contribution! --- - + #### Xiangyu Zhang --- - + #### Xiaolei Wang --- - + #### Peng Su --- - + #### Dunyu Song --- - + #### Nikita Koselev --- - + #### Shimin An --- - + #### Abhishek KM --- - + #### Guiping Tan --- - + #### Bin Ji --- - + #### Prajwal Borkar --- - + #### Keon Amini --- - + diff --git a/community/make-contribution/fix-or-create-issues.md b/community/make-contribution/fix-or-create-issues.md index 8cfce72..2ff9398 100644 --- a/community/make-contribution/fix-or-create-issues.md +++ b/community/make-contribution/fix-or-create-issues.md @@ -2,8 +2,6 @@ sidebar_position: 02 title: "Contributing to Issues" --- -# Contributing to Issues -> @Klesh Last week(2022-05-12), we had 2 designated Good First Issues listed out for everyone in a First Come, First Served manner, which was fun, and they were taken almost instantly... @@ -14,7 +12,7 @@ you like from our github issue pages, or even create your own one if no more lef We are community after all! Now, how do we proceed? It's simple! Go to our [issues page](https://github.com/apache/incubator-devlake/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and then click here. all our Good First Issue are listed out here. - + - Firstly, go for existing issues if any, find one that you like, you can claim it by sending comment like "I'll take it", diff --git a/docs/DataModels/02-DataSupport.md b/docs/DataModels/DataSupport.md similarity index 98% rename from docs/DataModels/02-DataSupport.md rename to docs/DataModels/DataSupport.md index 7067da1..4cb4b61 100644 --- a/docs/DataModels/02-DataSupport.md +++ b/docs/DataModels/DataSupport.md @@ -1,11 +1,8 @@ --- title: "Data Support" -linkTitle: "Data Support" -tags: [] -categories: [] -weight: 2 description: > Data sources that DevLake supports +sidebar_position: 1 --- @@ -26,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](./01-DevLakeDomainLayerSchema.md). +This table shows the entities collected by each plugin. Domain layer entities in this table are consistent with the entities [here](./DevLakeDomainLayerSchema.md). | Domain Layer Entities | ae | gitextractor | github | gitlab | jenkins | jira | refdiff | tapd | | --------------------- | -------------- | ------------ | -------------- | ------- | ------- | ------- | ------- | ------- | diff --git a/versioned_docs/version-0.11/DataModels/01-DevLakeDomainLayerSchema.md b/docs/DataModels/DevLakeDomainLayerSchema.md similarity index 99% rename from versioned_docs/version-0.11/DataModels/01-DevLakeDomainLayerSchema.md rename to docs/DataModels/DevLakeDomainLayerSchema.md index 2ffa512..996d397 100644 --- a/versioned_docs/version-0.11/DataModels/01-DevLakeDomainLayerSchema.md +++ b/docs/DataModels/DevLakeDomainLayerSchema.md @@ -1,11 +1,8 @@ --- title: "Domain Layer Schema" -linkTitle: "Domain Layer Schema" -tags: [] -categories: [] -weight: 50000 description: > DevLake Domain Layer Schema +sidebar_position: 2 --- ## Summary @@ -33,7 +30,7 @@ This is the up-to-date domain layer schema for DevLake v0.10.x. Tables (entities ### Schema Diagram - + When reading the schema, you'll notice that many tables' primary key is called `id`. Unlike auto-increment id or UUID, `id` is a string composed of several parts to uniquely identify similar entities (e.g. repo) from different platforms (e.g. Github/Gitlab) and allow them to co-exist in a single table. diff --git a/versioned_docs/version-0.11/DeveloperManuals/MIGRATIONS.md b/docs/DeveloperManuals/DBMigration.md similarity index 94% rename from versioned_docs/version-0.11/DeveloperManuals/MIGRATIONS.md rename to docs/DeveloperManuals/DBMigration.md index edab4ca..9530237 100644 --- a/versioned_docs/version-0.11/DeveloperManuals/MIGRATIONS.md +++ b/docs/DeveloperManuals/DBMigration.md @@ -2,17 +2,16 @@ title: "DB Migration" description: > DB Migration +sidebar_position: 3 --- -# Migrations (Database) - ## Summary Starting in v0.10.0, DevLake provides a lightweight migration tool for executing migration scripts. Both framework itself and plugins define their migration scripts in their own migration folder. The migration scripts are written with gorm in Golang to support different SQL dialects. -## Migration script +## Migration Script Migration script describes how to do database migration. They implement the `Script` interface. When DevLake starts, scripts register themselves to the framework by invoking the `Register` function @@ -29,7 +28,9 @@ type Script interface { The table tracks migration scripts execution and schemas changes. From which, DevLake could figure out the current state of database schemas. -## How it Works + + +## How It Works 1. Check `migration_history` table, calculate all the migration scripts need to be executed. 2. Sort scripts by Version in ascending order. 3. Execute scripts. diff --git a/docs/DeveloperManuals/Dal.md b/docs/DeveloperManuals/Dal.md index da27a55..9b08542 100644 --- a/docs/DeveloperManuals/Dal.md +++ b/docs/DeveloperManuals/Dal.md @@ -1,6 +1,6 @@ --- title: "Dal" -sidebar_position: 4 +sidebar_position: 5 description: > The Dal (Data Access Layer) is designed to decouple the hard dependency on `gorm` in v0.12 --- diff --git a/versioned_docs/version-0.11/DeveloperManuals/04-DeveloperSetup.md b/docs/DeveloperManuals/DeveloperSetup.md similarity index 87% rename from versioned_docs/version-0.11/DeveloperManuals/04-DeveloperSetup.md rename to docs/DeveloperManuals/DeveloperSetup.md index cb27440..4b05c11 100644 --- a/versioned_docs/version-0.11/DeveloperManuals/04-DeveloperSetup.md +++ b/docs/DeveloperManuals/DeveloperSetup.md @@ -2,10 +2,11 @@ title: "Developer Setup" description: > The steps to install DevLake in develper mode. +sidebar_position: 1 --- -#### Requirements +## Requirements - <a href="https://docs.docker.com/get-docker"; target="_blank">Docker v19.03.10+</a> - <a href="https://golang.org/doc/install"; target="_blank">Golang v1.17+</a> @@ -14,7 +15,7 @@ description: > - Windows: [Download](http://gnuwin32.sourceforge.net/packages/make.htm) - Ubuntu: `sudo apt-get install build-essential libssl-dev` -#### How to setup dev environment +## How to setup dev environment 1. Navigate to where you would like to install this project and clone the repository: ```sh @@ -24,7 +25,7 @@ description: > 2. Install dependencies for plugins: - - [RefDiff](../Plugins/refdiff.md#development) + - [RefDiff](../Plugins/RefDiff.md#development) 3. Install Go packages @@ -75,10 +76,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](../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. + - [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/GitHubUserGuide.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. @@ -111,14 +112,14 @@ description: > ] ``` - Please refer to [Pipeline Advanced Mode](../UserManuals/create-pipeline-in-advanced-mode.md) for in-depth explanation. + Please refer to [Pipeline Advanced Mode](../UserManuals/AdvancedMode.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](../UserManuals/GRAFANA.md). + All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GrafanaUserGuide.md). 11. (Optional) To run the tests: @@ -126,5 +127,5 @@ description: > make test ``` -12. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/MIGRATIONS.md). -<br/><br/><br/> +12. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/DBMigration.md). + diff --git a/docs/DeveloperManuals/NOTIFICATION.md b/docs/DeveloperManuals/Notifications.md similarity index 97% rename from docs/DeveloperManuals/NOTIFICATION.md rename to docs/DeveloperManuals/Notifications.md index d5ebd2b..23456b4 100644 --- a/docs/DeveloperManuals/NOTIFICATION.md +++ b/docs/DeveloperManuals/Notifications.md @@ -2,10 +2,9 @@ title: "Notifications" description: > Notifications +sidebar_position: 4 --- -# Notification - ## Request Example request ``` diff --git a/docs/DeveloperManuals/PluginCreate.md b/docs/DeveloperManuals/PluginImplementation.md similarity index 99% rename from docs/DeveloperManuals/PluginCreate.md rename to docs/DeveloperManuals/PluginImplementation.md index 3f2a4ce..e3457c9 100644 --- a/docs/DeveloperManuals/PluginCreate.md +++ b/docs/DeveloperManuals/PluginImplementation.md @@ -1,8 +1,8 @@ --- -title: "How to Implement a DevLake plugin?" -sidebar_position: 1 +title: "Plugin Implementation" +sidebar_position: 2 description: > - How to Implement a DevLake plugin. + Plugin Implementation --- ## How to Implement a DevLake plugin? diff --git a/docs/Glossary.md b/docs/Glossary.md index 4ca3117..9ed93e3 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -25,7 +25,7 @@ The following terms are arranged in the order of their appearance in the actual The relationship among Blueprint, Data Connections, Data Scope and Transformation Rules is explained as follows: - + - Each blueprint can have multiple data connections. - Each data connection can have multiple sets of data scope. - Each set of data scope only consists of one GitHub/GitLab project or Jira board, along with their corresponding data entities. @@ -46,14 +46,14 @@ 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/02-DataSupport.md). +To learn more about the default data scope of all data sources and data plugins, please refer to [Data Support](./DataModels/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](./DataModels/01-DevLakeDomainLayerSchema.md). +To learn more details, please refer to [Domain Layer Schema](./DataModels/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. @@ -81,14 +81,14 @@ 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/02-DataSupport.md). +For detailed information about the relationship between data sources and data plugins, please refer to [Data Support](./DataModels/DataSupport.md). ### Pipelines **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.** diff --git a/docs/Overview/01-WhatIsDevLake.md b/docs/Overview/01-WhatIsDevLake.md deleted file mode 100755 index 75c64a1..0000000 --- a/docs/Overview/01-WhatIsDevLake.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "Introduction" -description: General introduction of Apache DevLake -sidebar_position: 01 ---- - -## What is Apache DevLake? -Apache DevLake is an open-source dev data platform that ingests, analyzes, and visualizes the fragmented data from DevOps tools to distill insights for engineering productivity. - -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 DevLake? -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. - -## How do I use DevLake? -### 1. Set up DevLake -You can easily set up Apache DevLake by following our step-by step instruction for [local setup](../QuickStart/01-LocalSetup.md) or [Kubernetes setup](../QuickStart/02-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. - - - -### 3. Track the Blueprint's progress -You can track the progress of the Blueprint you have just set up. - - - -### 4. View the pre-built dashboards -Once the first run of the Blueprint is completed, you can view the corresponding dashboards. - - - -### 5. Customize the dahsboards with SQL -If the pre-built dashboards are limited for your use cases, you can always customize or create your own metrics or dashboards with SQL. - - - - diff --git a/versioned_docs/version-0.11/Overview/02-Architecture.md b/docs/Overview/Architecture.md similarity index 93% rename from versioned_docs/version-0.11/Overview/02-Architecture.md rename to docs/Overview/Architecture.md index 8daa859..d4c6a9c 100755 --- a/versioned_docs/version-0.11/Overview/02-Architecture.md +++ b/docs/Overview/Architecture.md @@ -1,13 +1,13 @@ --- title: "Architecture" -linkTitle: "Architecture" description: > - Understand the architecture of Apache DevLake. + Understand the architecture of Apache DevLake +sidebar_position: 2 --- ## Architecture Overview -<p align="center"><img src="/img/arch-component.svg" /></p> +<p align="center"><img src="/img/Architecture/arch-component.svg" /></p> <p align="center">DevLake Components</p> A DevLake installation typically consists of the following components: @@ -21,7 +21,7 @@ A DevLake installation typically consists of the following components: ## Dataflow -<p align="center"><img src="/img/arch-dataflow.svg" /></p> +<p align="center"><img src="/img/Architecture/arch-dataflow.svg" /></p> <p align="center">DevLake Dataflow</p> A typical plugin's dataflow is illustrated below: diff --git a/versioned_docs/version-0.11/Overview/01-WhatIsDevLake.md b/docs/Overview/Introduction.md similarity index 79% rename from versioned_docs/version-0.11/Overview/01-WhatIsDevLake.md rename to docs/Overview/Introduction.md index 75c64a1..9219984 100755 --- a/versioned_docs/version-0.11/Overview/01-WhatIsDevLake.md +++ b/docs/Overview/Introduction.md @@ -1,7 +1,7 @@ --- title: "Introduction" description: General introduction of Apache DevLake -sidebar_position: 01 +sidebar_position: 1 --- ## What is Apache DevLake? @@ -10,32 +10,30 @@ 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 DevLake? -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). +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](../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. +3. Easily extend DevLake to support your data sources, metrics, and dashboards with a flexible [framework](Architecture.md) for data collection and ETL. ## How do I use DevLake? ### 1. Set up DevLake -You can easily set up Apache DevLake by following our step-by step instruction for [local setup](../QuickStart/01-LocalSetup.md) or [Kubernetes setup](../QuickStart/02-KubernetesSetup.md). +You can easily set up Apache DevLake by following our step-by step instruction for [local setup](../QuickStart/LocalSetup.md) or [Kubernetes setup](../QuickStart/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. - + ### 3. Track the Blueprint's progress You can track the progress of the Blueprint you have just set up. - + ### 4. View the pre-built dashboards Once the first run of the Blueprint is completed, you can view the corresponding dashboards. - + ### 5. Customize the dahsboards with SQL If the pre-built dashboards are limited for your use cases, you can always customize or create your own metrics or dashboards with SQL. - - - + \ No newline at end of file diff --git a/docs/Overview/03-Roadmap.md b/docs/Overview/Roadmap.md similarity index 53% rename from docs/Overview/03-Roadmap.md rename to docs/Overview/Roadmap.md index f10b62e..9dcf0b3 100644 --- a/docs/Overview/03-Roadmap.md +++ b/docs/Overview/Roadmap.md @@ -1,11 +1,8 @@ --- title: "Roadmap" -linkTitle: "Roadmap" -tags: [] -categories: [] -weight: 3 description: > - The goals and roadmap for DevLake in 2022. + The goals and roadmap for DevLake in 2022 +sidebar_position: 3 --- @@ -24,8 +21,8 @@ Apache DevLake is currently under rapid development. You are more than welcome t | Category | Features| | --- | --- | -| 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 [...] +| More data sources across different [DevOps domains](../DataModels/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><li [...] +| Improved data collection, [data models](../DataModels/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 ref [...] | 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 [...] diff --git a/docs/Plugins/feishu.md b/docs/Plugins/feishu.md index f19e4b0..c3e0eb6 100644 --- a/docs/Plugins/feishu.md +++ b/docs/Plugins/feishu.md @@ -4,8 +4,6 @@ description: > Feishu Plugin --- -# Feishu - ## Summary This plugin collects Feishu meeting data through [Feishu Openapi](https://open.feishu.cn/document/home/user-identity-introduction/introduction). diff --git a/docs/Plugins/gitee.md b/docs/Plugins/gitee.md index 0c4307a..6066fd2 100644 --- a/docs/Plugins/gitee.md +++ b/docs/Plugins/gitee.md @@ -4,8 +4,6 @@ description: > Gitee Plugin --- -# Gitee - ## Summary ## Configuration diff --git a/docs/Plugins/gitextractor.md b/docs/Plugins/gitextractor.md index ac97fa3..d154e9e 100644 --- a/docs/Plugins/gitextractor.md +++ b/docs/Plugins/gitextractor.md @@ -4,8 +4,6 @@ description: > GitExtractor Plugin --- -# Git Repo Extractor - ## Summary This plugin extracts commits and references from a remote or local git repository. It then saves the data into the database or csv files. @@ -14,7 +12,7 @@ This plugin extracts commits and references from a remote or local git repositor 1. Use the Git repo extractor to retrieve data about commits and branches from your repository. 2. Use the GitHub plugin to retrieve data about Github issues and PRs from your repository. NOTE: you can run only one issue collection stage as described in the Github Plugin README. -3. Use the [RefDiff](./refdiff.md#development) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table. +3. Use the [RefDiff](./RefDiff.md#development) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table. ## Sample Request @@ -60,6 +58,6 @@ For more options (e.g., saving to a csv file instead of a db), please read `plug ## Development This plugin depends on `libgit2`, you need to install version 1.3.0 in order to run and debug this plugin on your local -machine. [Click here](./refdiff.md#development) for a brief guide. +machine. [Click here](./RefDiff.md#development) for a brief guide. <br/><br/><br/> diff --git a/docs/Plugins/github.md b/docs/Plugins/github.md index 463f9de..cca87b7 100644 --- a/docs/Plugins/github.md +++ b/docs/Plugins/github.md @@ -4,7 +4,6 @@ description: > GitHub Plugin --- -# Github ## Summary @@ -24,7 +23,7 @@ Here are some examples metrics using `GitHub` data: ## Screenshot - + ## Configuration diff --git a/docs/Plugins/jenkins.md b/docs/Plugins/jenkins.md index 26e72a6..792165d 100644 --- a/docs/Plugins/jenkins.md +++ b/docs/Plugins/jenkins.md @@ -4,8 +4,6 @@ description: > Jenkins Plugin --- -# Jenkins - ## Summary This plugin collects Jenkins data through [Remote Access API](https://www.jenkins.io/doc/book/using/remote-access-api/). It then computes and visualizes various DevOps metrics from the Jenkins data. diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md index 35d3049..12950f4 100644 --- a/docs/Plugins/refdiff.md +++ b/docs/Plugins/refdiff.md @@ -4,8 +4,6 @@ description: > RefDiff Plugin --- -# RefDiff - ## Summary diff --git a/docs/Plugins/tapd.md b/docs/Plugins/tapd.md index fc93539..b8db89f 100644 --- a/docs/Plugins/tapd.md +++ b/docs/Plugins/tapd.md @@ -1,4 +1,8 @@ -# TAPD +--- +title: "TAPD" +description: > + TAPD Plugin +--- ## Summary diff --git a/docs/QuickStart/02-KubernetesSetup.md b/docs/QuickStart/KubernetesSetup.md similarity index 94% rename from docs/QuickStart/02-KubernetesSetup.md rename to docs/QuickStart/KubernetesSetup.md index 19bdc4d..e4faeba 100644 --- a/docs/QuickStart/02-KubernetesSetup.md +++ b/docs/QuickStart/KubernetesSetup.md @@ -1,7 +1,8 @@ --- -title: "Deploy to Kubernetes" +title: "Kubernetes Setup" description: > - The steps to install Apache DevLake in Kubernetes. + The steps to install Apache DevLake in Kubernetes +sidebar_position: 2 --- @@ -9,7 +10,7 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) will create a namespace `devlake` on your k8s cluster, and use `nodePort 30004` for `config-ui`, `nodePort 30002` for `grafana` dashboards. If you would like to use certain version of Apache DevLake, please update the image tag of `grafana`, `devlake` and `config-ui` services to specify versions like `v0.10.1`. -Here's the step-by-step guide: +## Step-by-step guide 1. Download [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) to local machine 2. Some key points: diff --git a/docs/QuickStart/01-LocalSetup.md b/docs/QuickStart/LocalSetup.md similarity index 72% rename from docs/QuickStart/01-LocalSetup.md rename to docs/QuickStart/LocalSetup.md index 9b81bc9..8e56a65 100644 --- a/docs/QuickStart/01-LocalSetup.md +++ b/docs/QuickStart/LocalSetup.md @@ -1,16 +1,17 @@ --- -title: "Deploy Locally" +title: "Local Setup" description: > - The steps to install DevLake locally. + The steps to install DevLake locally +sidebar_position: 1 --- -#### Prerequisites +## Prerequisites - [Docker v19.03.10+](https://docs.docker.com/get-docker) - [docker-compose v2.2.3+](https://docs.docker.com/compose/install/) -#### Launch DevLake +## Launch DevLake - Commands written `like this` are to be run in your terminal. @@ -18,25 +19,25 @@ description: > 2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. 3. Run `docker-compose up -d` to launch DevLake. -#### Configure data connections and collect data +## Configure data connections and collect data 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](../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) + - [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/GitHubUserGuide.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](../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/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](../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. + - All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GrafanaUserGuide.md). +4. To synchronize data periodically, users can set up recurring pipelines with DevLake's [pipeline blueprint](../UserManuals/RecurringPipelines.md) for details. -#### Upgrade to a newer version +## 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. diff --git a/versioned_docs/version-0.11/UserManuals/create-pipeline-in-advanced-mode.md b/docs/UserManuals/AdvancedMode.md similarity index 97% rename from versioned_docs/version-0.11/UserManuals/create-pipeline-in-advanced-mode.md rename to docs/UserManuals/AdvancedMode.md index 14afd01..4323133 100644 --- a/versioned_docs/version-0.11/UserManuals/create-pipeline-in-advanced-mode.md +++ b/docs/UserManuals/AdvancedMode.md @@ -1,8 +1,8 @@ --- -title: "Create Pipeline in Advanced Mode" +title: "Advanced Mode" sidebar_position: 2 description: > - Create Pipeline in Advanced Mode + Advanced Mode --- diff --git a/versioned_docs/version-0.11/UserManuals/github-user-guide-v0.10.0.md b/docs/UserManuals/GitHubUserGuide.md similarity index 97% rename from versioned_docs/version-0.11/UserManuals/github-user-guide-v0.10.0.md rename to docs/UserManuals/GitHubUserGuide.md index 9a9014b..fa67456 100644 --- a/versioned_docs/version-0.11/UserManuals/github-user-guide-v0.10.0.md +++ b/docs/UserManuals/GitHubUserGuide.md @@ -1,8 +1,8 @@ --- -title: "GitHub User Guide v0.10.0" +title: "GitHub User Guide" sidebar_position: 4 description: > - GitHub User Guide v0.10.0 + GitHub User Guide --- ## Summary @@ -109,7 +109,7 @@ See the pipeline finishes (progress 100%): ### Step 4 - [Optional] Set up a recurring pipeline to keep data fresh -Please see [How to create recurring pipelines](./recurring-pipeline.md) for details. +Please see [How to create recurring pipelines](./RecurringPipelines.md) for details. diff --git a/versioned_docs/version-0.11/UserManuals/GRAFANA.md b/docs/UserManuals/GrafanaUserGuide.md similarity index 99% rename from versioned_docs/version-0.11/UserManuals/GRAFANA.md rename to docs/UserManuals/GrafanaUserGuide.md index bd81651..e475702 100644 --- a/versioned_docs/version-0.11/UserManuals/GRAFANA.md +++ b/docs/UserManuals/GrafanaUserGuide.md @@ -1,8 +1,8 @@ --- -title: "How to use Grafana" +title: "Grafana User Guide" sidebar_position: 1 description: > - How to use Grafana + Grafana User Guide --- diff --git a/docs/UserManuals/recurring-pipeline.md b/docs/UserManuals/RecurringPipelines.md similarity index 91% rename from docs/UserManuals/recurring-pipeline.md rename to docs/UserManuals/RecurringPipelines.md index 3e92349..ce82b1e 100644 --- a/docs/UserManuals/recurring-pipeline.md +++ b/docs/UserManuals/RecurringPipelines.md @@ -1,8 +1,8 @@ --- -title: "Create Recurring Pipelines" +title: "Recurring Pipelines" sidebar_position: 3 description: > - Create Recurring Pipelines + Recurring Pipelines --- ## How to create recurring pipelines? diff --git a/docs/UserManuals/team-feature-user-guide.md b/docs/UserManuals/TeamConfiguration.md similarity index 94% copy from docs/UserManuals/team-feature-user-guide.md copy to docs/UserManuals/TeamConfiguration.md index 07a080b..4646ffa 100644 --- a/docs/UserManuals/team-feature-user-guide.md +++ b/docs/UserManuals/TeamConfiguration.md @@ -1,8 +1,8 @@ --- -title: "Team Feature User Guide" +title: "Team Configuration" sidebar_position: 6 description: > - Team Feature User Guide + Team Configuration --- ## Summary This is a brief step-by-step guide to using the team feature. @@ -31,7 +31,7 @@ b. The actual api request. iii. After successful execution, the teams table is generated and the data can be seen in the database table teams. (Notes: how to connect to the database: mainly through host, port, username, password, and then through sql tools, such as sequal ace, datagrip and other data, of course you can also access through the command line mysql -h `ip` -u `username` -p -P `port`) - + ## Step 2 - Construct user tables (roster) @@ -52,11 +52,11 @@ b. The actual api request. iii. After successful execution, the users table is generated and the data can be seen in the database table users. - + iv. Generated the team_users table, you can see the data in the team_users table. - + ## Step 3 - Update users if you need If there is a problem with team_users association or data in users, just re-put users api interface, i.e. (b in step 2 above) @@ -64,7 +64,7 @@ If there is a problem with team_users association or data in users, just re-put ## Step 4 - Collect accounts accounts table is collected by users through devlake. You can see the accounts table information in the database. - + ## Step 5 - Automatically match existing accounts and users through api requests @@ -91,7 +91,7 @@ curl --location --request POST '127.0.0.1:8080/pipelines' \ b. After successful execution, the user_accounts table is generated, and you can see the data in table user_accounts. - + ## Step 6 - Get user_accountsr relationship After generating the user_accounts relationship, the user can get the associated data through the GET method to confirm whether the data user and account match correctly and whether the matched accounts are complete. @@ -103,7 +103,7 @@ b. The corresponding curl command: curl --location --request GET 'http://127.0.0.1:8080/plugins/org/user_account_mapping.csv' ``` - + c. You can also use sql statements to determine, here to provide a sql statement for reference only. ``` @@ -123,7 +123,7 @@ curl --location --request PUT 'http://127.0.0.1:8080/plugins/org/user_account_ma b. You can see that the data in the user_accounts table has been updated. - + **The above is the flow of user usage for the whole team feature.** diff --git a/docs/UserManuals/03-TemporalSetup.md b/docs/UserManuals/TemporalSetup.md similarity index 100% rename from docs/UserManuals/03-TemporalSetup.md rename to docs/UserManuals/TemporalSetup.md diff --git a/docusaurus.config.js b/docusaurus.config.js index 0046c50..11340ad 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -87,21 +87,21 @@ const versions = require('./versions.json'); items: [ { // type: 'docsVersionDropdown', - // docId: 'Overview/WhatIsDevLake', + // docId: 'Overview/Introduction', position: 'right', label: 'Docs', items: [ ...versions.slice(0, versions.length - 2).map((version) => ({ label: version, - to: `docs/${version}/Overview/WhatIsDevLake`, + to: `docs/${version}/Overview/Introduction`, })), ...versions.slice(versions.length - 2, versions.length).map((version) => ({ label: (version === "1.x") ? "1.x(Not Apache Release)" : version, - to: `docs/${version}/Overview/WhatIsDevLake`, + to: `docs/${version}/Overview/Introduction`, })), { - label: "Next", - to: "/docs/Overview/WhatIsDevLake", + label: "Latest", + to: "/docs/Overview/Introduction", } ] }, diff --git a/src/components/HomepageFeatures.js b/src/components/HomepageFeatures.js index 5bdfa41..2914a93 100644 --- a/src/components/HomepageFeatures.js +++ b/src/components/HomepageFeatures.js @@ -5,7 +5,7 @@ import styles from './HomepageFeatures.module.css'; const FeatureList = [ { title: 'Data Silos Connected', - Svg: require('../../static/img/SilosConnected.svg').default, + Svg: require('../../static/img/Homepage/SilosConnected.svg').default, description: ( <> Collect DevOps data across the entire Software Development LifeCycle (SDLC) and connect siloed data with a standard data model @@ -14,7 +14,7 @@ const FeatureList = [ }, { title: 'Out-of-the-box Analysis', - Svg: require('../../static/img/OutoftheboxAnalysis.svg').default, + Svg: require('../../static/img/Homepage/OutoftheboxAnalysis.svg').default, description: ( <> Visualize out-of-the-box engineering metrics in a series of use-case driven dashboards @@ -23,7 +23,7 @@ const FeatureList = [ }, { title: 'A Highly Flexible Framework', - Svg: require('../../static/img/HighlyFlexible.svg').default, + Svg: require('../../static/img/Homepage/HighlyFlexible.svg').default, description: ( <> Easily extend DevLake to support your data sources, metrics, and dashboards diff --git a/static/img/arch-component.svg b/static/img/Architecture/arch-component.svg similarity index 100% rename from static/img/arch-component.svg rename to static/img/Architecture/arch-component.svg diff --git a/static/img/arch-dataflow.svg b/static/img/Architecture/arch-dataflow.svg similarity index 100% rename from static/img/arch-dataflow.svg rename to static/img/Architecture/arch-dataflow.svg diff --git a/img/community/contributors/abhishek.jpeg b/static/img/Community/contributors/abhishek.jpeg similarity index 100% rename from img/community/contributors/abhishek.jpeg rename to static/img/Community/contributors/abhishek.jpeg diff --git a/img/community/contributors/anshimin.jpeg b/static/img/Community/contributors/anshimin.jpeg similarity index 100% rename from img/community/contributors/anshimin.jpeg rename to static/img/Community/contributors/anshimin.jpeg diff --git a/img/community/contributors/chengeyu.jpeg b/static/img/Community/contributors/chengeyu.jpeg similarity index 100% rename from img/community/contributors/chengeyu.jpeg rename to static/img/Community/contributors/chengeyu.jpeg diff --git a/img/community/contributors/jibin.jpeg b/static/img/Community/contributors/jibin.jpeg similarity index 100% rename from img/community/contributors/jibin.jpeg rename to static/img/Community/contributors/jibin.jpeg diff --git a/img/community/contributors/keonamini.jpeg b/static/img/Community/contributors/keonamini.jpeg similarity index 100% rename from img/community/contributors/keonamini.jpeg rename to static/img/Community/contributors/keonamini.jpeg diff --git a/img/community/contributors/lijiageng.jpeg b/static/img/Community/contributors/lijiageng.jpeg similarity index 100% rename from img/community/contributors/lijiageng.jpeg rename to static/img/Community/contributors/lijiageng.jpeg diff --git a/img/community/contributors/lizhenlei.jpeg b/static/img/Community/contributors/lizhenlei.jpeg similarity index 100% rename from img/community/contributors/lizhenlei.jpeg rename to static/img/Community/contributors/lizhenlei.jpeg diff --git a/img/community/contributors/nikitakoselec.jpeg b/static/img/Community/contributors/nikitakoselec.jpeg similarity index 100% rename from img/community/contributors/nikitakoselec.jpeg rename to static/img/Community/contributors/nikitakoselec.jpeg diff --git a/img/community/contributors/prajwalborkar.jpeg b/static/img/Community/contributors/prajwalborkar.jpeg similarity index 100% rename from img/community/contributors/prajwalborkar.jpeg rename to static/img/Community/contributors/prajwalborkar.jpeg diff --git a/img/community/contributors/songdunyu.jpeg b/static/img/Community/contributors/songdunyu.jpeg similarity index 100% rename from img/community/contributors/songdunyu.jpeg rename to static/img/Community/contributors/songdunyu.jpeg diff --git a/img/community/contributors/supeng.jpeg b/static/img/Community/contributors/supeng.jpeg similarity index 100% rename from img/community/contributors/supeng.jpeg rename to static/img/Community/contributors/supeng.jpeg diff --git a/img/community/contributors/tanguiping.jpeg b/static/img/Community/contributors/tanguiping.jpeg similarity index 100% rename from img/community/contributors/tanguiping.jpeg rename to static/img/Community/contributors/tanguiping.jpeg diff --git a/img/community/contributors/wangdanna.jpeg b/static/img/Community/contributors/wangdanna.jpeg similarity index 100% rename from img/community/contributors/wangdanna.jpeg rename to static/img/Community/contributors/wangdanna.jpeg diff --git a/img/community/contributors/wangxiaolei.jpeg b/static/img/Community/contributors/wangxiaolei.jpeg similarity index 100% rename from img/community/contributors/wangxiaolei.jpeg rename to static/img/Community/contributors/wangxiaolei.jpeg diff --git a/img/community/contributors/zhangxiangyu.jpeg b/static/img/Community/contributors/zhangxiangyu.jpeg similarity index 100% rename from img/community/contributors/zhangxiangyu.jpeg rename to static/img/Community/contributors/zhangxiangyu.jpeg diff --git a/img/community/screenshots/issue_page_screenshot.png b/static/img/Community/screenshots/issue_page_screenshot.png similarity index 100% rename from img/community/screenshots/issue_page_screenshot.png rename to static/img/Community/screenshots/issue_page_screenshot.png diff --git a/static/img/schema-diagram.png b/static/img/DomainLayerSchema/schema-diagram.png similarity index 100% rename from static/img/schema-diagram.png rename to static/img/DomainLayerSchema/schema-diagram.png diff --git a/static/img/blueprint-erd.svg b/static/img/Glossary/blueprint-erd.svg similarity index 100% rename from static/img/blueprint-erd.svg rename to static/img/Glossary/blueprint-erd.svg diff --git a/static/img/pipeline-erd.svg b/static/img/Glossary/pipeline-erd.svg similarity index 100% rename from static/img/pipeline-erd.svg rename to static/img/Glossary/pipeline-erd.svg diff --git a/static/img/HighlyFlexible.svg b/static/img/Homepage/HighlyFlexible.svg similarity index 100% rename from static/img/HighlyFlexible.svg rename to static/img/Homepage/HighlyFlexible.svg diff --git a/static/img/OutoftheboxAnalysis.svg b/static/img/Homepage/OutoftheboxAnalysis.svg similarity index 100% rename from static/img/OutoftheboxAnalysis.svg rename to static/img/Homepage/OutoftheboxAnalysis.svg diff --git a/static/img/SilosConnected.svg b/static/img/Homepage/SilosConnected.svg similarity index 100% rename from static/img/SilosConnected.svg rename to static/img/Homepage/SilosConnected.svg diff --git a/static/img/userflow1.svg b/static/img/Introduction/userflow1.svg similarity index 100% rename from static/img/userflow1.svg rename to static/img/Introduction/userflow1.svg diff --git a/static/img/userflow2.svg b/static/img/Introduction/userflow2.svg similarity index 100% rename from static/img/userflow2.svg rename to static/img/Introduction/userflow2.svg diff --git a/static/img/userflow3.png b/static/img/Introduction/userflow3.png similarity index 100% rename from static/img/userflow3.png rename to static/img/Introduction/userflow3.png diff --git a/static/img/userflow4.png b/static/img/Introduction/userflow4.png similarity index 100% rename from static/img/userflow4.png rename to static/img/Introduction/userflow4.png diff --git a/static/img/github-demo.png b/static/img/Plugins/github-demo.png similarity index 100% rename from static/img/github-demo.png rename to static/img/Plugins/github-demo.png diff --git a/static/img/jenkins-demo.png b/static/img/Plugins/jenkins-demo.png similarity index 100% rename from static/img/jenkins-demo.png rename to static/img/Plugins/jenkins-demo.png diff --git a/static/img/jira-demo.png b/static/img/Plugins/jira-demo.png similarity index 100% rename from static/img/jira-demo.png rename to static/img/Plugins/jira-demo.png diff --git a/static/img/teamflow1.png b/static/img/Team/teamflow1.png similarity index 100% rename from static/img/teamflow1.png rename to static/img/Team/teamflow1.png diff --git a/static/img/teamflow2.png b/static/img/Team/teamflow2.png similarity index 100% rename from static/img/teamflow2.png rename to static/img/Team/teamflow2.png diff --git a/static/img/teamflow3.png b/static/img/Team/teamflow3.png similarity index 100% rename from static/img/teamflow3.png rename to static/img/Team/teamflow3.png diff --git a/static/img/teamflow4.png b/static/img/Team/teamflow4.png similarity index 100% rename from static/img/teamflow4.png rename to static/img/Team/teamflow4.png diff --git a/static/img/teamflow5.png b/static/img/Team/teamflow5.png similarity index 100% rename from static/img/teamflow5.png rename to static/img/Team/teamflow5.png diff --git a/static/img/teamflow6.png b/static/img/Team/teamflow6.png similarity index 100% rename from static/img/teamflow6.png rename to static/img/Team/teamflow6.png diff --git a/static/img/teamflow7.png b/static/img/Team/teamflow7.png similarity index 100% rename from static/img/teamflow7.png rename to static/img/Team/teamflow7.png diff --git a/static/img/tutorial/docsVersionDropdown.png b/static/img/tutorial/docsVersionDropdown.png deleted file mode 100644 index ff1cbe6..0000000 Binary files a/static/img/tutorial/docsVersionDropdown.png and /dev/null differ diff --git a/static/img/tutorial/localeDropdown.png b/static/img/tutorial/localeDropdown.png deleted file mode 100644 index d7163f9..0000000 Binary files a/static/img/tutorial/localeDropdown.png and /dev/null differ diff --git a/versioned_docs/version-0.11/Glossary.md b/versioned_docs/version-0.11/Glossary.md deleted file mode 100644 index 4ca3117..0000000 --- a/versioned_docs/version-0.11/Glossary.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -sidebar_position: 8 -title: "Glossary" -linkTitle: "Glossary" -tags: [] -categories: [] -weight: 6 -description: > - DevLake Glossary ---- - -*Last updated: May 16 2022* - - -## In Configuration UI (Regular Mode) - -The following terms are arranged in the order of their appearance in the actual user workflow. - -### 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](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: - - -- Each blueprint can have multiple data connections. -- Each data connection can have multiple sets of data scope. -- Each set of data scope only consists of one GitHub/GitLab project or Jira board, along with their corresponding data entities. -- Each set of data scope can only have one set of transformation rules. - -### 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](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. - -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](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](./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](./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. - -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](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](Glossary.md#pipelines). - -## In Configuration UI (Advanced Mode) and API - -The following terms have not appeared in the Regular Mode of Configuration UI for simplification, but can be very useful if you want to learn about the underlying framework of Devalke or use Advanced Mode and the DevLake API. - -### Data Plugins -**A data plugin is a specific module that syncs or transforms data.** There are two types of data plugins: Data Collection Plugins and Data Transformation Plugins. - -Data Collection Plugins pull data from one or more data sources. DevLake supports 8 data plugins in this category: `ae`, `feishu`, `gitextractor`, `github`, `gitlab`, `jenkins`, `jira` and `tapd`. - -Data Transformation Plugins transform the data pulled by other Data Collection Plugins. `refdiff` is currently the only plugin in this category. - -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/02-DataSupport.md). - - -### Pipelines -**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](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. -- `Collectors`: Collect raw data from data sources, normally via DevLake API and stored into `raw data table` -- `Extractors`: Extract data from `raw data table` to `domain layer tables` -- `Converters`: Convert data from `tool layer tables` into `domain layer tables` -- `Enrichers`: Enrich data from one domain to other domains. For instance, the Fourier Transformation can examine `issue_changelog` to show time distribution of an issue on every assignee. diff --git a/versioned_docs/version-0.11/Dashboards/AverageRequirementLeadTime.md b/versioned_docs/version-v0.11.0/Dashboards/AverageRequirementLeadTime.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/AverageRequirementLeadTime.md rename to versioned_docs/version-v0.11.0/Dashboards/AverageRequirementLeadTime.md diff --git a/versioned_docs/version-0.11/Dashboards/CommitCountByAuthor.md b/versioned_docs/version-v0.11.0/Dashboards/CommitCountByAuthor.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/CommitCountByAuthor.md rename to versioned_docs/version-v0.11.0/Dashboards/CommitCountByAuthor.md diff --git a/versioned_docs/version-0.11/Dashboards/DetailedBugInfo.md b/versioned_docs/version-v0.11.0/Dashboards/DetailedBugInfo.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/DetailedBugInfo.md rename to versioned_docs/version-v0.11.0/Dashboards/DetailedBugInfo.md diff --git a/versioned_docs/version-0.11/Dashboards/GitHubBasic.md b/versioned_docs/version-v0.11.0/Dashboards/GitHubBasic.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/GitHubBasic.md rename to versioned_docs/version-v0.11.0/Dashboards/GitHubBasic.md diff --git a/versioned_docs/version-0.11/Dashboards/GitHubReleaseQualityAndContributionAnalysis.md b/versioned_docs/version-v0.11.0/Dashboards/GitHubReleaseQualityAndContributionAnalysis.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/GitHubReleaseQualityAndContributionAnalysis.md rename to versioned_docs/version-v0.11.0/Dashboards/GitHubReleaseQualityAndContributionAnalysis.md diff --git a/versioned_docs/version-0.11/Dashboards/Jenkins.md b/versioned_docs/version-v0.11.0/Dashboards/Jenkins.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/Jenkins.md rename to versioned_docs/version-v0.11.0/Dashboards/Jenkins.md diff --git a/versioned_docs/version-0.11/Dashboards/WeeklyBugRetro.md b/versioned_docs/version-v0.11.0/Dashboards/WeeklyBugRetro.md similarity index 100% rename from versioned_docs/version-0.11/Dashboards/WeeklyBugRetro.md rename to versioned_docs/version-v0.11.0/Dashboards/WeeklyBugRetro.md diff --git a/versioned_docs/version-0.11/Dashboards/_category_.json b/versioned_docs/version-v0.11.0/Dashboards/_category_.json similarity index 100% rename from versioned_docs/version-0.11/Dashboards/_category_.json rename to versioned_docs/version-v0.11.0/Dashboards/_category_.json diff --git a/versioned_docs/version-0.11/DataModels/02-DataSupport.md b/versioned_docs/version-v0.11.0/DataModels/DataSupport.md similarity index 98% rename from versioned_docs/version-0.11/DataModels/02-DataSupport.md rename to versioned_docs/version-v0.11.0/DataModels/DataSupport.md index 7067da1..4cb4b61 100644 --- a/versioned_docs/version-0.11/DataModels/02-DataSupport.md +++ b/versioned_docs/version-v0.11.0/DataModels/DataSupport.md @@ -1,11 +1,8 @@ --- title: "Data Support" -linkTitle: "Data Support" -tags: [] -categories: [] -weight: 2 description: > Data sources that DevLake supports +sidebar_position: 1 --- @@ -26,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](./01-DevLakeDomainLayerSchema.md). +This table shows the entities collected by each plugin. Domain layer entities in this table are consistent with the entities [here](./DevLakeDomainLayerSchema.md). | Domain Layer Entities | ae | gitextractor | github | gitlab | jenkins | jira | refdiff | tapd | | --------------------- | -------------- | ------------ | -------------- | ------- | ------- | ------- | ------- | ------- | diff --git a/docs/DataModels/01-DevLakeDomainLayerSchema.md b/versioned_docs/version-v0.11.0/DataModels/DevLakeDomainLayerSchema.md similarity index 99% rename from docs/DataModels/01-DevLakeDomainLayerSchema.md rename to versioned_docs/version-v0.11.0/DataModels/DevLakeDomainLayerSchema.md index 2ffa512..996d397 100644 --- a/docs/DataModels/01-DevLakeDomainLayerSchema.md +++ b/versioned_docs/version-v0.11.0/DataModels/DevLakeDomainLayerSchema.md @@ -1,11 +1,8 @@ --- title: "Domain Layer Schema" -linkTitle: "Domain Layer Schema" -tags: [] -categories: [] -weight: 50000 description: > DevLake Domain Layer Schema +sidebar_position: 2 --- ## Summary @@ -33,7 +30,7 @@ This is the up-to-date domain layer schema for DevLake v0.10.x. Tables (entities ### Schema Diagram - + When reading the schema, you'll notice that many tables' primary key is called `id`. Unlike auto-increment id or UUID, `id` is a string composed of several parts to uniquely identify similar entities (e.g. repo) from different platforms (e.g. Github/Gitlab) and allow them to co-exist in a single table. diff --git a/versioned_docs/version-0.11/DataModels/_category_.json b/versioned_docs/version-v0.11.0/DataModels/_category_.json similarity index 100% rename from versioned_docs/version-0.11/DataModels/_category_.json rename to versioned_docs/version-v0.11.0/DataModels/_category_.json diff --git a/docs/DeveloperManuals/MIGRATIONS.md b/versioned_docs/version-v0.11.0/DeveloperManuals/DBMigration.md similarity index 94% rename from docs/DeveloperManuals/MIGRATIONS.md rename to versioned_docs/version-v0.11.0/DeveloperManuals/DBMigration.md index edab4ca..9530237 100644 --- a/docs/DeveloperManuals/MIGRATIONS.md +++ b/versioned_docs/version-v0.11.0/DeveloperManuals/DBMigration.md @@ -2,17 +2,16 @@ title: "DB Migration" description: > DB Migration +sidebar_position: 3 --- -# Migrations (Database) - ## Summary Starting in v0.10.0, DevLake provides a lightweight migration tool for executing migration scripts. Both framework itself and plugins define their migration scripts in their own migration folder. The migration scripts are written with gorm in Golang to support different SQL dialects. -## Migration script +## Migration Script Migration script describes how to do database migration. They implement the `Script` interface. When DevLake starts, scripts register themselves to the framework by invoking the `Register` function @@ -29,7 +28,9 @@ type Script interface { The table tracks migration scripts execution and schemas changes. From which, DevLake could figure out the current state of database schemas. -## How it Works + + +## How It Works 1. Check `migration_history` table, calculate all the migration scripts need to be executed. 2. Sort scripts by Version in ascending order. 3. Execute scripts. diff --git a/versioned_docs/version-0.11/DeveloperManuals/Dal.md b/versioned_docs/version-v0.11.0/DeveloperManuals/Dal.md similarity index 99% rename from versioned_docs/version-0.11/DeveloperManuals/Dal.md rename to versioned_docs/version-v0.11.0/DeveloperManuals/Dal.md index da27a55..9b08542 100644 --- a/versioned_docs/version-0.11/DeveloperManuals/Dal.md +++ b/versioned_docs/version-v0.11.0/DeveloperManuals/Dal.md @@ -1,6 +1,6 @@ --- title: "Dal" -sidebar_position: 4 +sidebar_position: 5 description: > The Dal (Data Access Layer) is designed to decouple the hard dependency on `gorm` in v0.12 --- diff --git a/docs/DeveloperManuals/04-DeveloperSetup.md b/versioned_docs/version-v0.11.0/DeveloperManuals/DeveloperSetup.md similarity index 87% rename from docs/DeveloperManuals/04-DeveloperSetup.md rename to versioned_docs/version-v0.11.0/DeveloperManuals/DeveloperSetup.md index cb27440..4b05c11 100644 --- a/docs/DeveloperManuals/04-DeveloperSetup.md +++ b/versioned_docs/version-v0.11.0/DeveloperManuals/DeveloperSetup.md @@ -2,10 +2,11 @@ title: "Developer Setup" description: > The steps to install DevLake in develper mode. +sidebar_position: 1 --- -#### Requirements +## Requirements - <a href="https://docs.docker.com/get-docker"; target="_blank">Docker v19.03.10+</a> - <a href="https://golang.org/doc/install"; target="_blank">Golang v1.17+</a> @@ -14,7 +15,7 @@ description: > - Windows: [Download](http://gnuwin32.sourceforge.net/packages/make.htm) - Ubuntu: `sudo apt-get install build-essential libssl-dev` -#### How to setup dev environment +## How to setup dev environment 1. Navigate to where you would like to install this project and clone the repository: ```sh @@ -24,7 +25,7 @@ description: > 2. Install dependencies for plugins: - - [RefDiff](../Plugins/refdiff.md#development) + - [RefDiff](../Plugins/RefDiff.md#development) 3. Install Go packages @@ -75,10 +76,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](../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. + - [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/GitHubUserGuide.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. @@ -111,14 +112,14 @@ description: > ] ``` - Please refer to [Pipeline Advanced Mode](../UserManuals/create-pipeline-in-advanced-mode.md) for in-depth explanation. + Please refer to [Pipeline Advanced Mode](../UserManuals/AdvancedMode.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](../UserManuals/GRAFANA.md). + All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GrafanaUserGuide.md). 11. (Optional) To run the tests: @@ -126,5 +127,5 @@ description: > make test ``` -12. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/MIGRATIONS.md). -<br/><br/><br/> +12. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/DBMigration.md). + diff --git a/versioned_docs/version-0.11/DeveloperManuals/NOTIFICATION.md b/versioned_docs/version-v0.11.0/DeveloperManuals/Notifications.md similarity index 97% rename from versioned_docs/version-0.11/DeveloperManuals/NOTIFICATION.md rename to versioned_docs/version-v0.11.0/DeveloperManuals/Notifications.md index d5ebd2b..23456b4 100644 --- a/versioned_docs/version-0.11/DeveloperManuals/NOTIFICATION.md +++ b/versioned_docs/version-v0.11.0/DeveloperManuals/Notifications.md @@ -2,10 +2,9 @@ title: "Notifications" description: > Notifications +sidebar_position: 4 --- -# Notification - ## Request Example request ``` diff --git a/versioned_docs/version-0.11/DeveloperManuals/PluginCreate.md b/versioned_docs/version-v0.11.0/DeveloperManuals/PluginImplementation.md similarity index 99% rename from versioned_docs/version-0.11/DeveloperManuals/PluginCreate.md rename to versioned_docs/version-v0.11.0/DeveloperManuals/PluginImplementation.md index 3f2a4ce..e3457c9 100644 --- a/versioned_docs/version-0.11/DeveloperManuals/PluginCreate.md +++ b/versioned_docs/version-v0.11.0/DeveloperManuals/PluginImplementation.md @@ -1,8 +1,8 @@ --- -title: "How to Implement a DevLake plugin?" -sidebar_position: 1 +title: "Plugin Implementation" +sidebar_position: 2 description: > - How to Implement a DevLake plugin. + Plugin Implementation --- ## How to Implement a DevLake plugin? diff --git a/versioned_docs/version-0.11/DeveloperManuals/_category_.json b/versioned_docs/version-v0.11.0/DeveloperManuals/_category_.json similarity index 100% rename from versioned_docs/version-0.11/DeveloperManuals/_category_.json rename to versioned_docs/version-v0.11.0/DeveloperManuals/_category_.json diff --git a/versioned_docs/version-0.11/EngineeringMetrics.md b/versioned_docs/version-v0.11.0/EngineeringMetrics.md similarity index 100% rename from versioned_docs/version-0.11/EngineeringMetrics.md rename to versioned_docs/version-v0.11.0/EngineeringMetrics.md diff --git a/docs/Overview/02-Architecture.md b/versioned_docs/version-v0.11.0/Overview/Architecture.md similarity index 89% rename from docs/Overview/02-Architecture.md rename to versioned_docs/version-v0.11.0/Overview/Architecture.md index 8daa859..2d780a5 100755 --- a/docs/Overview/02-Architecture.md +++ b/versioned_docs/version-v0.11.0/Overview/Architecture.md @@ -1,18 +1,18 @@ --- title: "Architecture" -linkTitle: "Architecture" description: > - Understand the architecture of Apache DevLake. + Understand the architecture of Apache DevLake +sidebar_position: 2 --- ## Architecture Overview -<p align="center"><img src="/img/arch-component.svg" /></p> +<p align="center"><img src="/img/Architecture/arch-component.svg" /></p> <p align="center">DevLake Components</p> A DevLake installation typically consists of the following components: -- Config UI: A handy user interface to create, trigger, and debug Blueprints. A Blueprint specifies the where (data connection), what (data scope), how (transformation rule), and when (sync frequency) of a data pipeline. +- Config UI: A handy user interface to create, trigger, and debug data pipelines. - API Server: The main programmatic interface of DevLake. - Runner: The runner does all the heavy-lifting for executing tasks. In the default DevLake installation, it runs within the API Server, but DevLake provides a temporal-based runner (beta) for production environments. - Database: The database stores both DevLake's metadata and user data collected by data pipelines. DevLake supports MySQL and PostgreSQL as of v0.11. @@ -21,7 +21,7 @@ A DevLake installation typically consists of the following components: ## Dataflow -<p align="center"><img src="/img/arch-dataflow.svg" /></p> +<p align="center"><img src="/img/Architecture/arch-dataflow.svg" /></p> <p align="center">DevLake Dataflow</p> A typical plugin's dataflow is illustrated below: diff --git a/versioned_docs/version-v0.11.0/Overview/Introduction.md b/versioned_docs/version-v0.11.0/Overview/Introduction.md new file mode 100755 index 0000000..c8aacd9 --- /dev/null +++ b/versioned_docs/version-v0.11.0/Overview/Introduction.md @@ -0,0 +1,16 @@ +--- +title: "Introduction" +description: General introduction of Apache DevLake +sidebar_position: 1 +--- + +## What is Apache DevLake? +Apache DevLake is an open-source dev data platform that ingests, analyzes, and visualizes the fragmented data from DevOps tools to distill insights for engineering productivity. + +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 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](../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](Architecture.md) for data collection and ETL. + diff --git a/versioned_docs/version-0.11/Overview/03-Roadmap.md b/versioned_docs/version-v0.11.0/Overview/Roadmap.md similarity index 53% rename from versioned_docs/version-0.11/Overview/03-Roadmap.md rename to versioned_docs/version-v0.11.0/Overview/Roadmap.md index f10b62e..9dcf0b3 100644 --- a/versioned_docs/version-0.11/Overview/03-Roadmap.md +++ b/versioned_docs/version-v0.11.0/Overview/Roadmap.md @@ -1,11 +1,8 @@ --- title: "Roadmap" -linkTitle: "Roadmap" -tags: [] -categories: [] -weight: 3 description: > - The goals and roadmap for DevLake in 2022. + The goals and roadmap for DevLake in 2022 +sidebar_position: 3 --- @@ -24,8 +21,8 @@ Apache DevLake is currently under rapid development. You are more than welcome t | Category | Features| | --- | --- | -| 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 [...] +| More data sources across different [DevOps domains](../DataModels/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><li [...] +| Improved data collection, [data models](../DataModels/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 ref [...] | 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 [...] diff --git a/versioned_docs/version-0.11/Overview/_category_.json b/versioned_docs/version-v0.11.0/Overview/_category_.json similarity index 100% rename from versioned_docs/version-0.11/Overview/_category_.json rename to versioned_docs/version-v0.11.0/Overview/_category_.json diff --git a/versioned_docs/version-0.11/Plugins/dbt.md b/versioned_docs/version-v0.11.0/Plugins/Dbt.md similarity index 100% rename from versioned_docs/version-0.11/Plugins/dbt.md rename to versioned_docs/version-v0.11.0/Plugins/Dbt.md diff --git a/versioned_docs/version-0.11/Plugins/feishu.md b/versioned_docs/version-v0.11.0/Plugins/Feishu.md similarity index 99% rename from versioned_docs/version-0.11/Plugins/feishu.md rename to versioned_docs/version-v0.11.0/Plugins/Feishu.md index f19e4b0..c3e0eb6 100644 --- a/versioned_docs/version-0.11/Plugins/feishu.md +++ b/versioned_docs/version-v0.11.0/Plugins/Feishu.md @@ -4,8 +4,6 @@ description: > Feishu Plugin --- -# Feishu - ## Summary This plugin collects Feishu meeting data through [Feishu Openapi](https://open.feishu.cn/document/home/user-identity-introduction/introduction). diff --git a/versioned_docs/version-0.11/Plugins/gitextractor.md b/versioned_docs/version-v0.11.0/Plugins/GitExtractor.md similarity index 93% rename from versioned_docs/version-0.11/Plugins/gitextractor.md rename to versioned_docs/version-v0.11.0/Plugins/GitExtractor.md index ac97fa3..d154e9e 100644 --- a/versioned_docs/version-0.11/Plugins/gitextractor.md +++ b/versioned_docs/version-v0.11.0/Plugins/GitExtractor.md @@ -4,8 +4,6 @@ description: > GitExtractor Plugin --- -# Git Repo Extractor - ## Summary This plugin extracts commits and references from a remote or local git repository. It then saves the data into the database or csv files. @@ -14,7 +12,7 @@ This plugin extracts commits and references from a remote or local git repositor 1. Use the Git repo extractor to retrieve data about commits and branches from your repository. 2. Use the GitHub plugin to retrieve data about Github issues and PRs from your repository. NOTE: you can run only one issue collection stage as described in the Github Plugin README. -3. Use the [RefDiff](./refdiff.md#development) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table. +3. Use the [RefDiff](./RefDiff.md#development) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table. ## Sample Request @@ -60,6 +58,6 @@ For more options (e.g., saving to a csv file instead of a db), please read `plug ## Development This plugin depends on `libgit2`, you need to install version 1.3.0 in order to run and debug this plugin on your local -machine. [Click here](./refdiff.md#development) for a brief guide. +machine. [Click here](./RefDiff.md#development) for a brief guide. <br/><br/><br/> diff --git a/versioned_docs/version-0.11/Plugins/github.md b/versioned_docs/version-v0.11.0/Plugins/GitHub.md similarity index 98% rename from versioned_docs/version-0.11/Plugins/github.md rename to versioned_docs/version-v0.11.0/Plugins/GitHub.md index 463f9de..cca87b7 100644 --- a/versioned_docs/version-0.11/Plugins/github.md +++ b/versioned_docs/version-v0.11.0/Plugins/GitHub.md @@ -4,7 +4,6 @@ description: > GitHub Plugin --- -# Github ## Summary @@ -24,7 +23,7 @@ Here are some examples metrics using `GitHub` data: ## Screenshot - + ## Configuration diff --git a/versioned_docs/version-0.11/Plugins/gitlab.md b/versioned_docs/version-v0.11.0/Plugins/GitLab.md similarity index 100% rename from versioned_docs/version-0.11/Plugins/gitlab.md rename to versioned_docs/version-v0.11.0/Plugins/GitLab.md diff --git a/versioned_docs/version-0.11/Plugins/gitee.md b/versioned_docs/version-v0.11.0/Plugins/Gitee.md similarity index 99% rename from versioned_docs/version-0.11/Plugins/gitee.md rename to versioned_docs/version-v0.11.0/Plugins/Gitee.md index 0c4307a..6066fd2 100644 --- a/versioned_docs/version-0.11/Plugins/gitee.md +++ b/versioned_docs/version-v0.11.0/Plugins/Gitee.md @@ -4,8 +4,6 @@ description: > Gitee Plugin --- -# Gitee - ## Summary ## Configuration diff --git a/versioned_docs/version-0.11/Plugins/jenkins.md b/versioned_docs/version-v0.11.0/Plugins/Jenkins.md similarity index 99% rename from versioned_docs/version-0.11/Plugins/jenkins.md rename to versioned_docs/version-v0.11.0/Plugins/Jenkins.md index 26e72a6..792165d 100644 --- a/versioned_docs/version-0.11/Plugins/jenkins.md +++ b/versioned_docs/version-v0.11.0/Plugins/Jenkins.md @@ -4,8 +4,6 @@ description: > Jenkins Plugin --- -# Jenkins - ## Summary This plugin collects Jenkins data through [Remote Access API](https://www.jenkins.io/doc/book/using/remote-access-api/). It then computes and visualizes various DevOps metrics from the Jenkins data. diff --git a/versioned_docs/version-0.11/Plugins/jira.md b/versioned_docs/version-v0.11.0/Plugins/Jira.md similarity index 100% rename from versioned_docs/version-0.11/Plugins/jira.md rename to versioned_docs/version-v0.11.0/Plugins/Jira.md diff --git a/versioned_docs/version-0.11/Plugins/refdiff.md b/versioned_docs/version-v0.11.0/Plugins/RefDiff.md similarity index 99% rename from versioned_docs/version-0.11/Plugins/refdiff.md rename to versioned_docs/version-v0.11.0/Plugins/RefDiff.md index 35d3049..12950f4 100644 --- a/versioned_docs/version-0.11/Plugins/refdiff.md +++ b/versioned_docs/version-v0.11.0/Plugins/RefDiff.md @@ -4,8 +4,6 @@ description: > RefDiff Plugin --- -# RefDiff - ## Summary diff --git a/versioned_docs/version-0.11/Plugins/tapd.md b/versioned_docs/version-v0.11.0/Plugins/Tapd.md similarity index 84% rename from versioned_docs/version-0.11/Plugins/tapd.md rename to versioned_docs/version-v0.11.0/Plugins/Tapd.md index fc93539..b8db89f 100644 --- a/versioned_docs/version-0.11/Plugins/tapd.md +++ b/versioned_docs/version-v0.11.0/Plugins/Tapd.md @@ -1,4 +1,8 @@ -# TAPD +--- +title: "TAPD" +description: > + TAPD Plugin +--- ## Summary diff --git a/versioned_docs/version-0.11/Plugins/_category_.json b/versioned_docs/version-v0.11.0/Plugins/_category_.json similarity index 100% rename from versioned_docs/version-0.11/Plugins/_category_.json rename to versioned_docs/version-v0.11.0/Plugins/_category_.json diff --git a/versioned_docs/version-0.11/Plugins/github-connection-in-config-ui.png b/versioned_docs/version-v0.11.0/Plugins/github-connection-in-config-ui.png similarity index 100% rename from versioned_docs/version-0.11/Plugins/github-connection-in-config-ui.png rename to versioned_docs/version-v0.11.0/Plugins/github-connection-in-config-ui.png diff --git a/versioned_docs/version-0.11/Plugins/gitlab-connection-in-config-ui.png b/versioned_docs/version-v0.11.0/Plugins/gitlab-connection-in-config-ui.png similarity index 100% rename from versioned_docs/version-0.11/Plugins/gitlab-connection-in-config-ui.png rename to versioned_docs/version-v0.11.0/Plugins/gitlab-connection-in-config-ui.png diff --git a/versioned_docs/version-0.11/Plugins/jira-connection-config-ui.png b/versioned_docs/version-v0.11.0/Plugins/jira-connection-config-ui.png similarity index 100% rename from versioned_docs/version-0.11/Plugins/jira-connection-config-ui.png rename to versioned_docs/version-v0.11.0/Plugins/jira-connection-config-ui.png diff --git a/versioned_docs/version-0.11/Plugins/jira-more-setting-in-config-ui.png b/versioned_docs/version-v0.11.0/Plugins/jira-more-setting-in-config-ui.png similarity index 100% rename from versioned_docs/version-0.11/Plugins/jira-more-setting-in-config-ui.png rename to versioned_docs/version-v0.11.0/Plugins/jira-more-setting-in-config-ui.png diff --git a/versioned_docs/version-0.11/QuickStart/02-KubernetesSetup.md b/versioned_docs/version-v0.11.0/QuickStart/KubernetesSetup.md similarity index 94% rename from versioned_docs/version-0.11/QuickStart/02-KubernetesSetup.md rename to versioned_docs/version-v0.11.0/QuickStart/KubernetesSetup.md index 19bdc4d..e4faeba 100644 --- a/versioned_docs/version-0.11/QuickStart/02-KubernetesSetup.md +++ b/versioned_docs/version-v0.11.0/QuickStart/KubernetesSetup.md @@ -1,7 +1,8 @@ --- -title: "Deploy to Kubernetes" +title: "Kubernetes Setup" description: > - The steps to install Apache DevLake in Kubernetes. + The steps to install Apache DevLake in Kubernetes +sidebar_position: 2 --- @@ -9,7 +10,7 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) will create a namespace `devlake` on your k8s cluster, and use `nodePort 30004` for `config-ui`, `nodePort 30002` for `grafana` dashboards. If you would like to use certain version of Apache DevLake, please update the image tag of `grafana`, `devlake` and `config-ui` services to specify versions like `v0.10.1`. -Here's the step-by-step guide: +## Step-by-step guide 1. Download [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) to local machine 2. Some key points: diff --git a/versioned_docs/version-0.11/QuickStart/01-LocalSetup.md b/versioned_docs/version-v0.11.0/QuickStart/LocalSetup.md similarity index 72% rename from versioned_docs/version-0.11/QuickStart/01-LocalSetup.md rename to versioned_docs/version-v0.11.0/QuickStart/LocalSetup.md index 9b81bc9..8e56a65 100644 --- a/versioned_docs/version-0.11/QuickStart/01-LocalSetup.md +++ b/versioned_docs/version-v0.11.0/QuickStart/LocalSetup.md @@ -1,16 +1,17 @@ --- -title: "Deploy Locally" +title: "Local Setup" description: > - The steps to install DevLake locally. + The steps to install DevLake locally +sidebar_position: 1 --- -#### Prerequisites +## Prerequisites - [Docker v19.03.10+](https://docs.docker.com/get-docker) - [docker-compose v2.2.3+](https://docs.docker.com/compose/install/) -#### Launch DevLake +## Launch DevLake - Commands written `like this` are to be run in your terminal. @@ -18,25 +19,25 @@ description: > 2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. 3. Run `docker-compose up -d` to launch DevLake. -#### Configure data connections and collect data +## Configure data connections and collect data 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](../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) + - [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/GitHubUserGuide.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](../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/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](../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. + - All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GrafanaUserGuide.md). +4. To synchronize data periodically, users can set up recurring pipelines with DevLake's [pipeline blueprint](../UserManuals/RecurringPipelines.md) for details. -#### Upgrade to a newer version +## 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. diff --git a/versioned_docs/version-0.11/QuickStart/_category_.json b/versioned_docs/version-v0.11.0/QuickStart/_category_.json similarity index 100% rename from versioned_docs/version-0.11/QuickStart/_category_.json rename to versioned_docs/version-v0.11.0/QuickStart/_category_.json diff --git a/docs/UserManuals/create-pipeline-in-advanced-mode.md b/versioned_docs/version-v0.11.0/UserManuals/AdvancedMode.md similarity index 97% rename from docs/UserManuals/create-pipeline-in-advanced-mode.md rename to versioned_docs/version-v0.11.0/UserManuals/AdvancedMode.md index 14afd01..4323133 100644 --- a/docs/UserManuals/create-pipeline-in-advanced-mode.md +++ b/versioned_docs/version-v0.11.0/UserManuals/AdvancedMode.md @@ -1,8 +1,8 @@ --- -title: "Create Pipeline in Advanced Mode" +title: "Advanced Mode" sidebar_position: 2 description: > - Create Pipeline in Advanced Mode + Advanced Mode --- diff --git a/docs/UserManuals/github-user-guide-v0.10.0.md b/versioned_docs/version-v0.11.0/UserManuals/GitHubUserGuide.md similarity index 97% rename from docs/UserManuals/github-user-guide-v0.10.0.md rename to versioned_docs/version-v0.11.0/UserManuals/GitHubUserGuide.md index 9a9014b..fa67456 100644 --- a/docs/UserManuals/github-user-guide-v0.10.0.md +++ b/versioned_docs/version-v0.11.0/UserManuals/GitHubUserGuide.md @@ -1,8 +1,8 @@ --- -title: "GitHub User Guide v0.10.0" +title: "GitHub User Guide" sidebar_position: 4 description: > - GitHub User Guide v0.10.0 + GitHub User Guide --- ## Summary @@ -109,7 +109,7 @@ See the pipeline finishes (progress 100%): ### Step 4 - [Optional] Set up a recurring pipeline to keep data fresh -Please see [How to create recurring pipelines](./recurring-pipeline.md) for details. +Please see [How to create recurring pipelines](./RecurringPipelines.md) for details. diff --git a/docs/UserManuals/GRAFANA.md b/versioned_docs/version-v0.11.0/UserManuals/GrafanaUserGuide.md similarity index 99% rename from docs/UserManuals/GRAFANA.md rename to versioned_docs/version-v0.11.0/UserManuals/GrafanaUserGuide.md index bd81651..e475702 100644 --- a/docs/UserManuals/GRAFANA.md +++ b/versioned_docs/version-v0.11.0/UserManuals/GrafanaUserGuide.md @@ -1,8 +1,8 @@ --- -title: "How to use Grafana" +title: "Grafana User Guide" sidebar_position: 1 description: > - How to use Grafana + Grafana User Guide --- diff --git a/versioned_docs/version-0.11/UserManuals/recurring-pipeline.md b/versioned_docs/version-v0.11.0/UserManuals/RecurringPipelines.md similarity index 91% rename from versioned_docs/version-0.11/UserManuals/recurring-pipeline.md rename to versioned_docs/version-v0.11.0/UserManuals/RecurringPipelines.md index 3e92349..ce82b1e 100644 --- a/versioned_docs/version-0.11/UserManuals/recurring-pipeline.md +++ b/versioned_docs/version-v0.11.0/UserManuals/RecurringPipelines.md @@ -1,8 +1,8 @@ --- -title: "Create Recurring Pipelines" +title: "Recurring Pipelines" sidebar_position: 3 description: > - Create Recurring Pipelines + Recurring Pipelines --- ## How to create recurring pipelines? diff --git a/docs/UserManuals/team-feature-user-guide.md b/versioned_docs/version-v0.11.0/UserManuals/TeamConfiguration.md similarity index 94% rename from docs/UserManuals/team-feature-user-guide.md rename to versioned_docs/version-v0.11.0/UserManuals/TeamConfiguration.md index 07a080b..4646ffa 100644 --- a/docs/UserManuals/team-feature-user-guide.md +++ b/versioned_docs/version-v0.11.0/UserManuals/TeamConfiguration.md @@ -1,8 +1,8 @@ --- -title: "Team Feature User Guide" +title: "Team Configuration" sidebar_position: 6 description: > - Team Feature User Guide + Team Configuration --- ## Summary This is a brief step-by-step guide to using the team feature. @@ -31,7 +31,7 @@ b. The actual api request. iii. After successful execution, the teams table is generated and the data can be seen in the database table teams. (Notes: how to connect to the database: mainly through host, port, username, password, and then through sql tools, such as sequal ace, datagrip and other data, of course you can also access through the command line mysql -h `ip` -u `username` -p -P `port`) - + ## Step 2 - Construct user tables (roster) @@ -52,11 +52,11 @@ b. The actual api request. iii. After successful execution, the users table is generated and the data can be seen in the database table users. - + iv. Generated the team_users table, you can see the data in the team_users table. - + ## Step 3 - Update users if you need If there is a problem with team_users association or data in users, just re-put users api interface, i.e. (b in step 2 above) @@ -64,7 +64,7 @@ If there is a problem with team_users association or data in users, just re-put ## Step 4 - Collect accounts accounts table is collected by users through devlake. You can see the accounts table information in the database. - + ## Step 5 - Automatically match existing accounts and users through api requests @@ -91,7 +91,7 @@ curl --location --request POST '127.0.0.1:8080/pipelines' \ b. After successful execution, the user_accounts table is generated, and you can see the data in table user_accounts. - + ## Step 6 - Get user_accountsr relationship After generating the user_accounts relationship, the user can get the associated data through the GET method to confirm whether the data user and account match correctly and whether the matched accounts are complete. @@ -103,7 +103,7 @@ b. The corresponding curl command: curl --location --request GET 'http://127.0.0.1:8080/plugins/org/user_account_mapping.csv' ``` - + c. You can also use sql statements to determine, here to provide a sql statement for reference only. ``` @@ -123,7 +123,7 @@ curl --location --request PUT 'http://127.0.0.1:8080/plugins/org/user_account_ma b. You can see that the data in the user_accounts table has been updated. - + **The above is the flow of user usage for the whole team feature.** diff --git a/versioned_docs/version-0.11/UserManuals/03-TemporalSetup.md b/versioned_docs/version-v0.11.0/UserManuals/TemporalSetup.md similarity index 100% rename from versioned_docs/version-0.11/UserManuals/03-TemporalSetup.md rename to versioned_docs/version-v0.11.0/UserManuals/TemporalSetup.md diff --git a/versioned_docs/version-0.11/UserManuals/_category_.json b/versioned_docs/version-v0.11.0/UserManuals/_category_.json similarity index 100% rename from versioned_docs/version-0.11/UserManuals/_category_.json rename to versioned_docs/version-v0.11.0/UserManuals/_category_.json diff --git a/versioned_sidebars/version-0.11-sidebars.json b/versioned_sidebars/version-v0.11.0-sidebars.json similarity index 100% rename from versioned_sidebars/version-0.11-sidebars.json rename to versioned_sidebars/version-v0.11.0-sidebars.json diff --git a/versions.json b/versions.json index fff9bee..909d780 100644 --- a/versions.json +++ b/versions.json @@ -1,3 +1,3 @@ [ - "0.11" + "v0.11.0" ]
