incubator-devlake

README

Apache DevLake(Incubating)

🤔 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 Apache DevLake?

1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard data model.
2. Visualize out-of-the-box engineering 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 for data collection and ETL (Extract, Transform, Load).

💪 Supported Data Sources

Data Source	Domain	Supported Versions
GitHub	Source Code Management, Code Review, Issue Management	Cloud
Gitlab	Source Code Management, Code Review, Issue Management	Cloud, Community Edition 13.x+
Jira	Issue Management	Cloud, Server 8.x+, Data Center 8.x+
Jenkins	CI/CD	2.263.x+
Feishu	Documentation	Cloud
TAPD	Issue Management	Cloud

🚀 Getting Started

• Install via Docker Compose
• Install via Kubernetes
• Install via Helm
• Install in Temporal Mode
• Install in Developer Mode

🤓 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 or Install via Kubernetes. 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 before you make contribution. The following docs list the resources you might need to know after you decided to make contribution.

• Create an Issue: Report a bug or feature request to Apache DevLake
• Put Up a PR: Start with good first issues or issues with no assignees
• Mailing list: Initiate or participate in project discussions on the mailing list
• Write a Blog: Write a blog to share your use cases about Apache DevLake
• Contribute a Plugin: Add a plugin to integrate Apache DevLake with more data sources for the community

📄 Contributing to Documentation:

• Apache DevLake's documentation is hosted at devlake.apache.org
• We have a separate GitHub repository for Apache DevLake's documentation: github.com/apache/incubator-devlake-website

⌚ Project Roadmap

• Roadmap 2022: Detailed project roadmaps for 2022.

💙 Community

• Slack: Message us on Slack
• FAQ: Frequently Asked Questions
• Wechat Community:
  

📄 License

This project is licensed under Apache License 2.0 - see the LICENSE file for details.