This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
The following commit(s) were added to refs/heads/main by this push:
new f5dd0a7a fix: Correcting the links to installation docs (#2839)
f5dd0a7a is described below
commit f5dd0a7a0a45c49712bfbb13df9fa6a2a6b4c72c
Author: PalanikannanM <[email protected]>
AuthorDate: Fri Aug 26 07:43:50 2022 +0530
fix: Correcting the links to installation docs (#2839)
* links fixed for installation
* links fixed for setting up devlake section
---
README.md | 31 ++++++++++++++++---------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 427ade1a..5de7e990 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@
[](https://github.com/apache/incubator-devlake/actions/workflows/test.yml)
[](https://goreportcard.com/report/github.com/apache/incubator-devlake)
[](https://join.slack.com/t/devlake-io/shared_invite/zt-17b6vuvps-x98pqseoUagM7EAmKC82xQ)
+
</div>
<br>
<div align="left">
@@ -19,18 +20,16 @@
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/EngineeringMetrics) 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).
-
## 💪 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+ |
@@ -38,42 +37,46 @@ Apache DevLake is designed for developer teams looking to
make better sense of t
| [Feishu](https://devlake.apache.org/docs/Plugins/feishu) | Documentation
| Cloud |
| TAPD | Issue
Management | Cloud
|
-
-
## 🚀 Getting Started
-- [Install via Docker
Compose](https://devlake.apache.org/docs/QuickStart/DockerComposeSetup)
-- [Install via
Kubernetes](https://devlake.apache.org/docs/QuickStart/KubernetesSetup)
-- [Install in Temporal
Mode](https://devlake.apache.org/docs/QuickStart/TemporalSetup)
-- [Install in Developer
Mode](https://devlake.apache.org/docs/DeveloperManuals/DeveloperSetup)
-
+- [Install via Docker
Compose](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup)
+- [Install via
Kubernetes](https://devlake.apache.org/docs/GettingStarted/KubernetesSetup)
+- [Install via Helm ](https://devlake.apache.org/docs/GettingStarted/HelmSetup)
+- [Install in Temporal
Mode](https://devlake.apache.org/docs/GettingStarted/TemporalSetup)
+- [Install in Developer
Mode](https://devlake.apache.org/docs/DeveloperManuals/DeveloperSetup)
## 🤓 How do I use DevLake?
+
### 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/QuickStart/DockerComposeSetup) or
[Install via
Kubernetes](https://devlake.apache.org/docs/QuickStart/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 ask 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 contributon.
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
@@ -82,10 +85,9 @@ Please read the [contribution
guidelines](https://devlake.apache.org/community)
- [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
-
## ⌚ Project Roadmap
-- <a href="https://devlake.apache.org/docs/Overview/Roadmap";
target="_blank">Roadmap 2022</a>: Detailed project roadmaps for 2022.
+- <a href="https://devlake.apache.org/docs/Overview/Roadmap";
target="_blank">Roadmap 2022</a>: Detailed project roadmaps for 2022.
## 💙 Community
@@ -94,7 +96,6 @@ Please read the [contribution
guidelines](https://devlake.apache.org/community)
- Wechat Community:<br/>
-
## 📄 License<a id="license"></a>
This project is licensed under Apache License 2.0 - see the [LICENSE](LICENSE)
file for details.
