This is an automated email from the ASF dual-hosted git repository. zky pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit f0008ea5e6fa44fff415bc6ba3c73696f93b4735 Author: yumengwang03 <[email protected]> AuthorDate: Wed Jul 13 23:33:12 2022 +0800 fix: fixed file names --- docs/DeveloperManuals/DeveloperSetup.md | 10 +++++----- docs/Plugins/gitextractor.md | 4 ++-- docs/QuickStart/LocalSetup.md | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/DeveloperManuals/DeveloperSetup.md b/docs/DeveloperManuals/DeveloperSetup.md index 4b05c11..2a462de 100644 --- a/docs/DeveloperManuals/DeveloperSetup.md +++ b/docs/DeveloperManuals/DeveloperSetup.md @@ -25,7 +25,7 @@ sidebar_position: 1 2. Install dependencies for plugins: - - [RefDiff](../Plugins/RefDiff.md#development) + - [RefDiff](../Plugins/refdiff.md#development) 3. Install Go packages @@ -76,10 +76,10 @@ sidebar_position: 1 - Navigate to desired plugins pages on the Integrations page - Enter the required information for the plugins you intend to use. - Refer to the following for more details on how to configure each one: - - [Jira](../Plugins/Jira.md) - - [GitLab](../Plugins/GitLab.md) - - [Jenkins](../Plugins/Jenkins.md) - - [GitHub](../Plugins/GitHub.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/GitHubUserGuide.md) which covers the following steps in detail. + - [Jira](../Plugins/jira.md) + - [GitLab](../Plugins/gitlab.md) + - [Jenkins](../Plugins/jenkins.md) + - [GitHub](../Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/GitHubUserGuide.md) which covers the following steps in detail. - Submit the form to update the values by clicking on the **Save Connection** button on each form page 9. Visit `localhost:4000/pipelines/create` to RUN a Pipeline and trigger data collection. diff --git a/docs/Plugins/gitextractor.md b/docs/Plugins/gitextractor.md index b40cede..ae3fecb 100644 --- a/docs/Plugins/gitextractor.md +++ b/docs/Plugins/gitextractor.md @@ -12,7 +12,7 @@ This plugin extracts commits and references from a remote or local git repositor 1. Use the Git repo extractor to retrieve data about commits and branches from your repository. 2. Use the GitHub plugin to retrieve data about Github issues and PRs from your repository. NOTE: you can run only one issue collection stage as described in the Github Plugin README. -3. Use the [RefDiff](RefDiff.md) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table. +3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table. ## Sample Request @@ -58,6 +58,6 @@ For more options (e.g., saving to a csv file instead of a db), please read `plug ## Development This plugin depends on `libgit2`, you need to install version 1.3.0 in order to run and debug this plugin on your local -machine. [Click here](RefDiff.md#Development) for a brief guide. +machine. [Click here](./refdiff.md#Development) for a brief guide. <br/><br/><br/> diff --git a/docs/QuickStart/LocalSetup.md b/docs/QuickStart/LocalSetup.md index 8e56a65..5ae0e0e 100644 --- a/docs/QuickStart/LocalSetup.md +++ b/docs/QuickStart/LocalSetup.md @@ -24,10 +24,10 @@ sidebar_position: 1 1. Visit `config-ui` at `http://localhost:4000` in your browser to configure data connections. - Navigate to desired plugins on the Integrations page - Please reference the following for more details on how to configure each one:<br/> - - [Jira](../Plugins/Jira.md) - - [GitHub](../Plugins/GitHub.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/GitHubUserGuide.md) which covers the following steps in detail. - - [GitLab](../Plugins/GitLab.md) - - [Jenkins](../Plugins/Jenkins.md) + - [Jira](../Plugins/jira.md) + - [GitHub](../Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/GitHubUserGuide.md) which covers the following steps in detail. + - [GitLab](../Plugins/gitlab.md) + - [Jenkins](../Plugins/jenkins.md) - Submit the form to update the values by clicking on the **Save Connection** button on each form page - `devlake` takes a while to fully boot up. if `config-ui` complaining about api being unreachable, please wait a few seconds and try refreshing the page. 2. Create pipelines to trigger data collection in `config-ui`
