This is an automated email from the ASF dual-hosted git repository. abeizn pushed a commit to branch release-v1.0 in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
commit 0ea10b3c1f783d4f5c595ef96fed8d78dadfa7df Author: Louis.z <[email protected]> AuthorDate: Fri Mar 29 05:49:25 2024 +0800 docs: polish the wording for the onboard process (#7242) Co-authored-by: Startrekzky <[email protected]> --- config-ui/public/onboard/step-1/azuredevops.md | 11 ++++++--- config-ui/public/onboard/step-1/bitbucket.md | 11 ++++++--- config-ui/public/onboard/step-1/default.md | 2 +- config-ui/public/onboard/step-1/github.md | 11 ++++++--- config-ui/public/onboard/step-1/gitlab.md | 11 ++++++--- config-ui/public/onboard/step-2/azuredevops.md | 14 +++++------ config-ui/public/onboard/step-2/bitbucket.md | 24 +++++++++---------- config-ui/public/onboard/step-2/github.md | 32 +++++++++++++------------- config-ui/public/onboard/step-2/gitlab.md | 29 +++++++++++------------ config-ui/public/onboard/step-3/azuredevops.md | 18 +++++++-------- config-ui/public/onboard/step-3/bitbucket.md | 18 +++++++-------- config-ui/public/onboard/step-3/github.md | 18 +++++++-------- config-ui/public/onboard/step-3/gitlab.md | 18 +++++++-------- 13 files changed, 118 insertions(+), 99 deletions(-) diff --git a/config-ui/public/onboard/step-1/azuredevops.md b/config-ui/public/onboard/step-1/azuredevops.md index 6018ef364..960aadd33 100644 --- a/config-ui/public/onboard/step-1/azuredevops.md +++ b/config-ui/public/onboard/step-1/azuredevops.md @@ -17,9 +17,14 @@ limitations under the License. ##### Azure DevOps tells you: -1. How much code have you submitted? +1. What is the volume of code you have contributed? +  -2. How are your Pull Requests handled? + +2. What is the procedure for managing your Pull Requests? +  -3. How fast is your Code Review process? + +3. What is the turnaround time for your Code Review process? +  diff --git a/config-ui/public/onboard/step-1/bitbucket.md b/config-ui/public/onboard/step-1/bitbucket.md index 745c454e7..62ef249af 100644 --- a/config-ui/public/onboard/step-1/bitbucket.md +++ b/config-ui/public/onboard/step-1/bitbucket.md @@ -17,9 +17,14 @@ limitations under the License. ##### Bitbucket tells you: -1. How much code have you submitted? +1. What is the volume of code you have contributed? +  -2. How are your Pull Requests handled? + +2. How are the Pull Requests handled? +  -3. How fast is your Code Review process? + +3. What is the turnaround time for your Code Review process? +  diff --git a/config-ui/public/onboard/step-1/default.md b/config-ui/public/onboard/step-1/default.md index 096c7c110..8cf2ea073 100644 --- a/config-ui/public/onboard/step-1/default.md +++ b/config-ui/public/onboard/step-1/default.md @@ -18,4 +18,4 @@ limitations under the License. ##### What is a project? - On a high level, a project can be viewed as a real-world project or product line. It represents a specific initiative or endeavor within the software development domain. -- On a lower level, a project is a way of organizing and grouping data from different domains. +- On a lower level, a project is a way of organizing and grouping data from different tools. diff --git a/config-ui/public/onboard/step-1/github.md b/config-ui/public/onboard/step-1/github.md index 154fe51bd..7ce5e9d81 100644 --- a/config-ui/public/onboard/step-1/github.md +++ b/config-ui/public/onboard/step-1/github.md @@ -17,9 +17,14 @@ limitations under the License. ##### GitHub tells you: -1. What is your issue lead time? +1. What is the lead time for issues in your workflow? +  -2. How fast is your Code Review process? + +2. What is the turnaround time for your Code Review process? +  -3. How is your CI/CD process? + +3. How effective is your CI/CD pipeline? +  diff --git a/config-ui/public/onboard/step-1/gitlab.md b/config-ui/public/onboard/step-1/gitlab.md index 1878dc998..7ca8ef8ca 100644 --- a/config-ui/public/onboard/step-1/gitlab.md +++ b/config-ui/public/onboard/step-1/gitlab.md @@ -17,9 +17,14 @@ limitations under the License. ##### GitLab tells you: -1. How much code have you submitted? +1. What is the volume of code you have contributed? +  -2. How are your Merge Requests handled? + +2. How are the Merge Requests handled? +  -3. How fast is your Code Review process? + +3. What is the turnaround time for your Code Review process? +  diff --git a/config-ui/public/onboard/step-2/azuredevops.md b/config-ui/public/onboard/step-2/azuredevops.md index a359345f7..466b981fb 100644 --- a/config-ui/public/onboard/step-2/azuredevops.md +++ b/config-ui/public/onboard/step-2/azuredevops.md @@ -15,21 +15,21 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. How to create an Azure DevOps token? +##### Q1. How to generate an Azure DevOps token? 1. Sign in to your organization (https://dev.azure.com/{yourorganization}) and go to the homepage. 2. Open **User Settings** in the upper-right corner of the top navigation bar and select **Personal access tokens**. 3. Select **New Token**. 4. Name your token, select 'All accessible organizations' in the Organization field. -5. Select the scopes. See Q2. +5. Select the scopes. See **Q2**. 6. Select **Create**. -Check [this doc](https://devlake.apache.org/docs/Configuration/AzureDevOps/#token) for more details. +For detailed instructions, refer to [this doc](https://devlake.apache.org/docs/Configuration/AzureDevOps/#token). -##### Q2. What token scopes should I choose? +##### Q2. Which scopes should be included in a token? -Please select 'Full access'. +'Full access' is required to retrieve the Azure DevOps data. -##### Q3. Can I connect to the Azure DevOps server? +##### Q3. Is connecting to the Azure DevOps Server possible? -No. Azure DevOps server is not supported yet. +No. Azure DevOps Server is not supported yet. diff --git a/config-ui/public/onboard/step-2/bitbucket.md b/config-ui/public/onboard/step-2/bitbucket.md index 239ac4dd6..18a048138 100644 --- a/config-ui/public/onboard/step-2/bitbucket.md +++ b/config-ui/public/onboard/step-2/bitbucket.md @@ -15,30 +15,30 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. How to create a Bitbucket app password? +##### Q1. How to generate a Bitbucket app password? -1. Log in to [bitbucket.org](https://bitbucket.org). +1. Sign in at [bitbucket.org](https://bitbucket.org). 2. Select the **Settings** cog in the upper-right corner of the top navigation bar. 3. Under **Personal settings**, select **Personal Bitbucket settings**. 4. On the left sidebar, select **App passwords**. 5. Select **Create app password**. -6. Give the App password a name. -7. Select the permissions the App password needs. See Q2. +6. Give the 'App password' a name. +7. Select the permissions the 'App password needs'. See **Q2**. 8. Select the **Create** button. -Check [this doc](https://devlake.apache.org/docs/Configuration/BitBucket/#username-and-app-password) for more details. +For detailed instructions, refer to [this doc](https://devlake.apache.org/docs/Configuration/BitBucket/#username-and-app-password). -##### Q2. What app password permission should I choose? +##### Q2. Which app password permissions should be included in a token? The following permissions are required to collect data from Bitbucket repositories: `Account:Read` `Workspace` `membership:Read` `Repositories:Read` `Projects:Read` `Pull requests:Read` `Issues:Read` `Pipelines:Read` `Runners:Read` -##### Q3. Can I connect to the Bitbucket server? +##### Q3. Is connecting to the Bitbucket Server/Data Center possible? -Sure, you could +Yes, you can. -1. Go to the Connections page. -2. Click Create a New Connection. -3. Choose ‘Bitbucket server’ and finish the connection. +1. Navigate to the **Connections** page. +2. Click on Bitbucket Server, and Click on **Create a New Connection**. +3. Finish the configuration. -Bitbucket server is not supported to simplify this onboard process. +Please note that GitLab Server integration is not included to ease the onboarding process. diff --git a/config-ui/public/onboard/step-2/github.md b/config-ui/public/onboard/step-2/github.md index eff67bce7..9a9ed5563 100644 --- a/config-ui/public/onboard/step-2/github.md +++ b/config-ui/public/onboard/step-2/github.md @@ -15,30 +15,30 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. How to create a classic GitHub personal access token? +##### Q1. How to generate a GitHub personal access token (classic)? -1. Log in to [github.com](https://github.com). -2. In the upper-right corner of any page, click your profile photo, then click Settings. -3. In the left sidebar, click <> Developer settings. -4. In the left sidebar, under 'Personal access tokens', click Tokens (classic). -5. Choose the following scopes: `repo:status`, `repo:deployment`, `read:user` and `read:org`. +1. Sign in at [github.com](https://github.com). +2. Click your profile photo in the upper-right corner, select **Settings**. +3. On the left sidebar, click **Developer settings**. +4. Click **Tokens (classic)** under **Personal access tokens**. +5. Select the scopes: `repo:status`, `repo:deployment`, `read:user` and `read:org`. -Check [this doc](https://devlake.apache.org/docs/Configuration/GitHub/#personal-access-tokens) for more details. +For detailed instructions, refer to [this doc](https://devlake.apache.org/docs/Configuration/GitHub/#personal-access-tokens). -##### Q2. What token scopes should I choose? +##### Q2. Which scopes should be included in a token? -Normally, only the following scopes are required: +Typically, the necessary scopes are: `repo:status` `repo:deployment` `read:user` `read:org` -However, if you want to collect data from private repositories, you need to give full permission to repo: +For private repositories, extend permissions with: `repo` `read:user` `read:org` -##### Q3. Can I connect to the GitHub server? +##### Q3. Is connecting to the GitHub Server version possible? -Sure, you could +Yes, you can. -1. Go to the Connections page. -2. Click Create a New Connection. -3. Choose 'GitHub server' and finish the connection. +1. Navigate to the **Connections** page. +2. Click on GitHub, and click on **Create a New Connection**. +3. Select 'GitHub Server' and finish the configuration. -GitHub server is not supported to simplify this onboard process. +Please note that GitHub Server integration is not included to ease the onboarding process. diff --git a/config-ui/public/onboard/step-2/gitlab.md b/config-ui/public/onboard/step-2/gitlab.md index 90b2d8276..3893a49eb 100644 --- a/config-ui/public/onboard/step-2/gitlab.md +++ b/config-ui/public/onboard/step-2/gitlab.md @@ -15,34 +15,33 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. How to create a GitLab personal access token? +##### Q1. How to generate a GitLab personal access token? -1. Log in to [gitlab.com](https://gitlab.com). +1. Sign in at [gitlab.com](https://gitlab.com). 2. On the left sidebar, select your avatar, then select **Edit profile**. 3. On the left sidebar, select **Access Tokens**. 4. Select **Add new token**. 5. Enter a name and expiry date for the token. Select the desired scopes, `api` or `read_api`. 6. Select **Create personal access token**. -Check [this doc](https://devlake.apache.org/docs/Configuration/GitLab/#personal-access-token) for more details. +For detailed instructions, refer to [this doc](https://devlake.apache.org/docs/Configuration/GitLab/#personal-access-token). -##### Q2.What token scopes should I choose? +##### Q2. Which scopes should be included in a token? -Only one of the following scopes is required: +At least one of the following scopes must be included: `api` `read_api` -You also have to double-check your GitLab user -permission settings: +Also, ensure proper user permissions are set for the GitLab project you intend to collect data from: -1. Go to the Project information > Members page of the GitLab projects you wish to collect. -2. Check your role in this project from the Max role column. Make sure you are not the Guest role, otherwise, you will not be able to collect data from this project. +1. Navigate to the **Project information > Members** page of the GitLab project. +2. Confirm your role under the **Max role** column. Avoid the Guest role to ensure data collection capabilities. -##### Q3. Can I connect to the GitLab server? +##### Q3. Is connecting to the GitLab Server possible? -Sure, you could +Yes, you can. -1. Go to the Connections page. -2. Click Create a New Connection. -3. Choose 'GitLab server' and finish the connection. +1. Navigate to the **Connections** page. +2. Click on GitLab, and click on **Create a New Connection**. +3. Select 'GitLab Server' and finish the configuration. -GitLab server is not supported to simplify this onboard process. +Please note that GitLab Server integration is not included to ease the onboarding process. diff --git a/config-ui/public/onboard/step-3/azuredevops.md b/config-ui/public/onboard/step-3/azuredevops.md index 21008fadb..8a17a63c7 100644 --- a/config-ui/public/onboard/step-3/azuredevops.md +++ b/config-ui/public/onboard/step-3/azuredevops.md @@ -15,20 +15,20 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. What Azure DevOps data will be collected? +##### Q1: Which types of Azure DevOps data are collected? -`repos` `commits` `branches` `pull requests` `pr comments` `pipeline runs` `job runs` `users` +The data collected includes: `repos`, `commits`, `branches`, `pull requests`, `pr comments`, `pipeline runs`, `job runs`, `users`, etc. -Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. +For a comprehensive scope of data collection, refer to the [Supported Data Sources documentation](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin). -##### Q2. The data from which time range will be collected? +##### Q2. What time range is covered in the data collection? -Only the data from last 14 days will be collected to speed up the sync up time. You can always change the time range in the project details page later. +Data **updated** from the past 14 days is collected to expedite synchronization. The time range can be adjusted on the project details page at any point. -##### Q3. Can I do transformations on the collected data? +##### Q3. Is it possible to transform the collected data? -Yes. You can do transformations by adding a Scope Config to the repositories you choose later. +Yes, data transformations can be applied by setting up a Scope Config for the selected repositories afterward. -##### Q4. What is the frequency to sync up data? +##### Q4. How often is the data synchronized? -The data will be synced daily, you can change it in the project details page later. +Data synchronization occurs daily. This frequency can be modified on the project details page as needed. \ No newline at end of file diff --git a/config-ui/public/onboard/step-3/bitbucket.md b/config-ui/public/onboard/step-3/bitbucket.md index 26e651a4d..e4fd7e8a1 100644 --- a/config-ui/public/onboard/step-3/bitbucket.md +++ b/config-ui/public/onboard/step-3/bitbucket.md @@ -15,20 +15,20 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. What Bitbucket data will be collected? +##### Q1. Which types of Bitbucket data are collected? -`issues` `repos` `commits` `branches` `pull requests` `pr comments` `pipeline runs` `job runs` `deployments` `users` +The data collected includes: `issues`, `repos`, `commits`, `branches`, `pull requests`, `pr comments`, `pipeline runs`, `job runs`, `deployments`, `users`, etc. -Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. +For a comprehensive scope of data collection, refer to the [Supported Data Sources documentation](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin). -##### Q2. The data from which time range will be collected? +##### Q2. What time range is covered in the data collection? -Only the data from last 14 days will be collected to speed up the sync up time. You can always change the time range in the project details page later. +Data **updated** from the past 14 days is collected to expedite synchronization. The time range can be adjusted on the project details page at any point. -##### Q3. Can I do transformations on the collected data? +##### Q3. Is it possible to transform the collected data? -Yes. You can do transformations by adding a Scope Config to the repositories you choose later. +Yes, data transformations can be applied by setting up a Scope Config for the selected repositories afterward. -##### Q4. What is the frequency to sync up data? +##### Q4. How often is the data synchronized? -The data will be synced daily, you can change it in the project details page later. +Data synchronization occurs daily. This frequency can be modified on the project details page as needed. diff --git a/config-ui/public/onboard/step-3/github.md b/config-ui/public/onboard/step-3/github.md index 388751d2f..ce328ba0a 100644 --- a/config-ui/public/onboard/step-3/github.md +++ b/config-ui/public/onboard/step-3/github.md @@ -15,20 +15,20 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. What GitHub data will be collected? +##### Q1. Which types of GitHub data are collected? -`issues` `repos` `commits` `branches` `pull requests` `pr comments` `workflow runs` `job runs` `deployments` `users` +The data collected includes: `issues`, `repos`, `commits`, `branches`, `pull requests`, `pr comments`, `workflow runs`, `job runs`, `deployments`, `users`, etc. -Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. +For a comprehensive scope of data collection, refer to the [Supported Data Sources documentation](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin). -##### Q2. The data from which time range will be collected? +##### Q2. What time range is covered in the data collection? -Only the data from last 14 days will be collected to speed up the sync up time. You can always change the time range in the project details page later. +Data **updated** from the past 14 days is collected to expedite synchronization. The time range can be adjusted on the project details page at any point. -##### Q3. Can I do transformations on the collected data? +##### Q3. Is it possible to transform the collected data? -Yes. You can do transformations by adding a Scope Config to the repositories you choose later. +Yes, data transformations can be applied by setting up a Scope Config for the selected repositories afterward. -##### Q4. What is the frequency to sync up data? +##### Q4. How often is the data synchronized? -The data will be synced daily, you can change it in the project details page later. +Data synchronization occurs daily. This frequency can be modified on the project details page as needed. diff --git a/config-ui/public/onboard/step-3/gitlab.md b/config-ui/public/onboard/step-3/gitlab.md index 84c9f79ad..bd8c06143 100644 --- a/config-ui/public/onboard/step-3/gitlab.md +++ b/config-ui/public/onboard/step-3/gitlab.md @@ -15,20 +15,20 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### Q1. What GitLab data will be collected? +##### Q1. Which types of GitLab data are collected? -`issues` `repos` `commits` `branches` `merge requests` `mr notes` `pipeline runs` `job runs` `deployments` `users` +The data collected includes: `issues`, `repos`, `commits`, `branches`, `merge requests`, `mr notes`, `pipeline runs`, `job runs`, `deployments`, `users`, etc. -Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. +For a comprehensive scope of data collection, refer to the [Supported Data Sources documentation](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin). -##### Q2. The data from which time range will be collected? +##### Q2. What time range is covered in the data collection? -Only the data from last 14 days will be collected to speed up the sync up time. You can always change the time range in the project details page later. +Data **updated** from the past 14 days is collected to expedite synchronization. The time range can be adjusted on the project details page at any point. -##### Q3. Can I do transformations on the collected data? +##### Q3. Is it possible to transform the collected data? -Yes. You can do transformations by adding a Scope Config to the repositories you choose later. +Yes, data transformations can be applied by setting up a Scope Config for the selected repositories afterward. -##### Q4. What is the frequency to sync up data? +##### Q4. How often is the data synchronized? -The data will be synced daily, you can change it in the project details page later. +Data synchronization occurs daily. This frequency can be modified on the project details page as needed.
