Google GitGoogle Git
Sign in
apache/devlake-website/refs/heads/main
commit
4162feefe9bc75ae952100cb668e7265816bdec4
[log]
author
Itai Spiegel <itai.spiegel@gmail.com>
Wed Oct 14 09:57:56 2026 +0300
committer
GitHub <noreply@github.com>
Wed Oct 14 14:57:56 2026 +0800
tree
9c7305ec04f0e09426312e02aeee151d9ae647e9
parent
593f0ed0af31128702c1322c84e30afc2def0db6 [diff]
docs: add monorepo plugin documentation (#835)

Companion to apache/devlake#9037 (Plugin for per-sub-project DORA metrics
in a monorepo).

Adds a Plugins/monorepo page covering how deployments are attributed by CI
job name and pull requests by label, the per-project configuration on the
project settings page and its equivalent metric plugin option, the
unattributed/All reserved names, what the plugin writes, and the built-in
Monorepo Sub-Projects dashboard. It also states that only Deployment
Frequency and Lead Time for Changes are computed per sub-project, since
incidents are not attributed.

Documents the new sub_project columns on pull_requests,
pull_request_commits and project_pr_metrics plus the new
cicd_deployment_subprojects table in the domain layer schema, and links to
the plugin from the DORA page.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
3 files changed
tree: 9c7305ec04f0e09426312e02aeee151d9ae647e9
  1. .github/
  2. .idea/
  3. blog/
  4. community/
  5. docs/
  6. download/
  7. info/
  8. livedemo/
  9. src/
  10. static/
  11. versioned_docs/
  12. versioned_sidebars/
  13. .asf.yaml
  14. .gitignore
  15. .lycheeignore
  16. .nvmrc
  17. babel.config.js
  18. docusaurus.config.js
  19. package-lock.json
  20. package.json
  21. README.md
  22. sidebars.js
  23. sidebarsCommunity.js
  24. sidebarsDownload.js
  25. sidebarsLivedemo.js
  26. tailwind.config.js
  27. tailwind.preset.js
  28. test_server.sh
  29. versions.json
README.md

Apache DevLake Website

This project keeps all sources used for building up DevLake's official website which is served at https://devlake.apache.org/.

Prerequisite

Please also make sure your node version is 16.14+, version lower than 16.14.x is not supported yet.

Installation

NOTE: You can follow the below instructions to setup your developer environment in your local machine or use the gitpod method specified above to code without any prior setup ⚡️ as suggested above as well!

  1. Run yarn install or yarn in the root directory to install the dependencies.
  2. Run yarn start in the root directory to start a local server, you will see the website in http://localhost:3000.

Make sure you have the node version >=16.14. If you have a lower version of node installed, you may consider setting up nvm to allow different versions of node coexisting on your machine.

  1. Follow the instructions to install and setup nvm
  2. Run nvm install v16.14 to install node v16.14
  3. Run nvm use v16.14 to switch the working environment to node v16

How to send a PR

  1. Do not use git add . to commit all the changes.
  2. Just push your changed files, such as:
  • *.md
  • blog.js or docs.js or site.js
  1. Send a PR to main branch.

For detailed steps to create a PR, please refer: Development Workflow page

Blog Submission

We'd love to hear your thoughts both in creating and using DevLake! To submit a blog post to DevLake Blog, please follow the instructions here.