From 3b102a0bf7061221a2241f20091f4f37164e954c Mon Sep 17 00:00:00 2001 From: Klesh Wong Date: Wed, 2 Sep 2026 15:24:49 +0800 Subject: [PATCH 1/2] chore: remove incubating wording --- .../contributor-growth-program.md | 2 +- .../development-workflow.md | 12 +++---- .../fix-or-create-issues.md | 2 +- docs/Configuration/APIKeys.md | 2 +- docs/Configuration/AdvancedMode.md | 8 ++--- docs/Configuration/AzureDevOps.md | 2 +- docs/Configuration/BitBucket.md | 2 +- docs/Configuration/BitBucketServer.md | 2 +- docs/Configuration/CircleCI.md | 2 +- .../Dashboards/GrafanaUserGuide.md | 2 +- docs/Configuration/GitHub.md | 2 +- docs/Configuration/GitLab.md | 2 +- .../HowToOrganizeDevlakeProjects.md | 4 +-- docs/Configuration/Incidentio.md | 2 +- docs/Configuration/Jenkins.md | 2 +- docs/Configuration/Jira.md | 2 +- docs/Configuration/Opsgenie.md | 2 +- docs/Configuration/PagerDuty.md | 2 +- docs/Configuration/SonarQube.md | 2 +- docs/Configuration/Tapd.md | 2 +- docs/Configuration/TeamConfiguration.md | 4 +-- docs/Configuration/Teambition.md | 2 +- docs/Configuration/Tutorial.md | 4 +-- docs/Configuration/Zentao.md | 2 +- docs/Configuration/webhook.md | 2 +- docs/DORA.md | 2 +- docs/DataModels/DevLakeDomainLayerSchema.md | 36 +++++++++---------- docs/DeveloperManuals/DBMigration.md | 10 +++--- docs/DeveloperManuals/Dal.md | 2 +- docs/DeveloperManuals/DeveloperSetup.md | 6 ++-- docs/DeveloperManuals/PluginImplementation.md | 4 +-- docs/DeveloperManuals/Project.md | 2 +- docs/DeveloperManuals/Release-SOP.md | 28 +++++++-------- docs/DeveloperManuals/ReservedColumns.md | 4 +-- docs/DeveloperManuals/SourceCodeReference.md | 2 +- docs/DeveloperManuals/UnitTest.md | 2 +- docs/GettingStarted/Authentication.md | 2 +- docs/GettingStarted/DockerComposeSetup.md | 8 ++--- docs/GettingStarted/Environment.md | 2 +- docs/GettingStarted/HelmSetup.md | 2 +- docs/GettingStarted/Upgrade.md | 2 +- docs/Overview/Introduction.md | 2 +- docs/Overview/Roadmap.md | 8 ++--- docs/Plugins/github.md | 2 +- docs/Plugins/refdiff.md | 6 ++-- docs/Plugins/webhook.md | 2 +- docs/Troubleshooting/Configuration.md | 12 +++---- docs/Troubleshooting/Dashboard.md | 2 +- docs/Troubleshooting/Installation.md | 4 +-- docusaurus.config.js | 2 +- src/components/Sections/HomepageHeader.tsx | 2 +- 51 files changed, 114 insertions(+), 114 deletions(-) diff --git a/community/MakingContributions/contributor-growth-program.md b/community/MakingContributions/contributor-growth-program.md index 25307def6f8..98bf15369ad 100644 --- a/community/MakingContributions/contributor-growth-program.md +++ b/community/MakingContributions/contributor-growth-program.md @@ -3,7 +3,7 @@ sidebar_position: 04 title: "Becoming a Committer" --- -The Apache Devlake (Incubating) community follows the [Apache Software Foundation's guidelines](https://community.apache.org/contributors/) on accepting new committers. +The Apache Devlake community follows the [Apache Software Foundation's guidelines](https://community.apache.org/contributors/) on accepting new committers. First, we deeply value the contribution from our community, in the forms of writing code, answering questions, maintaining documentation, arranging events, among a plethora of others. New contributors will always be welcomed by the current members of DevLake community, helped with PR workflow, and directed to relevant documentation and communication channels. diff --git a/community/MakingContributions/development-workflow.md b/community/MakingContributions/development-workflow.md index fb14b5c0785..a17c9ce265a 100644 --- a/community/MakingContributions/development-workflow.md +++ b/community/MakingContributions/development-workflow.md @@ -9,7 +9,7 @@ This document shows the workflow of how to develop DevLake. ## Step 1 - Fork the repo -1. Visit the DevLake repo: https://github.com/apache/incubator-devlake; +1. Visit the DevLake repo: https://github.com/apache/devlake; 2. Click the Fork button to create a fork of the DevLake; 3. We assume your fork is called `https://github.com/{user}/{repo}`. @@ -21,13 +21,13 @@ This document shows the workflow of how to develop DevLake. ```sh mkdir -p ${WORKING_PATH} cd ${WORKING_PATH} -# You can also use the url: github.com/apache/incubator-devlake +# You can also use the url: github.com/apache/devlake # if your ssh configuration is proper git clone https://github.com/{user}/{repo}.git cd ${PROJECT} -git remote add upstream https://github.com/apache/incubator-devlake.git +git remote add upstream https://github.com/apache/devlake.git # Never push to upstream locally git remote set-url --push upstream no_push ``` @@ -37,9 +37,9 @@ git remote set-url --push upstream no_push Execute `git remote -v` and you'll see output like below: ```sh -origin github.com/{user}/incubator-devlake.git (fetch) -origin github.com/{user}/incubator-devlake.git (push) -upstream https://github.com/apache/incubator-devlake.git (fetch) +origin github.com/{user}/devlake.git (fetch) +origin github.com/{user}/devlake.git (push) +upstream https://github.com/apache/devlake.git (fetch) upstream no_push (push) ``` diff --git a/community/MakingContributions/fix-or-create-issues.md b/community/MakingContributions/fix-or-create-issues.md index fe0684cc844..5adb95e01d3 100644 --- a/community/MakingContributions/fix-or-create-issues.md +++ b/community/MakingContributions/fix-or-create-issues.md @@ -11,7 +11,7 @@ So, we decided, no more competition, you can pick whatever you like from our github issue pages, or even create your own one if no more left! We are community after all! -Now, how do we proceed? It's simple! Go to our [issues page](https://github.com/apache/incubator-devlake/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and then click here. all our Good First Issue are listed out here. +Now, how do we proceed? It's simple! Go to our [issues page](https://github.com/apache/devlake/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and then click here. all our Good First Issue are listed out here. ![good first issue](/img/Community/screenshots/issue_page_screenshot.png) - Firstly, go for existing issues if any, find one that you like, diff --git a/docs/Configuration/APIKeys.md b/docs/Configuration/APIKeys.md index 00077224163..1e3b3a7e0d3 100644 --- a/docs/Configuration/APIKeys.md +++ b/docs/Configuration/APIKeys.md @@ -31,4 +31,4 @@ It is typically not necessary to manually create an API key from the 'API keys' ## Troubleshooting -If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/AdvancedMode.md b/docs/Configuration/AdvancedMode.md index daf6a1a2d0f..ca87d38d8ba 100644 --- a/docs/Configuration/AdvancedMode.md +++ b/docs/Configuration/AdvancedMode.md @@ -44,7 +44,7 @@ Collect multiple GitHub repos sequentially. Below is an example for collecting 2 "Plugin": "github", "Options": { "connectionId": 1, - "repo": "incubator-devlake", + "repo": "devlake", "owner": "apache" } }, @@ -63,8 +63,8 @@ Collect multiple GitHub repos sequentially. Below is an example for collecting 2 GitHub: - `connectionId`: The ID of your GitHub connection at page http://localhost:4000/connections/github. -- `owner`: Just take a look at the URL: https://github.com/apache/incubator-devlake, owner is `apache`. -- `repo`: Just take a look at the URL: https://github.com/apache/incubator-devlake, repo is `incubator-devlake`. +- `owner`: Just take a look at the URL: https://github.com/apache/devlake, owner is `apache`. +- `repo`: Just take a look at the URL: https://github.com/apache/devlake, repo is `devlake`. ### 2. GitLab @@ -393,4 +393,4 @@ To edit a Blueprint created in the Advanced mode, you can simply go the Configur ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/AzureDevOps.md b/docs/Configuration/AzureDevOps.md index c0ca15ba371..398d981246e 100644 --- a/docs/Configuration/AzureDevOps.md +++ b/docs/Configuration/AzureDevOps.md @@ -102,4 +102,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/BitBucket.md b/docs/Configuration/BitBucket.md index 896f60e21e7..2da5d155fe0 100644 --- a/docs/Configuration/BitBucket.md +++ b/docs/Configuration/BitBucket.md @@ -238,4 +238,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues). +If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues). diff --git a/docs/Configuration/BitBucketServer.md b/docs/Configuration/BitBucketServer.md index 3baaf9972a4..8ff1e8c69b7 100644 --- a/docs/Configuration/BitBucketServer.md +++ b/docs/Configuration/BitBucketServer.md @@ -119,4 +119,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues). \ No newline at end of file +If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues). \ No newline at end of file diff --git a/docs/Configuration/CircleCI.md b/docs/Configuration/CircleCI.md index ead292f3281..b4f6bd838db 100644 --- a/docs/Configuration/CircleCI.md +++ b/docs/Configuration/CircleCI.md @@ -103,4 +103,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Dashboards/GrafanaUserGuide.md b/docs/Configuration/Dashboards/GrafanaUserGuide.md index 127db67e6a6..d1695bf22ae 100644 --- a/docs/Configuration/Dashboards/GrafanaUserGuide.md +++ b/docs/Configuration/Dashboards/GrafanaUserGuide.md @@ -132,4 +132,4 @@ To ensure we have properly connected our database to the data source in Grafana, ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Dashboard.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Dashboard.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/GitHub.md b/docs/Configuration/GitHub.md index db5e4aaba13..72eef9bd8e7 100644 --- a/docs/Configuration/GitHub.md +++ b/docs/Configuration/GitHub.md @@ -224,4 +224,4 @@ You can also trigger the data sync at the **General Settings/Status** page (The ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/GitLab.md b/docs/Configuration/GitLab.md index 762385ac04e..a45997d0721 100644 --- a/docs/Configuration/GitLab.md +++ b/docs/Configuration/GitLab.md @@ -136,4 +136,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/HowToOrganizeDevlakeProjects.md b/docs/Configuration/HowToOrganizeDevlakeProjects.md index 691eb2813f5..5d39614cd8b 100644 --- a/docs/Configuration/HowToOrganizeDevlakeProjects.md +++ b/docs/Configuration/HowToOrganizeDevlakeProjects.md @@ -78,7 +78,7 @@ To take an example we will analyze 2 `projects`: DevLake and [Spark](https://spa Both are independent of each other. Assume that ASF wants to check the health of the development and maintenance of these projects with DORA. -DevLake manages 3 `repos`: [incubator-devlake](https://github.com/apache/incubator-devlake), +DevLake manages 3 `repos`: [devlake](https://github.com/apache/devlake), [devlake-website](https://github.com/apache/devlake-website), and [devlake-helm-chart](https://github.com/apache/devlake-helm-chart). There are many repos related to _Spark_ in one way or another. To keep it simple, @@ -222,4 +222,4 @@ project that uses that webhook**. More information available on the [Webhook](/d Please check out the [Debugging DORA Issue Metrics](../Troubleshooting/Dashboard.md#debugging-dora-issue-metrics) to debug DORA dashboard. -If you still run into any problems, please check the [Troubleshooting](/docs/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) \ No newline at end of file +If you still run into any problems, please check the [Troubleshooting](/docs/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) \ No newline at end of file diff --git a/docs/Configuration/Incidentio.md b/docs/Configuration/Incidentio.md index c8b53f36967..b94d96227c5 100644 --- a/docs/Configuration/Incidentio.md +++ b/docs/Configuration/Incidentio.md @@ -63,4 +63,4 @@ Click on **Collect Data** to start collecting data for the whole project. ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Jenkins.md b/docs/Configuration/Jenkins.md index fd417562649..80eaac9fa03 100644 --- a/docs/Configuration/Jenkins.md +++ b/docs/Configuration/Jenkins.md @@ -78,4 +78,4 @@ You can choose how often you would like to sync your data in this step by select ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Jira.md b/docs/Configuration/Jira.md index 2cd3c0df3f2..49a86d1eb74 100644 --- a/docs/Configuration/Jira.md +++ b/docs/Configuration/Jira.md @@ -154,4 +154,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Opsgenie.md b/docs/Configuration/Opsgenie.md index cf9ed0ae143..387aa8cc189 100644 --- a/docs/Configuration/Opsgenie.md +++ b/docs/Configuration/Opsgenie.md @@ -80,4 +80,4 @@ Click on "Collect Data" to start collecting data for the whole project. You can ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/PagerDuty.md b/docs/Configuration/PagerDuty.md index e18e17ac47c..9df64b6647a 100644 --- a/docs/Configuration/PagerDuty.md +++ b/docs/Configuration/PagerDuty.md @@ -55,4 +55,4 @@ You can also trigger the data sync at the **General Settings/Status** page (The ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/SonarQube.md b/docs/Configuration/SonarQube.md index a0c272ed1dd..60ec8f6163e 100644 --- a/docs/Configuration/SonarQube.md +++ b/docs/Configuration/SonarQube.md @@ -76,4 +76,4 @@ You can also trigger the data sync at the **General Settings/Status** page (the ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Tapd.md b/docs/Configuration/Tapd.md index b575f2f7961..1d2332e4572 100644 --- a/docs/Configuration/Tapd.md +++ b/docs/Configuration/Tapd.md @@ -72,5 +72,5 @@ You can choose how often you would like to sync your data in this step by select ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/TeamConfiguration.md b/docs/Configuration/TeamConfiguration.md index 2dc6fd79b1e..756a4b09317 100644 --- a/docs/Configuration/TeamConfiguration.md +++ b/docs/Configuration/TeamConfiguration.md @@ -119,7 +119,7 @@ For example, the GitHub plugin would create one entry in the `accounts` table fo ``` INSERT INTO `accounts` (`id`, `created_at`, `updated_at`, `_raw_data_params`, `_raw_data_table`, `_raw_data_id`, `_raw_data_remark`, `email`, `full_name`, `user_name`, `avatar_url`, `organization`, `created_date`, `status`) VALUES - ('github:GithubAccount:1:1234', '2022-07-12 10:54:09.632', '2022-07-12 10:54:09.632', '{\"ConnectionId\":1,\"Owner\":\"apache\",\"Repo\":\"incubator-devlake\"}', '_raw_github_api_pull_request_reviews', 28, '', 'TyroneKCummings@teleworm.us', '', 'Tyrone K. Cummings', 'https://avatars.githubusercontent.com/u/101256042?u=a6e460fbaffce7514cbd65ac739a985f5158dabc&v=4', '', NULL, 0), + ('github:GithubAccount:1:1234', '2022-07-12 10:54:09.632', '2022-07-12 10:54:09.632', '{\"ConnectionId\":1,\"Owner\":\"apache\",\"Repo\":\"devlake\"}', '_raw_github_api_pull_request_reviews', 28, '', 'TyroneKCummings@teleworm.us', '', 'Tyrone K. Cummings', 'https://avatars.githubusercontent.com/u/101256042?u=a6e460fbaffce7514cbd65ac739a985f5158dabc&v=4', '', NULL, 0), ('jira:JiraAccount:1:629cdf', '2022-07-12 10:54:09.632', '2022-07-12 10:54:09.632', '{\"ConnectionId\":1,\"BoardId\":\"76\"}', '_raw_jira_api_users', 5, '', 'DorothyRUpdegraff@dayrep.com', '', 'Dorothy R. Updegraff', 'https://avatars.jiraxxxx158dabc&v=4', '', NULL, 0); ``` @@ -206,4 +206,4 @@ FROM accounts a ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Teambition.md b/docs/Configuration/Teambition.md index 2623edb1535..6c35b41ce1e 100644 --- a/docs/Configuration/Teambition.md +++ b/docs/Configuration/Teambition.md @@ -53,4 +53,4 @@ Please go to the `Blueprints` page and switch to advanced mode. See how to use a ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/Tutorial.md b/docs/Configuration/Tutorial.md index a987bea062b..5ee1e205591 100644 --- a/docs/Configuration/Tutorial.md +++ b/docs/Configuration/Tutorial.md @@ -55,9 +55,9 @@ Three modes. - First, re-run the failed task once all other tasks have completed. If the task still fails, proceed to the next steps. - Capture a screenshot of the error message associated with the failed task. - Download the logs from the pipeline for further analysis. -- Visit the [GitHub repository](https://github.com/apache/incubator-devlake/issues) and create a bug report. Include the captured screenshot and the downloaded logs in the bug report. +- Visit the [GitHub repository](https://github.com/apache/devlake/issues) and create a bug report. Include the captured screenshot and the downloaded logs in the bug report. ![img](/img/ConfigUI/BlueprintEditing/blueprint-edit3.png) -For other problems, please check the [troubleshooting](/Troubleshooting/Configuration.md) doc, [create an issue](https://github.com/apache/incubator-devlake/issues), or contact us on [Slack](https://join.slack.com/t/devlake-io/shared_invite/zt-1lkgbdmys-AU2azidzO1u~mtjlg9my7A). +For other problems, please check the [troubleshooting](/Troubleshooting/Configuration.md) doc, [create an issue](https://github.com/apache/devlake/issues), or contact us on [Slack](https://join.slack.com/t/devlake-io/shared_invite/zt-1lkgbdmys-AU2azidzO1u~mtjlg9my7A). diff --git a/docs/Configuration/Zentao.md b/docs/Configuration/Zentao.md index 51a96af3d0f..24ba7dfb220 100644 --- a/docs/Configuration/Zentao.md +++ b/docs/Configuration/Zentao.md @@ -55,5 +55,5 @@ You can choose how often you would like to sync your data in this step by select ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Configuration/webhook.md b/docs/Configuration/webhook.md index 9eb5621d373..50918b6dd05 100644 --- a/docs/Configuration/webhook.md +++ b/docs/Configuration/webhook.md @@ -48,4 +48,4 @@ Note: If you post incidents using webhook due to your tool not being supported b ## Troubleshooting -If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/incubator-devlake/issues). +If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues). diff --git a/docs/DORA.md b/docs/DORA.md index 7ddebfced87..d828d3388c5 100644 --- a/docs/DORA.md +++ b/docs/DORA.md @@ -214,4 +214,4 @@ To create the DORA dashboard with your own toolchain, please look at the [config ## Troubleshooting -If you run into any problem, please check the DORA debug dashboard, [DORA troubleshooting documentation](/Troubleshooting/Dashboard.md#debugging-dora-issue-metrics) or [create an issue](https://github.com/apache/incubator-devlake/issues) on GitHub. +If you run into any problem, please check the DORA debug dashboard, [DORA troubleshooting documentation](/Troubleshooting/Dashboard.md#debugging-dora-issue-metrics) or [create an issue](https://github.com/apache/devlake/issues) on GitHub. diff --git a/docs/DataModels/DevLakeDomainLayerSchema.md b/docs/DataModels/DevLakeDomainLayerSchema.md index 3440903eec4..4676005c75f 100644 --- a/docs/DataModels/DevLakeDomainLayerSchema.md +++ b/docs/DataModels/DevLakeDomainLayerSchema.md @@ -75,7 +75,7 @@ An `issue` is the abstraction of GitHub/GitLab/BitBucket/Jira/TAPD/Zentao... iss | **field** | **type** | **length** | **description** | **key** | |:----------------------------|:----------------------------------------------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------| | `id` | varchar | 255 | An issue's `id` is composed of < plugin >:< Entity >:< PK0 >[:PK1]..." | PK | -| `issue_key` | varchar | 255 | The key of this issue. For example, the key of this Github [issue](https://github.com/apache/incubator-devlake/issues/1145) is 1145. | | +| `issue_key` | varchar | 255 | The key of this issue. For example, the key of this Github [issue](https://github.com/apache/devlake/issues/1145) is 1145. | | | `url` | varchar | 255 | The url of the issue. It's a web address in most cases. | | | `title` | varchar | 255 | The title of an issue | | | `description` | longtext | | The detailed description/summary of an issue | | @@ -217,14 +217,14 @@ group by field_value; #### boards -A `board` is an issue list or a collection of issues. It's the abstraction of a Jira board, a Jira or TAPD project, a [GitHub repo's issue list](https://github.com/apache/incubator-devlake/issues) or a GitLab repo's issue list. This table can be used to filter issues by the boards they belong to. +A `board` is an issue list or a collection of issues. It's the abstraction of a Jira board, a Jira or TAPD project, a [GitHub repo's issue list](https://github.com/apache/devlake/issues) or a GitLab repo's issue list. This table can be used to filter issues by the boards they belong to. | **field** | **type** | **length** | **description** | **key** | |:---------------|:---------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------| | `id` | varchar | 255 | A board's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..." | PK | -| `name` | varchar | 255 | The name of the board. Note: the board name of a Github repo 'apache/incubator-devlake' is 'apache/incubator-devlake', representing the [default issue list](https://github.com/apache/incubator-devlake/issues). | | +| `name` | varchar | 255 | The name of the board. Note: the board name of a Github repo 'apache/devlake' is 'apache/devlake', representing the [default issue list](https://github.com/apache/devlake/issues). | | | `description` | varchar | 255 | The description of the board. | | -| `url` | varchar | 255 | The url of the board. E.g. https://github.com/apache/incubator-devlake/issues | | +| `url` | varchar | 255 | The url of the board. E.g. https://github.com/apache/devlake/issues | | | `created_date` | datetime | 3 | Board creation time | | | `type` | varchar | 255 | Identify scrum and non-scrum board | | @@ -244,8 +244,8 @@ issues. | **field** | **type** | **length** | **description** | **key** | |:--------------------|:---------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------| -| `id` | varchar | 255 | A sprint's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..." | PK | -| `name` | varchar | 255 | The name of sprint.
For Github projects, the sprint name is the milestone name. For instance, 'v0.10.0 - Introduce Temporal to DevLake' is the name of this [sprint](https://github.com/apache/incubator-devlake/milestone/5). | | +| `id` | varchar | 255 | A sprint's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..." | PK | +| `name` | varchar | 255 | The name of sprint.
For Github projects, the sprint name is the milestone name. For instance, 'v0.10.0 - Introduce Temporal to DevLake' is the name of this [sprint](https://github.com/apache/devlake/milestone/5). | | | `url` | varchar | 255 | The url of sprint. | | | `status` | varchar | 255 | There are 3 statuses of a sprint: | | | `started_date` | datetime | 3 | The start time of a sprint | | @@ -320,11 +320,11 @@ GitHub, GitLab or BitBucket repositories. | **field** | **type** | **length** | **description** | **key** | |:---------------|:---------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------| | `id` | varchar | 255 | A repo's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..."
For example, a Github repo's id is like "< github >:< GithubRepos >:< ConnectionId >:< GithubRepoId >". E.g. 'github:GithubRepos:1:384111310' | PK | -| `name` | longtext | | The name of repo. For DevLake, it's 'apache/incubator-devlake' | | +| `name` | longtext | | The name of repo. For DevLake, it's 'apache/devlake' | | | `description` | longtext | | The description of repo. | | -| `url` | longtext | | The url of repo. E.g. https://github.com/apache/incubator-devlake | | +| `url` | longtext | | The url of repo. E.g. https://github.com/apache/devlake | | | `owner_id` | varchar | 255 | The id of the owner of repo | FK_accounts.id | -| `language` | varchar | 255 | The major language of repo. E.g. The language for apache/incubator-devlake is 'Go' | | +| `language` | varchar | 255 | The major language of repo. E.g. The language for apache/devlake is 'Go' | | | `forked_from` | longtext | | Empty unless the repo is a fork in which case it contains the `id` of the repo the repo is forked from. | | | `deleted` | tinyint | 1 | 0: repo is active 1: repo has been deleted | | | `created_date` | datetime | 3 | Repo creation date | | @@ -347,7 +347,7 @@ A ref is the abstraction of a branch or tag. | **field** | **type** | **length** | **description** | **key** | |:-------------|:---------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------| | `id` | varchar | 255 | A ref's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..."
For example, a Github ref is composed of "github:GithubRepos:< GithubRepoId >:< RefUrl >". E.g. The id of release v5.3.0 of PingCAP/TiDB project is 'github:GithubRepos:384111310:refs/tags/v5.3.0' A repo's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..." | PK | -| `name` | varchar | 255 | The name of the ref. E.g. '[refs/tags/v0.9.3](https://github.com/apache/incubator-devlake/tree/v0.9.3)' or 'origin/main' | | +| `name` | varchar | 255 | The name of the ref. E.g. '[refs/tags/v0.9.3](https://github.com/apache/devlake/tree/v0.9.3)' or 'origin/main' | | | `repo_id` | varchar | 255 | The id of repo this ref belongs to | FK_repos.id | | `commit_sha` | char | 40 | The commit this ref points to at the time of collection | | | `is_default` | tinyint | 1 | | | @@ -357,7 +357,7 @@ A ref is the abstraction of a branch or tag. This table shows the commits added in a new commit compared to an old commit. This table can be used to support tag-based and deploy-based metrics. -The records of this table are computed by [RefDiff](https://github.com/apache/incubator-devlake/tree/main/backend/plugins/refdiff) plugin. The computation should be manually triggered after using [GitRepoExtractor](https://github.com/apache/incubator-devlake/tree/main/backend/plugins/gitextractor) to collect commits and refs. The algorithm behind is similar to [this](https://github.com/apache/incubator-devlake/compare/v0.8.0%E2%80%A6v0.9.0). +The records of this table are computed by [RefDiff](https://github.com/apache/devlake/tree/main/backend/plugins/refdiff) plugin. The computation should be manually triggered after using [GitRepoExtractor](https://github.com/apache/devlake/tree/main/backend/plugins/gitextractor) to collect commits and refs. The algorithm behind is similar to [this](https://github.com/apache/devlake/compare/v0.8.0%E2%80%A6v0.9.0). | **field** | **type** | **length** | **description** | **key** | |:-----------------|:---------|:-----------|:---------------------------------------------------------------------------|:--------| @@ -391,7 +391,7 @@ The records of this table are computed by [RefDiff](https://github.com/apache/in | `committer_id` | varchar | 255 | The id of committer | FK_accounts.id | | `additions` | bigint | | Added lines of code | | | `deletions` | bigint | | Deleted lines of code | | -| `dev_eq` | int | | A metric that quantifies the amount of code contribution. The data can be retrieved from [AE plugin](https://github.com/apache/incubator-devlake/tree/main/backend/plugins/ae). | | +| `dev_eq` | int | | A metric that quantifies the amount of code contribution. The data can be retrieved from [AE plugin](https://github.com/apache/devlake/tree/main/backend/plugins/ae). | | #### commit_files @@ -446,10 +446,10 @@ Pull requests are the abstraction of GitHub pull requests, GitLab merge requests | `id` | varchar | 255 | A pull request's `id` is composed of "< plugin >:< Entity >:< PK0 >[:PK1]..." E.g. For 'github:GithubPullRequests:1347' | | | `title` | longtext | | The title of pull request | | | `description` | longtext | | The body/description of pull request | | -| `status` | varchar | 100 | The PR/MR statuses are standardized to 'OPEN', 'MERGED' and 'CLOSED'. [Learn how each plugin's PR statuses are standardized](https://github.com/apache/incubator-devlake/issues/4745). | | +| `status` | varchar | 100 | The PR/MR statuses are standardized to 'OPEN', 'MERGED' and 'CLOSED'. [Learn how each plugin's PR statuses are standardized](https://github.com/apache/devlake/issues/4745). | | | `original_status` | varchar | 100 | The original status of pull requests. | | | `parent_pr_id` | varchar | 255 | The id of the parent PR | | -| `pull_request_key` | varchar | 255 | The key of PR. E.g. 1563 is the key of this [PR](https://github.com/apache/incubator-devlake/pull/1563) | | +| `pull_request_key` | varchar | 255 | The key of PR. E.g. 1563 is the key of this [PR](https://github.com/apache/devlake/pull/1563) | | | `base_repo_id` | varchar | 255 | The repo that will be updated. | | | `head_repo_id` | varchar | 255 | The repo containing the changes that will be added to the base. If the head repository is NULL, this means that the corresponding project had been deleted when DevLake processed the pull request. | | | `author_name` | varchar | 100 | The author's name of the pull request | | @@ -524,7 +524,7 @@ The entity to filter or group 'cicd_pipelines'. | `id` | varchar | 255 | A cicd_scope's `id` is composed of "< plugin >:< Entity >:< PluginConnectionId >[:PK1]..."
For example, a GitHub cicd_scope's id is "github:GithubRepos:< GithubConnectionId >:< GithubRepoId >", a Bamboo cicd_scope's id is 'bamboo:BambooPlan:< BambooConnectionId >:< BambooPlanKey >' | PK | | `name` | varchar | 255 | The name of cicd_scope. | | | `description` | longtext | | The description of cicd_scope. | | -| `url` | varchar | 255 | The url of cicd_scope. E.g. https://github.com/apache/incubator-devlake or https://jenkins.xxx.cn/view/PROD/job/OPS_releasev2/ | | +| `url` | varchar | 255 | The url of cicd_scope. E.g. https://github.com/apache/devlake or https://jenkins.xxx.cn/view/PROD/job/OPS_releasev2/ | | | `created_date` | datetime | 3 | Creation date of the cicd_scope, nullable | | | `updated_date` | datetime | 3 | Updation date of the cicd_scope, nullable | | @@ -634,7 +634,7 @@ Normally, one deployment only deploy to one repo. But in some cases, one deploym | **field** | **type** | **length** | **description** | **key** | |:------------------------------------|:---------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------| -| `id` | varchar | 255 | This key is the combination of the deployment's id and repo_url, e.g.
- from a GitHub workflow run: github:GithubRun:1:384111310:3521097091:https://github.com/apache/incubator-devlake
- from a Jenkins build, jenkins:JenkinsBuild:1:deploy#7:https://github.com/apache/incubator-devlake
- from a webhook, webhook:1:90489d3951711d72:e6bde456807818c5c78d7b265964d6d48b653af6 | PK | +| `id` | varchar | 255 | This key is the combination of the deployment's id and repo_url, e.g.
- from a GitHub workflow run: github:GithubRun:1:384111310:3521097091:https://github.com/apache/devlake
- from a Jenkins build, jenkins:JenkinsBuild:1:deploy#7:https://github.com/apache/devlake
- from a webhook, webhook:1:90489d3951711d72:e6bde456807818c5c78d7b265964d6d48b653af6 | PK | | `cicd_scope_id` | varchar | 255 | The id of cicd_scope this deployment_commit belongs to | FK_cicd_scopes.id | | `cicd_deployment_id` | varchar | 255 | The deployment_id of this deployment_commit. The value will be set with `id` when it comes from webhooks. | | | `name` | varchar | 255 | The name of the deployment | | @@ -812,7 +812,7 @@ A low-level mapping between "issue tracking" and "source code management" domain The original connection between these two entities lies in either issue tracking tools like Jira or source code management tools like GitLab. You have to use tools to accomplish this. -For example, a common method to connect Jira issue and GitLab commit is a GitLab plugin [Jira Integration](https://docs.gitlab.com/ee/integration/jira/). With this plugin, the Jira issue key in the commit message written by the committers will be parsed. Then, the plugin will add the commit urls under this jira issue. Hence, DevLake's [Jira plugin](https://github.com/apache/incubator-devlake/tree/main/backend/plugins/jira) can get the related commits (including repo, commit_id, url) of an issue. +For example, a common method to connect Jira issue and GitLab commit is a GitLab plugin [Jira Integration](https://docs.gitlab.com/ee/integration/jira/). With this plugin, the Jira issue key in the commit message written by the committers will be parsed. Then, the plugin will add the commit urls under this jira issue. Hence, DevLake's [Jira plugin](https://github.com/apache/devlake/tree/main/backend/plugins/jira) can get the related commits (including repo, commit_id, url) of an issue. | **field** | **type** | **length** | **description** | **key** | |:-------------|:---------|:-----------|:----------------|:---------------| @@ -959,7 +959,7 @@ This table can support tag-based analysis, for instance, '_No. of bugs closed in When developing a new plugin, you need to refer to domain layer models, as all raw data should be transformed to domain layer data to provide standardized metrics across tools. Please use the following method to access the domain data models. ```golang -import "github.com/apache/incubator-devlake/models/domainlayer/domaininfo" +import "github.com/apache/devlake/models/domainlayer/domaininfo" domaininfo := domaininfo.GetDomainTablesInfo() for _, table := range domaininfo { diff --git a/docs/DeveloperManuals/DBMigration.md b/docs/DeveloperManuals/DBMigration.md index 9072902edb8..51d3b57593d 100644 --- a/docs/DeveloperManuals/DBMigration.md +++ b/docs/DeveloperManuals/DBMigration.md @@ -67,11 +67,11 @@ With these steps, the `defer` functions would be executed in reverse order if an However, you don't neccessary deal with all the mess. We had summarized some of the most useful code examples for you to follow: -- [Create new tables]https://github.com/apache/incubator-devlake/blob/main/backend/core/models/migrationscripts/20220406_add_frame_tables.go) -[Rename column](https://github.com/apache/incubator-devlake/blob/main/backend/core/models/migrationscripts/20220505_rename_pipeline_step_to_stage.go) -- [Add columns with default value](https://github.com/apache/incubator-devlake/blob/main/backend/core/models/migrationscripts/20220616_add_blueprint_mode.go) -- [Change the values(or type) of Primary Key](https://github.com/apache/incubator-devlake/blob/main/backend/core/models/migrationscripts/20220913_fix_commitfile_id_toolong.go) -- [Change the values(or type) of Column](https://github.com/apache/incubator-devlake/blob/main/backend/core/models/migrationscripts/20220903_encrypt_blueprint.go) +- [Create new tables]https://github.com/apache/devlake/blob/main/backend/core/models/migrationscripts/20220406_add_frame_tables.go) +[Rename column](https://github.com/apache/devlake/blob/main/backend/core/models/migrationscripts/20220505_rename_pipeline_step_to_stage.go) +- [Add columns with default value](https://github.com/apache/devlake/blob/main/backend/core/models/migrationscripts/20220616_add_blueprint_mode.go) +- [Change the values(or type) of Primary Key](https://github.com/apache/devlake/blob/main/backend/core/models/migrationscripts/20220913_fix_commitfile_id_toolong.go) +- [Change the values(or type) of Column](https://github.com/apache/devlake/blob/main/backend/core/models/migrationscripts/20220903_encrypt_blueprint.go) The above examples should cover most of the scenarios you may encounter. If you come across other scenarios, feel free to create issues in our GitHub Issue Tracker for discussions. diff --git a/docs/DeveloperManuals/Dal.md b/docs/DeveloperManuals/Dal.md index 3e1d397e5ef..8b055df7b65 100644 --- a/docs/DeveloperManuals/Dal.md +++ b/docs/DeveloperManuals/Dal.md @@ -155,7 +155,7 @@ mocks ``` With these Mocking stubs, you may start writing your TestCases using the `mocks.Dal`. ```go -import "github.com/apache/incubator-devlake/mocks" +import "github.com/apache/devlake/mocks" func TestCreateUser(t *testing.T) { mockDal := new(mocks.Dal) diff --git a/docs/DeveloperManuals/DeveloperSetup.md b/docs/DeveloperManuals/DeveloperSetup.md index 40bc362c035..6d0bbd4bac8 100644 --- a/docs/DeveloperManuals/DeveloperSetup.md +++ b/docs/DeveloperManuals/DeveloperSetup.md @@ -23,8 +23,8 @@ The following guide will walk through how to run DevLake's frontend (`config-ui` 1. Navigate to where you would like to install this project and clone the repository: ```sh - git clone https://github.com/apache/incubator-devlake.git - cd incubator-devlake + git clone https://github.com/apache/devlake.git + cd devlake ``` 2. Install dependencies for plugins: @@ -128,4 +128,4 @@ For provisioning, customizing, and creating dashboards, please refer to our [Gra ## References -To dig deeper into developing and utilizing our built-in functions and have a better developer experience, feel free to dive into our [godoc](https://pkg.go.dev/github.com/apache/incubator-devlake) reference. +To dig deeper into developing and utilizing our built-in functions and have a better developer experience, feel free to dive into our [godoc](https://pkg.go.dev/github.com/apache/devlake) reference. diff --git a/docs/DeveloperManuals/PluginImplementation.md b/docs/DeveloperManuals/PluginImplementation.md index 2fb1cf2e533..2c3e1023062 100644 --- a/docs/DeveloperManuals/PluginImplementation.md +++ b/docs/DeveloperManuals/PluginImplementation.md @@ -9,6 +9,6 @@ Plugins are code extensions that enable you to pull data from data-sources and p They can be implemented in both Go and Python. The framework itself is written in Go, and Python (called PyDevLake) is a supplemental extension to support developers who prefer it using it. PyDevLake is relatively brand new, and we would like to see it gain more traction; we encourage you to give it -The Go development manual can be found [here](https://github.com/apache/incubator-devlake/blob/main/backend/DevelopmentManual.md). This manual also covers the framework in detail. +The Go development manual can be found [here](https://github.com/apache/devlake/blob/main/backend/DevelopmentManual.md). This manual also covers the framework in detail. -The Python development manual can be found [here](https://github.com/apache/incubator-devlake/blob/main/backend/python/README.md). +The Python development manual can be found [here](https://github.com/apache/devlake/blob/main/backend/python/README.md). diff --git a/docs/DeveloperManuals/Project.md b/docs/DeveloperManuals/Project.md index 158d15eb8ce..88e4901f364 100644 --- a/docs/DeveloperManuals/Project.md +++ b/docs/DeveloperManuals/Project.md @@ -248,4 +248,4 @@ In the `plugins/dora/impl/impl.go` file, there is a `Dora` plugin implementation ## References -To dig deeper into developing and utilizing our built-in functions and have a better developer experience, feel free to dive into our [godoc](https://pkg.go.dev/github.com/apache/incubator-devlake) reference. \ No newline at end of file +To dig deeper into developing and utilizing our built-in functions and have a better developer experience, feel free to dive into our [godoc](https://pkg.go.dev/github.com/apache/devlake) reference. \ No newline at end of file diff --git a/docs/DeveloperManuals/Release-SOP.md b/docs/DeveloperManuals/Release-SOP.md index 5c2866ebcbe..5336b43cfe8 100644 --- a/docs/DeveloperManuals/Release-SOP.md +++ b/docs/DeveloperManuals/Release-SOP.md @@ -55,8 +55,8 @@ - Checkout to the branch/commit ```shell -git clone https://github.com/apache/incubator-devlake.git -cd incubator-devlake +git clone https://github.com/apache/devlake.git +cd devlake git checkout b268d53a48edb26d3c9b73b782798703f068f655 ``` @@ -110,19 +110,19 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ - Start the [vote](https://lists.apache.org/thread/2v2so22fj9mg5h7jck1opsqhjyc86k06) by sending an email to - Title: [VOTE] Release Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}} + Title: [VOTE] Release Apache DevLake v{{.Version}}-rc{{.RC}} Content: ``` Hello everyone, - This is a call for vote to release Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}} + This is a call for vote to release Apache DevLake v{{.Version}}-rc{{.RC}} The release candidates: https://dist.apache.org/repos/dist/dev/incubator/devlake/{{.Version}}-incubating-rc{{.RC}}/ Git tag for the release: - https://github.com/apache/incubator-devlake/releases/tag/v{{.Version}}-rc{{.RC}} + https://github.com/apache/devlake/releases/tag/v{{.Version}}-rc{{.RC}} Keys to verify the Release Candidate: https://downloads.apache.org/incubator/devlake/KEYS @@ -143,7 +143,7 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ {{.YourName}} ``` - Announce the [vote](https://lists.apache.org/thread/wfzzjv53vfxml54098o6dt4913j47d4j) result: - Title: [RESULT][VOTE] Release Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}} + Title: [RESULT][VOTE] Release Apache DevLake v{{.Version}}-rc{{.RC}} Content: ``` @@ -163,14 +163,14 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ 2. Apache incubator community vote: - Start the [vote](https://lists.apache.org/thread/5dbqc3t2bq7kfqccobrh7j9vqopj030k) by sending an email to general@incubator.apache.org - Title: [VOTE] Release Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}} + Title: [VOTE] Release Apache DevLake v{{.Version}}-rc{{.RC}} Content: ``` Hello everyone, - This is a call for vote to release Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}}. - The Apache DevLake community has voted on and approved a proposal to release Apache DevLake (Incubating) version v{{.Version}}-rc{{.RC}}. + This is a call for vote to release Apache DevLake v{{.Version}}-rc{{.RC}}. + The Apache DevLake community has voted on and approved a proposal to release Apache DevLake version v{{.Version}}-rc{{.RC}}. Community vote thread: [Community Vote Thread]({{.VoteThreadURL}}) @@ -203,13 +203,13 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ ``` - Announce the [vote](https://lists.apache.org/thread/40ktrw42c7hpok7vj33ql6wgdq2mpg92) result: Title: - [RESULT][VOTE] Release Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}} + [RESULT][VOTE] Release Apache DevLake v{{.Version}}-rc{{.RC}} Content: ``` Hello everyone, - I am pleased to announce that the vote for Apache DevLake (Incubating) v{{.Version}}-rc{{.RC}} has now concluded. Thank you all for your review and participation in the voting process. + I am pleased to announce that the vote for Apache DevLake v{{.Version}}-rc{{.RC}} has now concluded. Thank you all for your review and participation in the voting process. The release voting has passed with {{bindingVotes}} binding votes, {{nonBindingVotes}} non-binding vote and no +0 or -1 votes. @@ -251,7 +251,7 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ ``` Hello everyone, - The Apache DevLake (Incubating) {{.Version}}-incubating has been released! + The Apache DevLake {{.Version}}-incubating has been released! **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. @@ -265,7 +265,7 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ Website: https://devlake.apache.org/ Resources: - - Issue:https://github.com/apache/incubator-devlake/issues + - Issue:https://github.com/apache/devlake/issues - Mailing list: dev@devlake.apache.org Best Regards, @@ -292,4 +292,4 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ git tag v0.16.0 git push origin v0.16.0 ``` -- Open the URL `https://github.com/apache/incubator-devlake/releases/`, draft a new release, fill in the form and upload two files `docker-compose.yml` and `env.example` +- Open the URL `https://github.com/apache/devlake/releases/`, draft a new release, fill in the form and upload two files `docker-compose.yml` and `env.example` diff --git a/docs/DeveloperManuals/ReservedColumns.md b/docs/DeveloperManuals/ReservedColumns.md index 58d455d9112..5a8dce206d7 100644 --- a/docs/DeveloperManuals/ReservedColumns.md +++ b/docs/DeveloperManuals/ReservedColumns.md @@ -111,5 +111,5 @@ When defining a new tool-layer or domain-layer model: ## References -- Base model definition: [`models/common`](https://github.com/apache/incubator-devlake/tree/main/backend/core/models/common) -- [PR #8701](https://github.com/apache/incubator-devlake/pull/8701) — CircleCI column naming fix that prompted this convention to be formally documented. +- Base model definition: [`models/common`](https://github.com/apache/devlake/tree/main/backend/core/models/common) +- [PR #8701](https://github.com/apache/devlake/pull/8701) — CircleCI column naming fix that prompted this convention to be formally documented. diff --git a/docs/DeveloperManuals/SourceCodeReference.md b/docs/DeveloperManuals/SourceCodeReference.md index de4002c805e..7b3b2736b9c 100644 --- a/docs/DeveloperManuals/SourceCodeReference.md +++ b/docs/DeveloperManuals/SourceCodeReference.md @@ -6,7 +6,7 @@ sidebar_position: 1 --- For developers who wish to contribute to or develop based on the Apache DevLake, the -[pkg.go.dev](https://pkg.go.dev/github.com/apache/incubator-devlake#section-documentation) +[pkg.go.dev](https://pkg.go.dev/github.com/apache/devlake#section-documentation) is a good resource for reference, you can learn the overall structure of the code base or the definition of a specific function. diff --git a/docs/DeveloperManuals/UnitTest.md b/docs/DeveloperManuals/UnitTest.md index b7599dd26e8..d3c42b22133 100644 --- a/docs/DeveloperManuals/UnitTest.md +++ b/docs/DeveloperManuals/UnitTest.md @@ -23,7 +23,7 @@ Here are some resources for writing UnitTest for golang: # Test case examples -- [Source code](https://github.com/apache/incubator-devlake/blob/243cc8a80aa5b37828e2a142ac9f7e3269b7e1dc/backend/core/migration/migrator_test.go) +- [Source code](https://github.com/apache/devlake/blob/243cc8a80aa5b37828e2a142ac9f7e3269b7e1dc/backend/core/migration/migrator_test.go) # Recommended Libraries for writing UnitTest cases diff --git a/docs/GettingStarted/Authentication.md b/docs/GettingStarted/Authentication.md index 9b95d7e885e..3c14ff223a0 100644 --- a/docs/GettingStarted/Authentication.md +++ b/docs/GettingStarted/Authentication.md @@ -40,4 +40,4 @@ Security is complicated, all suggestions listed above are based on what we learn ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/GettingStarted/DockerComposeSetup.md b/docs/GettingStarted/DockerComposeSetup.md index 8144808bdd3..f349a660374 100644 --- a/docs/GettingStarted/DockerComposeSetup.md +++ b/docs/GettingStarted/DockerComposeSetup.md @@ -12,7 +12,7 @@ sidebar_position: 2 ## Launch DevLake -1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases) into a folder. +1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/devlake/releases) into a folder. 2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. This file contains the environment variables that the Devlake server will use. Additional ones can be found in the compose file(s). 3. Generate a secure encryption key using a method such as OpenSSL. For example, run the following command to generate a 128-character string consisting of uppercase letters: @@ -52,7 +52,7 @@ sidebar_position: 2 ::: 1. Run `docker-compose down` to stop services; -2. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases). +2. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/devlake/releases). 3. Use the new `docker-compose.yml` and `env.example` to replace the old `docker-compose.yml` and `.env`; Or if you have modified/customized values in the old files, compare the new files with the old ones, adjust the old files according to the new ones. 4. [Optional] If you are upgrading from earlier versions to v0.18.0+, set the ENCRYPTION_SECRET environment variable in docker-compose.yml or .env file, refer to the second caution. 5. Run `docker-compose up -d` to start DevLake services. @@ -170,10 +170,10 @@ config-ui: 5. If you want to import dashboards, please check https://grafana.com/docs/grafana/latest/dashboards/export-import/. -- You can find DevLake's self-built Grafana dashboards here (https://github.com/apache/incubator-devlake/tree/main/grafana/dashboards). +- You can find DevLake's self-built Grafana dashboards here (https://github.com/apache/devlake/tree/main/grafana/dashboards). 6. Final step: `docker compose up -d` ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/GettingStarted/Environment.md b/docs/GettingStarted/Environment.md index 19b6272d3df..cfc13ad879c 100644 --- a/docs/GettingStarted/Environment.md +++ b/docs/GettingStarted/Environment.md @@ -16,7 +16,7 @@ This environment variable is used to enable or disable the execution of subtasks The format is as follows: plugin_name1:subtask_name1:enabled_value,plugin_name2:subtask_name2:enabled_value,plugin_name3:subtask_name3:enabled_value -Guidance on locating the [plugin_name and subtask_name](https://github.com/apache/incubator-devlake/blob/release-v1.0/backend/plugins/jira/tasks/issue_changelog_collector.go#L41): +Guidance on locating the [plugin_name and subtask_name](https://github.com/apache/devlake/blob/release-v1.0/backend/plugins/jira/tasks/issue_changelog_collector.go#L41): - plugin_name: Represents the plugin's name, such as 'jira' for the Jira plugin. - subtask_name: Denotes the subtask's name, like 'collectIssueChangelogs' for the Jira plugin." diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md index 104acf79b70..e7670920659 100644 --- a/docs/GettingStarted/HelmSetup.md +++ b/docs/GettingStarted/HelmSetup.md @@ -331,4 +331,4 @@ helm install devlake devlake/devlake \ ## Troubleshooting -If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues) +If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/devlake/issues) diff --git a/docs/GettingStarted/Upgrade.md b/docs/GettingStarted/Upgrade.md index 37b7d79d531..e47b276043c 100644 --- a/docs/GettingStarted/Upgrade.md +++ b/docs/GettingStarted/Upgrade.md @@ -24,6 +24,6 @@ Please follow the guide for detailed information: > Error: UPGRADE FAILED: cannot patch "devlake-grafana" with kind Deployment: Deployment.apps "devlake-grafana" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app.kubernetes.io/instance":"devlake", "app.kubernetes.io/name":"grafana"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable -6. When upgrading via docker-compose.yml, please download the new docker-compose.yml and env.example from [release assets](https://github.com/apache/incubator-devlake/releases) to do the upgrade, please refer to [docker compose upgrade notes](./DockerComposeSetup.md) +6. When upgrading via docker-compose.yml, please download the new docker-compose.yml and env.example from [release assets](https://github.com/apache/devlake/releases) to do the upgrade, please refer to [docker compose upgrade notes](./DockerComposeSetup.md) These notes provide guidance on upgrading your Apache DevLake to a newer version. Ensure you follow them carefully to avoid any issues during the upgrade process. diff --git a/docs/Overview/Introduction.md b/docs/Overview/Introduction.md index aa79e51cb05..443ddba1352 100755 --- a/docs/Overview/Introduction.md +++ b/docs/Overview/Introduction.md @@ -12,7 +12,7 @@ sidebar_position: 1 ## What is Apache DevLake? -Apache DevLake (Incubating) 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 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. diff --git a/docs/Overview/Roadmap.md b/docs/Overview/Roadmap.md index ad1dad452c1..d712fa817f5 100644 --- a/docs/Overview/Roadmap.md +++ b/docs/Overview/Roadmap.md @@ -7,7 +7,7 @@ sidebar_position: 10 ## Goals -DevLake has joined the Apache Incubator and is aiming to become a top-level project. To achieve this goal, the Apache DevLake (Incubating) community will continue to make efforts in helping development teams to analyze and improve their engineering productivity. In this roadmap, we have summarized three major goals followed by the feature breakdown to invite the broader community to join us and grow together. +DevLake has joined the Apache Incubator and is aiming to become a top-level project. To achieve this goal, the Apache DevLake community will continue to make efforts in helping development teams to analyze and improve their engineering productivity. In this roadmap, we have summarized three major goals followed by the feature breakdown to invite the broader community to join us and grow together. 1. As a dev data analysis application, discover and implement 3 (or even more!) usage scenarios: - A collection of metrics to track the contribution, quality and growth of open-source projects @@ -22,9 +22,9 @@ Apache DevLake is currently under rapid development. You are more than welcome t | Category | Features | | -------- | -------- | -| More data sources across different DevOps domains (Goal No.1 & 2). See [existing data sources](/docs/Overview/SupportedDataSources.md) | Issue Tracking: Source Code Management: Code Review: CI/CD: Code Quality: Incident Management: QA: Documentation: Calendar: OSS Community Metrics: Instant Messaging: | -| Improved data collection, [data models](../DataModels/DevLakeDomainLayerSchema.md) and data extensibility (Goal No.2) | Data Collection:
Data Models: Data Extensibility: | -| Better user experience (Goal No.3) | For new users: For returning users: For contributors: +| More data sources across different DevOps domains (Goal No.1 & 2). See [existing data sources](/docs/Overview/SupportedDataSources.md) | Issue Tracking: Source Code Management: Code Review: CI/CD: Code Quality: Incident Management: QA: Documentation: Calendar: OSS Community Metrics: Instant Messaging: | +| Improved data collection, [data models](../DataModels/DevLakeDomainLayerSchema.md) and data extensibility (Goal No.2) | Data Collection:
Data Models: Data Extensibility: | +| Better user experience (Goal No.3) | For new users: For returning users: For contributors: ## How to Influence the Roadmap diff --git a/docs/Plugins/github.md b/docs/Plugins/github.md index 992f6641b07..041849fa7b4 100644 --- a/docs/Plugins/github.md +++ b/docs/Plugins/github.md @@ -119,7 +119,7 @@ curl 'http://localhost:8080/pipelines' \ "options": { "connectionId": 1, "owner": "apache", - "repo": "incubator-devlake", + "repo": "devlake", "transformationRules":{ "deploymentPattern":"", "productionPattern":"", diff --git a/docs/Plugins/refdiff.md b/docs/Plugins/refdiff.md index d4908c07d62..2394c73c651 100644 --- a/docs/Plugins/refdiff.md +++ b/docs/Plugins/refdiff.md @@ -8,8 +8,8 @@ description: > RefDiff is a plugin that performs calculation tasks and has 2 main purposes. -- Calculate the difference in commits between releases/tags to [analyze the amount of code in each release](https://github.com/apache/incubator-devlake/blob/main/backend/plugins/refdiff/tasks/commit_diff_calculator.go) -- Calculate the difference in commits between deployments to [calculate DORA metrics](https://github.com/apache/incubator-devlake/blob/main/backend/plugins/refdiff/tasks/deployment_commit_diff_calculator.go) +- Calculate the difference in commits between releases/tags to [analyze the amount of code in each release](https://github.com/apache/devlake/blob/main/backend/plugins/refdiff/tasks/commit_diff_calculator.go) +- Calculate the difference in commits between deployments to [calculate DORA metrics](https://github.com/apache/devlake/blob/main/backend/plugins/refdiff/tasks/deployment_commit_diff_calculator.go) And the output of RefDiff is stored in the table commits_diffs, finished_commits_diffs, ref_commits. @@ -100,7 +100,7 @@ curl 'http://localhost:8080/pipelines' \ ## How to use refdiff in DORA -RefDiff can be called by the [DORA plugin](https://github.com/apache/incubator-devlake/tree/main/backend/plugins/dora) to support the calculation of [DORA metrics](https://devlake.apache.org/docs/DORA). RefDiff has a subtask called 'calculateProjectDeploymentCommitsDiff'. This subtask takes the `project_name` from task options to calculate the commits diff between two consecutive deployments in this project. That is to say, refdiff will generate the relationship between `deployed commit(s)` and the `deployment` in which these commits get deployed. +RefDiff can be called by the [DORA plugin](https://github.com/apache/devlake/tree/main/backend/plugins/dora) to support the calculation of [DORA metrics](https://devlake.apache.org/docs/DORA). RefDiff has a subtask called 'calculateProjectDeploymentCommitsDiff'. This subtask takes the `project_name` from task options to calculate the commits diff between two consecutive deployments in this project. That is to say, refdiff will generate the relationship between `deployed commit(s)` and the `deployment` in which these commits get deployed. ```shell curl 'http://localhost:8080/pipelines' \ diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md index 6e891467897..cfaa44d057c 100644 --- a/docs/Plugins/webhook.md +++ b/docs/Plugins/webhook.md @@ -79,7 +79,7 @@ More information about these columns at the domain layer tables: [cicd_deploymen #### Register a Deployment - Sample API Calls -The payload supports the deployment to one or multiple repositories (referring to the [discussion](https://github.com/apache/incubator-devlake/discussions/6162)). +The payload supports the deployment to one or multiple repositories (referring to the [discussion](https://github.com/apache/devlake/discussions/6162)). Please replace the `API_KEY` with the real token generated after creating a webhook. diff --git a/docs/Troubleshooting/Configuration.md b/docs/Troubleshooting/Configuration.md index e440af452a3..4f3e9b846fc 100644 --- a/docs/Troubleshooting/Configuration.md +++ b/docs/Troubleshooting/Configuration.md @@ -11,7 +11,7 @@ description: > | ---------- | ----------------------------|--------|-----------| | 429 | subtask collectAPiPipelines ended unexpectedly caused: Error waiting for async Collector execution caused by: retry exceeded 3 times calling projects/{projectId}/pipelines {429} | This error exmaple is caused by GitLab's Pipeline APIs. These APIs are implemented via Cloudflare, which is different from other GitLab entities. | Two ways:
- Enable `fixed rate limit` in the GitLab connection, lower the API rates to 2,000. If it works, you can try increase the rates to accerlerate. This solution also applies to other plugins that return the 429 while collecting data, such as GitHub, TAPD, etc.
- Upgrade to v0.15.x | | 403 | error: preparing task data for gitextractor caused by: unexpected http status code: 403 | This is usually caused by the permission of your tokens. For example, if you're using an un-supported auth method, or using a token without ticking permissions to certain entities you want to collect. | Find the supported authentication methods and token permissions that should be selected in the corresponding plugin's Config UI manuals, for example, [configuring GitHub](/docs/Configuration/GitHub.md#auth-tokens) | -| 1406 | subtask extractApiBuilds ended unexpectedly caused by: error adding the result to batch caused by: Error 1406: Data too long for column 'full_display_name' at row 138. See bug [#4053](https://github.com/apache/incubator-devlake/issues/4053) | This is usually thrown by MySQL because a certain value is too long | A work-around is to manually change the field length to varchar(255) or longer in MySQL. Also, please put up a [bug](https://github.com/apache/incubator-devlake/issues/new?assignees=&labels=type%2Fbug&template=bug-report.yml&title=%5BBug%5D%5BModule+Name%5D+Bug+title+) to let us know. | +| 1406 | subtask extractApiBuilds ended unexpectedly caused by: error adding the result to batch caused by: Error 1406: Data too long for column 'full_display_name' at row 138. See bug [#4053](https://github.com/apache/devlake/issues/4053) | This is usually thrown by MySQL because a certain value is too long | A work-around is to manually change the field length to varchar(255) or longer in MySQL. Also, please put up a [bug](https://github.com/apache/devlake/issues/new?assignees=&labels=type%2Fbug&template=bug-report.yml&title=%5BBug%5D%5BModule+Name%5D+Bug+title+) to let us know. | ### Failed to collect data from the server with a self-signed certificate @@ -39,7 +39,7 @@ Here is an example of the `docker-compose`` installation, the idea applies to ot ``` ### GitExtractor task failed in a GitHub/GitLab/BitBucket blueprint -See bug [#3719](https://github.com/apache/incubator-devlake/issues/3719) +See bug [#3719](https://github.com/apache/devlake/issues/3719) This bug happens occasionally in v0.14.x and previous versions. It is fixed by changing the docker base image. Please upgrade to v0.15.x to get it fixed if you encounter it. @@ -48,8 +48,8 @@ This bug happens occasionally in v0.14.x and previous versions. It is fixed by c We have had a couple of reports suggesting MySQL InnoDB would fail with the message. -- [Error 1206: The total number of locks exceeds the lock table size · Issue #3849 · apache/incubator-devlake](https://github.com/apache/incubator-devlake/issues/3849) -- [[Bug][GitLab] gitlab collectApiJobs task failed for mysql locks error · Issue #3653 · apache/incubator-devlake](https://github.com/apache/incubator-devlake/issues/3653) +- [Error 1206: The total number of locks exceeds the lock table size · Issue #3849 · apache/devlake](https://github.com/apache/devlake/issues/3849) +- [[Bug][GitLab] gitlab collectApiJobs task failed for mysql locks error · Issue #3653 · apache/devlake](https://github.com/apache/devlake/issues/3653) The cause of the problem is: @@ -70,7 +70,7 @@ Here is an example of the `docker-compose` installation, the idea applies to oth ### GitHub repositories keep loading when adding data scopes -See issue [#6038](https://github.com/apache/incubator-devlake/issues/6038) +See issue [#6038](https://github.com/apache/devlake/issues/6038) If you're having trouble adding data scopes to a GitHub connection because the repositories keep loading, there are a few things you can check: 1. Make sure your access token has the necessary permissions. @@ -80,4 +80,4 @@ For more details about authenticating with SAML single sign-on, see here: https: ## None of them solve your problem? -Sorry for the inconvenience, please help us improve by [creating an issue](https://github.com/apache/incubator-devlake/issues) +Sorry for the inconvenience, please help us improve by [creating an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Troubleshooting/Dashboard.md b/docs/Troubleshooting/Dashboard.md index 9bf31d04eeb..1775b3903e0 100644 --- a/docs/Troubleshooting/Dashboard.md +++ b/docs/Troubleshooting/Dashboard.md @@ -52,4 +52,4 @@ WIP ## None of them solve your problem? -Sorry for the inconvenience, please help us improve by [creating an issue](https://github.com/apache/incubator-devlake/issues) +Sorry for the inconvenience, please help us improve by [creating an issue](https://github.com/apache/devlake/issues) diff --git a/docs/Troubleshooting/Installation.md b/docs/Troubleshooting/Installation.md index 14037e14cf6..820447903e9 100644 --- a/docs/Troubleshooting/Installation.md +++ b/docs/Troubleshooting/Installation.md @@ -14,8 +14,8 @@ Please check the [GettingStarted/Upgrade](../GettingStarted/Upgrade.md) doc for One of the known root causes of the phonomenon is the Dynatrace agent being injected into the container. Excluding the namespace from the Dynatrace deployments should fix the problem. -Check [#5612](https://github.com/apache/incubator-devlake/issues/5612) if you needed more detail. +Check [#5612](https://github.com/apache/devlake/issues/5612) if you needed more detail. ## None of them solve your problem? -Sorry for the inconvenience, please help us improve by [creating an issue](https://github.com/apache/incubator-devlake/issues) +Sorry for the inconvenience, please help us improve by [creating an issue](https://github.com/apache/devlake/issues) diff --git a/docusaurus.config.js b/docusaurus.config.js index a6ce349f475..e08683883d2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -280,7 +280,7 @@ const versions = require('./versions.json'); }, { label: 'GitHub Issue Tracker', - to: 'https://github.com/apache/incubator-devlake/issues', + to: 'https://github.com/apache/devlake/issues', }, { label: 'GitHub Issue Tracker For Docs', diff --git a/src/components/Sections/HomepageHeader.tsx b/src/components/Sections/HomepageHeader.tsx index 0de03a6b756..6aa1b748673 100644 --- a/src/components/Sections/HomepageHeader.tsx +++ b/src/components/Sections/HomepageHeader.tsx @@ -65,7 +65,7 @@ export function HomepageHeader() { font-inter " > - Apache DevLake™ (Incubating) ingests, analyzes, and visualizes the + Apache DevLake™ ingests, analyzes, and visualizes the fragmented data from DevOps tools to distill insights for engineering excellence. From 647e3e595645f308d2f810d4f4826d014bcf9a79 Mon Sep 17 00:00:00 2001 From: Klesh Wong Date: Wed, 2 Sep 2026 18:02:42 +0800 Subject: [PATCH 2/2] chore: remove incubatoring wording --- community/maturity.md | 22 +++++++++++----------- community/subscribe.md | 2 +- community/trademark.md | 6 +++--- docs/DeveloperManuals/Release-SOP.md | 26 +++++++++++++------------- 4 files changed, 28 insertions(+), 28 deletions(-) diff --git a/community/maturity.md b/community/maturity.md index c66a52b0ec1..0d76df1b097 100644 --- a/community/maturity.md +++ b/community/maturity.md @@ -11,7 +11,7 @@ More details can be found [here](https://community.apache.org/apache-way/apache- ## Status of this assessment -This assessment is being evaluated during DevLake's graduation from Apache Incubator to a top-level Apache project. +This assessment was completed upon DevLake's graduation from the Apache Incubator to a top-level Apache project (TLP). ## Maturity model assessment @@ -31,7 +31,7 @@ The following table is filled according to the [Apache Maturity Model](https://c | **ID** | **Description** | **Status** | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **LC10** | The Apache License, version 2.0, covers the released code. | **YES** The [LICENSE](https://github.com/apache/incubator-devlake/blob/main/LICENSE) file is present in the repository and all source files include the Apache License 2.0 header. | +| **LC10** | The Apache License, version 2.0, covers the released code. | **YES** The [LICENSE](https://github.com/apache/devlake/blob/main/LICENSE) file is present in the repository and all source files include the Apache License 2.0 header. | | **LC20** | Libraries that are mandatory dependencies of the project's code do not create more restrictions than the Apache License does. | **YES** All dependencies have been reviewed and are compatible with Apache License 2.0 requirements. | | **LC30** | The libraries mentioned in LC20 are available as Open Source software. | **YES** All mandatory dependencies are available as Open Source software with compatible licenses. | | **LC40** | Committers are bound by an Individual Contributor Agreement (the "Apache iCLA") that defines which code they may commit and how they need to identify code that is not their own. | **YES** All committers have signed Apache iCLAs as required by Apache Software Foundation policies. | @@ -41,9 +41,9 @@ The following table is filled according to the [Apache Maturity Model](https://c | **ID** | **Description** | **Status** | | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **RE10** | Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term. | **YES** Source releases are distributed via [dist.apache.org](https://dist.apache.org/repos/dist/release/incubator/devlake/) in standard tar.gz format. | -| **RE20** | The project's PPMC (Project Management Committee, see CS10) approves each software release in order to make the release an act of the Foundation. | **YES** All releases have been voted on by the PPMC on dev@devlake.apache.org and general@incubator.apache.org with at least 3 PPMC member votes. | -| **RE30** | Releases are signed and/or distributed along with digests that anyone can reliably use to validate the downloaded archives. | **YES** All releases are cryptographically signed and include SHA-512 checksums. The [KEYS](https://dist.apache.org/repos/dist/release/incubator/devlake/KEYS) file is available. | +| **RE10** | Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term. | **YES** Source releases are distributed via [dist.apache.org](https://dist.apache.org/repos/dist/release/devlake/) in standard tar.gz format. | +| **RE20** | The project's PMC (Project Management Committee, see CS10) approves each software release in order to make the release an act of the Foundation. | **YES** All releases have been voted on by the PMC on dev@devlake.apache.org with at least 3 PMC member votes. | +| **RE30** | Releases are signed and/or distributed along with digests that anyone can reliably use to validate the downloaded archives. | **YES** All releases are cryptographically signed and include SHA-512 checksums. The [KEYS](https://dist.apache.org/repos/dist/release/devlake/KEYS) file is available. | | **RE40** | The project can distribute convenience binaries alongside source code, but they are not Apache Releases, they are provided with no guarantee. | **YES** Docker images and other convenience binaries are provided but clearly marked as convenience distributions, not official Apache releases. | | **RE50** | The project documents a repeatable release process so that someone new to the project can independently generate the complete set of artifacts required for a release. | **YES** The documentation of the release process can be found on [our website](https://devlake.apache.org/docs/DeveloperManuals/Release-SOP/#asf-release-policy). | @@ -51,7 +51,7 @@ The following table is filled according to the [Apache Maturity Model](https://c | **ID** | **Description** | **Status** | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **QU10** | The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. | **YES** The project encourages users to [report issues](https://github.com/apache/incubator-devlake/issues) and maintains transparent communication about known limitations. | +| **QU10** | The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. | **YES** The project encourages users to [report issues](https://github.com/apache/devlake/issues) and maintains transparent communication about known limitations. | | **QU20** | The project puts a very high priority on producing secure software. | **YES** Security issues are addressed promptly with a dedicated security response process. | | **QU30** | The project provides a well-documented, secure and private channel to report security issues, along with a documented way of responding to them. | **YES** When users open a new issue on the project’s GitHub repository, they are prompted with a “Report a security vulnerability” option that directs them to follow the Apache Software Foundation’s standard security disclosure process. | @@ -65,17 +65,17 @@ The following table is filled according to the [Apache Maturity Model](https://c | **CO10** | The project has a well-known homepage that points to all the information required to operate according to this maturity model. | **YES** The [official website](https://devlake.apache.org/) provides comprehensive information including documentation, community guidelines, and development resources. | | **CO20** | The community welcomes contributions from anyone who acts in good faith and in a respectful manner, and who adds value to the project. | **YES** The project provides detailed [contributing guidelines](https://devlake.apache.org/community/) and maintains a welcoming environment for all contributors. | | **CO30** | Contributions include source code, documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project. | **YES** The community welcomes all forms of contributions including code, documentation, testing, bug reports, and community engagement. | -| **CO40** | The community strives to be meritocratic and gives more rights and responsibilities to contributors who, over time, add value to the project. | **YES** The community has elected 14 PPMC members and 12 committers based on their contributions and merit. | +| **CO40** | The community strives to be meritocratic and gives more rights and responsibilities to contributors who, over time, add value to the project. | **YES** The community has elected 14 PMC members and 12 committers based on their contributions and merit. | | **CO50** | The project documents how contributors can earn more rights such as commit access or decision power, and applies these principles consistently. | **YES** The project has clear documentation on the [contributor growth program](https://devlake.apache.org/community/MakingContributions/contributor-growth-program) and promotion processes. | | **CO60** | The community operates based on consensus of its members (see CS10) who have decision power. Dictators, benevolent or not, are not welcome in Apache projects. | **YES** All major decisions are made through community consensus and voting processes on the mailing list. | -| **CO70** | The project strives to answer user questions in a timely manner. | **YES** The project uses dev@devlake.apache.org, [GitHub issues](https://github.com/apache/incubator-devlake/issues), and community channels to provide timely support to users. | +| **CO70** | The project strives to answer user questions in a timely manner. | **YES** The project uses dev@devlake.apache.org, [GitHub issues](https://github.com/apache/devlake/issues), and community channels to provide timely support to users. | ### Consensus | **ID** | **Description** | **Status** | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| **CS10** | The project maintains a public list of its contributors who have decision power. The project's PPMC (Project Management Committee) consists of those contributors. | **YES** The project maintains a public list of [PPMC members and committers](https://devlake.apache.org/team) on the website. | -| **CS20** | Decisions require a consensus among PPMC members and are documented on the project's main communications channel. The PPMC takes community opinions into account, but the PPMC has the final word. | **YES** All decisions are made through votes on dev@devlake.apache.org with proper documentation and at least 3 +1 votes from PPMC members. | +| **CS10** | The project maintains a public list of its contributors who have decision power. The project's PMC (Project Management Committee) consists of those contributors. | **YES** The project maintains a public list of [PMC members and committers](https://devlake.apache.org/team) on the website. | +| **CS20** | Decisions require a consensus among PMC members and are documented on the project's main communications channel. The PMC takes community opinions into account, but the PMC has the final word. | **YES** All decisions are made through votes on dev@devlake.apache.org with proper documentation and at least 3 +1 votes from PMC members. | | **CS30** | The project uses documented voting rules to build consensus when discussion is not sufficient. | **YES** The project follows standard Apache Software Foundation voting rules and procedures. | | **CS40** | In Apache projects, vetoes are only valid for code commits. The person exercising the veto must justify it with a technical explanation, as per the Apache voting rules defined in CS30. | **YES** The project follows Apache voting rules where vetoes are only valid for code commits and must be technically justified. | | **CS50** | All "important" discussions happen asynchronously in written form on the project's main communications channel. Offline, face-to-face or private discussions that affect the project are also documented on that channel. | **YES** All important discussions and decisions are documented on the mailing list in written form. | @@ -84,5 +84,5 @@ The following table is filled according to the [Apache Maturity Model](https://c | **ID** | **Description** | **Status** | | -------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **IN10** | The project is independent from any corporate or organizational influence. | **YES** The PPMC members and committers represent multiple organizations and companies, ensuring no single corporate influence dominates the project. | +| **IN10** | The project is independent from any corporate or organizational influence. | **YES** The PMC members and committers represent multiple organizations and companies, ensuring no single corporate influence dominates the project. | | **IN20** | Contributors act as themselves, not as representatives of a corporation or organization. | **YES** Contributors participate in the project as individuals, not as corporate representatives, following Apache Software Foundation principles. | diff --git a/community/subscribe.md b/community/subscribe.md index 7b2215145e6..0fdd0357ba3 100644 --- a/community/subscribe.md +++ b/community/subscribe.md @@ -7,7 +7,7 @@ title: "Mailing List" ## Subscribe to Mailing List -We highly recommend that you subscribe to the development mailing list of Apache Devlake (Incubating) to keep up and participate in the latest community discussions. +We highly recommend that you subscribe to the development mailing list of Apache Devlake to keep up and participate in the latest community discussions. **Please note: you will need to subscribe to the mailing list first before participating in any discussions.** diff --git a/community/trademark.md b/community/trademark.md index 582b6d8608e..378af918257 100644 --- a/community/trademark.md +++ b/community/trademark.md @@ -5,13 +5,13 @@ sidebar_position: 5 Version 1.0 dated July 7, 2022 -This trademark policy was prepared to help you understand how to use the Apache DevLake(incubating) trademarks, service marks and logos with Apache DevLake(incubating) software. +This trademark policy was prepared to help you understand how to use the Apache DevLake trademarks, service marks and logos with Apache DevLake software. While some of our software is available under a free and open source software license, that copyright license does not include a license to use our trademark, and this Policy is intended to explain how to use our marks consistent with background law and community expectation. This Policy covers: -1. Our **word** trademarks and service marks: Apache DevLake(incubating), DevLake -2. Our **logos**: The Apache DevLake(incubating) logo at the top of the this website's menu bar +1. Our **word** trademarks and service marks: Apache DevLake, DevLake +2. Our **logos**: The Apache DevLake logo at the top of the this website's menu bar This policy encompasses all trademarks and service marks, whether they are registered or not. diff --git a/docs/DeveloperManuals/Release-SOP.md b/docs/DeveloperManuals/Release-SOP.md index 5336b43cfe8..d81015e7566 100644 --- a/docs/DeveloperManuals/Release-SOP.md +++ b/docs/DeveloperManuals/Release-SOP.md @@ -1,12 +1,12 @@ # DevLake Release Guide -**Please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS , if not, please update this file first.** +**Please make sure your public key was included in the https://downloads.apache.org/devlake/KEYS , if not, please update this file first.** ## How to update KEYS 1. Clone the svn repository ```shell - svn co https://dist.apache.org/repos/dist/dev/incubator/devlake + svn co https://dist.apache.org/repos/dist/dev/devlake ``` 2. Append your public key to the KEYS file cd devlake @@ -28,7 +28,7 @@ ```shell svn add KEYS svn commit -m "update KEYS" - svn cp https://dist.apache.org/repos/dist/dev/incubator/devlake/KEYS https://dist.apache.org/repos/dist/release/incubator/devlake/ -m "update KEYS" + svn cp https://dist.apache.org/repos/dist/dev/devlake/KEYS https://dist.apache.org/repos/dist/release/devlake/ -m "update KEYS" ``` We will use `v0.16.0` as an example to demonstrate the release process. @@ -71,7 +71,7 @@ git checkout b268d53a48edb26d3c9b73b782798703f068f655 ```shell git archive --format=tar.gz --output="/apache-devlake-0.16.0-incubating-src.tar.gz" --prefix="apache-devlake-0.16.0-incubating-src/" v0.16.0-rc2 ``` -- Before proceeding to the next step, please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS +- Before proceeding to the next step, please make sure your public key was included in the https://downloads.apache.org/devlake/KEYS - Create signature and checksum ```shell cd @@ -88,7 +88,7 @@ git checkout b268d53a48edb26d3c9b73b782798703f068f655 - Clone the svn repository ```shell - svn co https://dist.apache.org/repos/dist/dev/incubator/devlake + svn co https://dist.apache.org/repos/dist/dev/devlake ``` - Copy the files into the svn local directory ```shell @@ -104,7 +104,7 @@ git checkout b268d53a48edb26d3c9b73b782798703f068f655 ## Vote -You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist) before voting. +You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/display/Incubator+Release+Checklist) before voting. 1. Devlake community vote: @@ -119,13 +119,13 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ This is a call for vote to release Apache DevLake v{{.Version}}-rc{{.RC}} The release candidates: - https://dist.apache.org/repos/dist/dev/incubator/devlake/{{.Version}}-incubating-rc{{.RC}}/ + https://dist.apache.org/repos/dist/dev/devlake/{{.Version}}-incubating-rc{{.RC}}/ Git tag for the release: https://github.com/apache/devlake/releases/tag/v{{.Version}}-rc{{.RC}} Keys to verify the Release Candidate: - https://downloads.apache.org/incubator/devlake/KEYS + https://downloads.apache.org/devlake/KEYS How to build: https://devlake.apache.org/docs/DeveloperManuals/DeveloperSetup @@ -185,7 +185,7 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ [Git Tag]({{.GitTagURL}}) Keys to verify the Release Candidate: - https://downloads.apache.org/incubator/devlake/KEYS + https://downloads.apache.org/devlake/KEYS How to build: https://devlake.apache.org/docs/DeveloperManuals/DeveloperSetup/ @@ -236,12 +236,12 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ - Move the release to the ASF content distribution system ```shell - svn mv https://dist.apache.org/repos/dist/dev/incubator/devlake/0.16.0-incubating-rc2 https://dist.apache.org/repos/dist/release/incubator/devlake/0.16.0-incubating -m "transfer packages for 0.16.0-incubating-rc2" + svn mv https://dist.apache.org/repos/dist/dev/devlake/0.16.0-incubating-rc2 https://dist.apache.org/repos/dist/release/devlake/0.16.0-incubating -m "transfer packages for 0.16.0-incubating-rc2" ``` -- Wait until the directory `https://downloads.apache.org/incubator/devlake/0.16.0-incubating/` was created +- Wait until the directory `https://downloads.apache.org/devlake/0.16.0-incubating/` was created - Remove the last release from `https://downloads.apache.org/` (according the Apache release policy, this link should be pointing to the current release) ```shell - svn rm https://dist.apache.org/repos/dist/release/incubator/devlake/0.15.0-incubating -m "remove 0.15.0-incubating" + svn rm https://dist.apache.org/repos/dist/release/devlake/0.15.0-incubating -m "remove 0.15.0-incubating" ``` - Announce [release](https://lists.apache.org/thread/czf6p3xtlkq6t8g4q35blkbf2xclsl3p) by sending an email to general@incubator.apache.org Title: @@ -255,7 +255,7 @@ You can check [Incubator Release Checklist](https://cwiki.apache.org/confluence/ **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. - Download Links: https://downloads.apache.org/incubator/devlake/ + Download Links: https://downloads.apache.org/devlake/ Changelogs: - xxx.