You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2022/09/30 02:28:09 UTC
[incubator-devlake] branch yumengwang03-patch-1 created (now 16c6b98e)
This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a change to branch yumengwang03-patch-1
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
at 16c6b98e fix: updated main README
This branch includes the following new commits:
new 16c6b98e fix: updated main README
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[incubator-devlake] 01/01: fix: updated main README
Posted by yu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch yumengwang03-patch-1
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
commit 16c6b98e3c8103afc004f9d50a9d94da347449d8
Author: Yumeng Wang <yu...@merico.dev>
AuthorDate: Fri Sep 30 10:28:04 2022 +0800
fix: updated main README
---
README.md | 49 ++++++++++++++++++++++++++-----------------------
1 file changed, 26 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 86fc3a81..07860d18 100644
--- a/README.md
+++ b/README.md
@@ -16,26 +16,36 @@
## 🤔 What is Apache DevLake?
-[Apache DevLake](https://devlake.apache.org) 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](https://devlake.apache.org) is an open-source dev data platform that ingests, analyzes, and visualizes the fragmented data from DevOps tools to extract insights for engineering excellence, developer experience, and community growth.
Apache DevLake is designed for developer teams looking to make better sense of their development process and to bring a more data-driven approach to their own practices. You can ask Apache DevLake many questions regarding your development process. Just connect and query.
## 🎯 What can be accomplished with Apache DevLake?
-1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard [data model](https://devlake.apache.org/docs/DataModels/DevLakeDomainLayerSchema).
-2. Visualize out-of-the-box engineering [metrics](https://devlake.apache.org/docs/Metrics) in a series of use-case driven dashboards.
-3. Easily extend DevLake to support your data sources, metrics, and dashboards with a flexible [framework](https://devlake.apache.org/docs/Overview/Architecture) for data collection and ETL (Extract, Transform, Load).
+1. Your Dev Data lives in many silos and tools. DevLake brings them all together to give you a complete view of your Software Development Life Cycle (SDLC).
+2. From DORA to scrum retros, DevLake implements metrics effortlessly with prebuilt dashboards supporting common frameworks and goals.
+3. DevLake fits teams of all shapes and sizes, and can be readily extended to support new data sources, metrics, and dashboards, with a flexible framework for data collection and transformation.
+
+## 👉 Live Demo
+[DORA Dashboard](https://grafana-lake.demo.devlake.io/grafana/goto/r1EVQH4Vk?orgId=1)
+
+[All Dashbaords](https://devlake.apache.org/docs/LiveDemo)
## 💪 Supported Data Sources
-| Data Source | Domain | Supported Versions |
-| ---------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------ |
-| [GitHub](https://devlake.apache.org/docs/Plugins/github) | Source Code Management, Code Review, Issue Management | Cloud |
-| [Gitlab](https://devlake.apache.org/docs/Plugins/gitlab) | Source Code Management, Code Review, Issue Management | Cloud, Community Edition 13.x+ |
-| [Jira](https://devlake.apache.org/docs/Plugins/jira) | Issue Management | Cloud, Server 8.x+, Data Center 8.x+ |
-| [Jenkins](https://devlake.apache.org/docs/Plugins/jenkins) | CI/CD | 2.263.x+ |
-| [Feishu](https://devlake.apache.org/docs/Plugins/feishu) | Documentation | Cloud |
-| TAPD | Issue Management | Cloud |
+| Data Source | Domain(s) |Supoorted Versions | Plugins |
+|--------------|-----------------------------------------------------|--------------------------------------|-------- |
+| GitHub | Source Code Management, Code Review, Issue Tracking | Cloud |`github`, `gitextractor`, `refdiff` |
+| GitLab | Source Code Management, Code Review, Issue Tracking | Cloud, Community Edition 13.x+ |`gitlab`, `gitextractor`, `refdiff` |
+| BitBucket | Source Code Management, Code Review, Issue Tracking | Cloud |`bitbucket`, `gitextractor`, `refdiff` |
+| Gitee | Source Code Management, Code Review, Issue Tracking | Cloud |`gitee`, `gitextractor`, `refdiff` |
+| Jira | Issue Tracking | Cloud, Server 8.x+, Data Center 8.x+ |`jira` |
+| TAPD | Issue Tracking | Cloud | `tapd` |
+| Jenkins | CI/CD | 2.263.x+ |`jenkins` |
+| GitHub Action| CI/CD | Cloud |`github`|
+| GitLab CI | CI/CD | Cloud, Community Edition 13.x+ |`gitlab`|
+| Feishu | Calendar | Cloud |`feishu` |
+| AE | Source Code Management | | `ae` |
## 🚀 Getting Started
@@ -49,39 +59,32 @@ Apache DevLake is designed for developer teams looking to make better sense of t
### 1. Set up DevLake
-You can set up Apache DevLake by following our step-by-step instructions for [Install via Docker Compose](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup) or [Install via Kubernetes](https://devlake.apache.org/docs/GettingStarted/KubernetesSetup). Please ask community if you get stuck at any point.
+You can set up Apache DevLake by following our step-by-step instructions for [Install via Docker Compose](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup) or [Install via Kubernetes](https://devlake.apache.org/docs/GettingStarted/KubernetesSetup).
+Please see detailed instructions [here](https://devlake.apache.org/docs/Overview/Introduction#how-do-i-use-devlake), and ask the community if you get stuck at any point.
### 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 dashboards 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.
-
-
## 😍 How to Contribute
Please read the [contribution guidelines](https://devlake.apache.org/community) before you make contribution. The following docs list the resources you might need to know after you decided to make contribution.
- [Create an Issue](https://devlake.apache.org/community/make-contribution/fix-or-create-issues): Report a bug or feature request to Apache DevLake
-- [Put Up a PR](https://devlake.apache.org/community/make-contribution/development-workflow): Start with [good first issues](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [issues with no assignees](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
-- [Mailing list](https://devlake.apache.org/community/subscribe): Initiate or participate in project discussions on the mailing list
+- [Submit a PR](https://devlake.apache.org/community/make-contribution/development-workflow): Start with [good first issues](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [issues with no assignees](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
+- [Join Mailing list](https://devlake.apache.org/community/subscribe): Initiate or participate in project discussions on the mailing list
- [Write a Blog](https://devlake.apache.org/community/make-contribution/BlogSubmission): Write a blog to share your use cases about Apache DevLake
- [Contribute a Plugin](https://devlake.apache.org/docs/DeveloperManuals/PluginImplementation): [Add a plugin](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue+is%3Aopen+label%3Aadd-a-plugin+) to integrate Apache DevLake with more data sources for the community