Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions community/MakingContributions/development-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}`.

Expand All @@ -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
```
Expand All @@ -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)
```

Expand Down
2 changes: 1 addition & 1 deletion community/MakingContributions/fix-or-create-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
22 changes: 11 additions & 11 deletions community/maturity.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion community/subscribe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand Down
6 changes: 3 additions & 3 deletions community/trademark.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Configuration/APIKeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
8 changes: 4 additions & 4 deletions docs/Configuration/AdvancedMode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand All @@ -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

Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/AzureDevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/BitBucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/Configuration/BitBucketServer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Configuration.md) or [create an issue](https://github.com/apache/devlake/issues).
2 changes: 1 addition & 1 deletion docs/Configuration/CircleCI.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/Dashboards/GrafanaUserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/GitHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/GitLab.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/Configuration/HowToOrganizeDevlakeProjects.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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)
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)
2 changes: 1 addition & 1 deletion docs/Configuration/Incidentio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/Jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/Jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/Opsgenie.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/PagerDuty.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/SonarQube.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/Tapd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

4 changes: 2 additions & 2 deletions docs/Configuration/TeamConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);

```
Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/Configuration/Teambition.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/Configuration/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/Configuration/Zentao.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

2 changes: 1 addition & 1 deletion docs/Configuration/webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/DORA.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading
Loading