Skip to content

Commit 804eb20

Browse files
authored
docs(main README): Fixes broken links for getting started on development. Rearranges existing getting started section to reduce duplication and make it logical for new users to get started. (#7305)
Making it easier for new users to get started. Fixes #7304
1 parent 9542510 commit 804eb20

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

README.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,36 +36,44 @@ limitations under the License.
3636

3737
[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.
3838

39-
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.
39+
Apache DevLake is used by Engineering Leads, Open Source Software Maintainers and development 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.
4040

4141
## 🎯 What can be accomplished with Apache DevLake?
4242

4343
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).
4444
2. From DORA to scrum retros, DevLake implements metrics effortlessly with prebuilt dashboards supporting common frameworks and goals.
4545
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.
4646

47-
## 👉 Live Demo
48-
[DORA Dashboard](https://grafana-lake.demo.devlake.io/grafana/d/qNo8_0M4z/dora?orgId=1)
47+
## 👉 Live Demos
4948

50-
[All Dashboards](https://devlake.apache.org/livedemo/EngineeringLeads/DORA)
49+
The main way you interact with DevLake is through the integrated dashboards powered by [Grafana](https://github.com/grafana/grafana).
50+
51+
[Live DORA Dashboard](https://grafana-lake.demo.devlake.io/grafana/d/qNo8_0M4z/dora?orgId=1)
52+
53+
[Dashboards for Engineering Leads](https://devlake.apache.org/livedemo/EngineeringLeads)
54+
55+
[Dashboards for OSS Maintainers](https://devlake.apache.org/livedemo/OSSMaintainers)
5156

5257
## 💪 Supported Data Sources
5358

54-
[Here](https://devlake.apache.org/docs/Overview/SupportedDataSources) you can find all data sources supported by DevLake, their scopes, supported versions and more!
59+
DevLake supports connections to many popular development tools, including GitHub, GitLab, Jenkins, Jira, Sonarqube and more. [Here](https://devlake.apache.org/docs/Overview/SupportedDataSources) you can find all data sources supported by DevLake, their scopes, supported versions and more!
5560

5661

5762
## 🚀 Getting Started
5863

64+
### Installation
65+
You can set up Apache DevLake by following our step-by-step instructions for either Docker Compose or Helm. Feel free to [ask the community](#💙-community) if you get stuck at any point.
66+
5967
- [Install via Docker Compose](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup)
6068
- [Install via Helm](https://devlake.apache.org/docs/GettingStarted/HelmSetup)
61-
- [Install in Developer Mode](https://devlake.apache.org/docs/DeveloperManuals/DeveloperSetup)
6269

63-
## 🤓 How do I use DevLake?
70+
## 🤓 Usage
71+
72+
Please see [detailed usage instructions](https://devlake.apache.org/docs/Overview/Introduction#how-do-i-use-devlake). Here's an overview on how to get started using DevLake.
6473

6574
### 1. Set up DevLake
6675

67-
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 Helm](https://devlake.apache.org/docs/GettingStarted/HelmSetup).
68-
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.
76+
Install using either [Docker Compose](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup) or [Helm](https://devlake.apache.org/docs/GettingStarted/HelmSetup).
6977

7078
### 2. Create a Blueprint
7179

@@ -83,17 +91,26 @@ Once the first run of the Blueprint is completed, you can view the corresponding
8391

8492
If the pre-built dashboards are limited for your use cases, you can always customize or create your own metrics or dashboards with SQL.
8593

86-
## 😍 How to Contribute
87-
94+
## Contributing
8895
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.
8996

9097
- [Create an Issue](https://devlake.apache.org/community/MakingContributions/fix-or-create-issues): Report a bug or feature request to Apache DevLake
9198
- [Submit a PR](https://devlake.apache.org/community/MakingContributions/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)
9299
- [Join Mailing list](https://devlake.apache.org/community/subscribe): Initiate or participate in project discussions on the mailing list
93100
- [Write a Blog](https://devlake.apache.org/community/MakingContributions/BlogSubmission): Write a blog to share your use cases about Apache DevLake
94-
- [Develop a Plugin](./backend/DevelopmentSetup): [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
101+
- [Develop a Plugin](./backend/DevelopmentManual): Integrate Apache DevLake with more data sources as [requested by the community](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue+is%3Aopen+label%3Aadd-a-plugin+)
102+
103+
### 👩🏾‍💻 Contributing Code
104+
105+
If you plan to contribute code to Apache DevLake, we have instructions on how to get started with setting up your Development environemtn.
106+
107+
- [Developer Setup Instructions](https://devlake.apache.org/docs/DeveloperManuals/DeveloperSetup)
108+
- [Development Workflow](https://devlake.apache.org/community/MakingContributions/development-workflow)
109+
110+
111+
### 📄 Contributing Documentation
95112

96-
## 📄 Contributing to Documentation:
113+
One of the best ways to get started contributing is by improving DevLake's documentation.
97114

98115
- Apache DevLake's documentation is hosted at [devlake.apache.org](https://devlake.apache.org/)
99116
- **We have a separate GitHub repository for Apache DevLake's documentation:** [github.com/apache/incubator-devlake-website](https://github.com/apache/incubator-devlake-website)

0 commit comments

Comments
 (0)