docs: add hackertoberfest and dora topics (#3300)

Co-authored-by: Startrekzky <kaiyun.zhang@merico.dev>
1 file changed
tree: 442a10dc3048b48e6e71be5339acb5d431e5a1ff
  1. .github/
  2. api/
  3. config/
  4. config-ui/
  5. deployment/
  6. devops/
  7. errors/
  8. generator/
  9. grafana/
  10. helpers/
  11. img/
  12. impl/
  13. logger/
  14. migration/
  15. models/
  16. plugins/
  17. releases/
  18. runner/
  19. scripts/
  20. services/
  21. test/
  22. utils/
  23. version/
  24. worker/
  25. .asf.yaml
  26. .editorconfig
  27. .env.example
  28. .gitignore
  29. .golangci-goheader.template
  30. .golangci.yaml
  31. .licenserc.yaml
  32. DISCLAIMER
  33. docker-compose.yml
  34. Dockerfile
  35. go.mod
  36. go.sum
  37. LICENSE
  38. main.go
  39. Makefile
  40. NOTICE
  41. README.md
README.md

Apache DevLake(Incubating)

PRs Welcome unit-test Go Report Card Slack

🤔 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 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. 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

All Dashbaords

💪 Supported Data Sources

Data SourceDomain(s)Supoorted VersionsPlugins
GitHubSource Code Management, Code Review, Issue TrackingCloudgithub, gitextractor, refdiff
GitLabSource Code Management, Code Review, Issue TrackingCloud, Community Edition 13.x+gitlab, gitextractor, refdiff
BitBucketSource Code Management, Code Review, Issue TrackingCloudbitbucket, gitextractor, refdiff
GiteeSource Code Management, Code Review, Issue TrackingCloudgitee, gitextractor, refdiff
JiraIssue TrackingCloud, Server 8.x+, Data Center 8.x+jira
TAPDIssue TrackingCloudtapd
JenkinsCI/CD2.263.x+jenkins
GitHub ActionCI/CDCloudgithub
GitLab CICI/CDCloud, Community Edition 13.x+gitlab
FeishuCalendarCloudfeishu
AESource Code Managementae

🚀 Getting Started

🤓 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 see detailed instructions here, 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 before you make contribution. The following docs list the resources you might need to know after you decided to make contribution.

📄 Contributing to Documentation:

⌚ 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.