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 16d71436ecd75abbab0c444d06ecd6d3986b6987 Author: 青湛 <[email protected]> AuthorDate: Thu Mar 28 14:40:04 2024 +1300 feat: improve the qa for onboard (#7226) --- config-ui/public/onboard/step-1/default.md | 2 +- config-ui/public/onboard/step-2/azuredevops.md | 19 +++++++++++++++ config-ui/public/onboard/step-2/bitbucket.md | 28 ++++++++++++++++++++++ config-ui/public/onboard/step-2/github.md | 2 +- config-ui/public/onboard/step-2/gitlab.md | 32 ++++++++++++++++++++++++++ config-ui/public/onboard/step-3/azuredevops.md | 18 +++++++++++++++ config-ui/public/onboard/step-3/bitbucket.md | 18 +++++++++++++++ config-ui/public/onboard/step-3/gitlab.md | 18 +++++++++++++++ 8 files changed, 135 insertions(+), 2 deletions(-) diff --git a/config-ui/public/onboard/step-1/default.md b/config-ui/public/onboard/step-1/default.md index f2183b8ba..096c7c110 100644 --- a/config-ui/public/onboard/step-1/default.md +++ b/config-ui/public/onboard/step-1/default.md @@ -15,7 +15,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -##### What is a data connection? +##### 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. diff --git a/config-ui/public/onboard/step-2/azuredevops.md b/config-ui/public/onboard/step-2/azuredevops.md index 449e8a88c..a359345f7 100644 --- a/config-ui/public/onboard/step-2/azuredevops.md +++ b/config-ui/public/onboard/step-2/azuredevops.md @@ -14,3 +14,22 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + +##### Q1. How to create 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. +6. Select **Create**. + +Check [this doc](https://devlake.apache.org/docs/Configuration/AzureDevOps/#token) for more details. + +##### Q2. What token scopes should I choose? + +Please select 'Full access'. + +##### Q3. Can I connect to the Azure DevOps server? + +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 449e8a88c..239ac4dd6 100644 --- a/config-ui/public/onboard/step-2/bitbucket.md +++ b/config-ui/public/onboard/step-2/bitbucket.md @@ -14,3 +14,31 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + +##### Q1. How to create a Bitbucket app password? + +1. Log in to [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. +8. Select the **Create** button. + +Check [this doc](https://devlake.apache.org/docs/Configuration/BitBucket/#username-and-app-password) for more details. + +##### Q2. What app password permission should I choose? + +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? + +Sure, you could + +1. Go to the Connections page. +2. Click Create a New Connection. +3. Choose ‘Bitbucket server’ and finish the connection. + +Bitbucket server is not supported to simplify this onboard process. diff --git a/config-ui/public/onboard/step-2/github.md b/config-ui/public/onboard/step-2/github.md index 74ac669c5..eff67bce7 100644 --- a/config-ui/public/onboard/step-2/github.md +++ b/config-ui/public/onboard/step-2/github.md @@ -21,7 +21,7 @@ limitations under the License. 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. +5. Choose the following 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. diff --git a/config-ui/public/onboard/step-2/gitlab.md b/config-ui/public/onboard/step-2/gitlab.md index 449e8a88c..90b2d8276 100644 --- a/config-ui/public/onboard/step-2/gitlab.md +++ b/config-ui/public/onboard/step-2/gitlab.md @@ -14,3 +14,35 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + +##### Q1. How to create a GitLab personal access token? + +1. Log in to [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. + +##### Q2.What token scopes should I choose? + +Only one of the following scopes is required: +`api` `read_api` + +You also have to double-check your GitLab user +permission settings: + +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. + +##### Q3. Can I connect to the GitLab server? + +Sure, you could + +1. Go to the Connections page. +2. Click Create a New Connection. +3. Choose 'GitLab server' and finish the connection. + +GitLab server is not supported to simplify this onboard process. diff --git a/config-ui/public/onboard/step-3/azuredevops.md b/config-ui/public/onboard/step-3/azuredevops.md index 449e8a88c..21008fadb 100644 --- a/config-ui/public/onboard/step-3/azuredevops.md +++ b/config-ui/public/onboard/step-3/azuredevops.md @@ -14,3 +14,21 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + +##### Q1. What Azure DevOps data will be collected? + +`repos` `commits` `branches` `pull requests` `pr comments` `pipeline runs` `job runs` `users` + +Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. + +##### Q2. The data from which time range will be collected? + +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. + +##### Q3. Can I do transformations on the collected data? + +Yes. You can do transformations by adding a Scope Config to the repositories you choose later. + +##### Q4. What is the frequency to sync up data? + +The data will be synced daily, you can change it in the project details page later. diff --git a/config-ui/public/onboard/step-3/bitbucket.md b/config-ui/public/onboard/step-3/bitbucket.md index 449e8a88c..26e651a4d 100644 --- a/config-ui/public/onboard/step-3/bitbucket.md +++ b/config-ui/public/onboard/step-3/bitbucket.md @@ -14,3 +14,21 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + +##### Q1. What Bitbucket data will be collected? + +`issues` `repos` `commits` `branches` `pull requests` `pr comments` `pipeline runs` `job runs` `deployments` `users` + +Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. + +##### Q2. The data from which time range will be collected? + +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. + +##### Q3. Can I do transformations on the collected data? + +Yes. You can do transformations by adding a Scope Config to the repositories you choose later. + +##### Q4. What is the frequency to sync up data? + +The data will be synced daily, you can change it in the project details page later. diff --git a/config-ui/public/onboard/step-3/gitlab.md b/config-ui/public/onboard/step-3/gitlab.md index 449e8a88c..84c9f79ad 100644 --- a/config-ui/public/onboard/step-3/gitlab.md +++ b/config-ui/public/onboard/step-3/gitlab.md @@ -14,3 +14,21 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + +##### Q1. What GitLab data will be collected? + +`issues` `repos` `commits` `branches` `merge requests` `mr notes` `pipeline runs` `job runs` `deployments` `users` + +Check [this doc](https://devlake.apache.org/docs/Overview/SupportedDataSources/#data-collection-scope-by-each-plugin) for more details. + +##### Q2. The data from which time range will be collected? + +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. + +##### Q3. Can I do transformations on the collected data? + +Yes. You can do transformations by adding a Scope Config to the repositories you choose later. + +##### Q4. What is the frequency to sync up data? + +The data will be synced daily, you can change it in the project details page later.
