This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 2e992f475 Separate FAQ.md into 3 articles inside Troubleshooting (#343)
2e992f475 is described below
commit 2e992f475469f3354f584fd951c68fb656bc25c2
Author: Klesh Wong <[email protected]>
AuthorDate: Fri Dec 9 16:40:09 2022 +0800
Separate FAQ.md into 3 articles inside Troubleshooting (#343)
* refactor: separate FAQ.md into Troubleshooting
* fix: jira server supports version 7
* docs: add links to troubleshooting
---
.nvmrc | 1 +
docs/GettingStarted/Authentication.md | 5 +++++
docs/GettingStarted/DockerComposeSetup.md | 5 +++++
docs/GettingStarted/HelmSetup.md | 5 +++++
docs/GettingStarted/KubernetesSetup.md | 5 +++++
docs/GettingStarted/RainbondSetup.md | 7 ++++++-
docs/GettingStarted/TemporalSetup.md | 7 ++++++-
docs/Overview/SupportedDataSources.md | 2 +-
.../FAQ.md => Troubleshooting/Configuration.md} | 6 +++---
docs/Troubleshooting/Dashboard.md | 13 +++++++++++++
docs/Troubleshooting/Installation.md | 12 ++++++++++++
docs/Troubleshooting/_category_.json | 8 ++++++++
docs/UserManuals/ConfigUI/AdvancedMode.md | 5 +++++
docs/UserManuals/ConfigUI/GitHub.md | 5 +++++
docs/UserManuals/ConfigUI/GitLab.md | 4 ++--
docs/UserManuals/ConfigUI/Jenkins.md | 5 +++++
docs/UserManuals/ConfigUI/Jira.md | 5 +++++
docs/UserManuals/ConfigUI/Tapd.md | 6 +++++-
docs/UserManuals/ConfigUI/Tutorial.md | 5 +++++
docs/UserManuals/ConfigUI/webhook.md | 5 +++++
docs/UserManuals/DORA.md | 5 +++++
docs/UserManuals/Dashboards/GrafanaUserGuide.md | 5 +++++
docs/UserManuals/TeamConfiguration.md | 5 +++++
23 files changed, 122 insertions(+), 9 deletions(-)
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 000000000..0c19c7b44
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+v16.18.1
diff --git a/docs/GettingStarted/Authentication.md
b/docs/GettingStarted/Authentication.md
index cd29553a5..f8f27df55 100644
--- a/docs/GettingStarted/Authentication.md
+++ b/docs/GettingStarted/Authentication.md
@@ -36,3 +36,8 @@ THIS IS DANGEROUS, DON'T DO IT. If you insist, here are some
suggestions you may
## Disclaimer
Security is complicated, all suggestions listed above are based on what we
learned so far. Apache Devlake makes no guarantee of any kind, please consult
your Security Advisor before applying.
+
+
+## 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)
diff --git a/docs/GettingStarted/DockerComposeSetup.md
b/docs/GettingStarted/DockerComposeSetup.md
index 9c3a258c5..7c592a85f 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -34,3 +34,8 @@ sidebar_position: 1
Support for database schema migration was introduced to DevLake in v0.10.0.
From v0.10.0 onwards, users can upgrade their instance smoothly to a newer
version. However, versions prior to v0.10.0 do not support upgrading to a newer
version with a different database schema.
<br/>
+
+
+## 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)
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index ed9a846f4..bebcd8a04 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -149,3 +149,8 @@ Some useful parameters for the chart, you could also check
them in values.yaml
| service.ingress.httpPort | The http port for ingress | 80 |
| service.ingress.httpsPort | The https port for ingress | 443 |
| option.localtime | The hostpath for mount as /etc/localtime |
/etc/localtime |
+
+
+## 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)
diff --git a/docs/GettingStarted/KubernetesSetup.md
b/docs/GettingStarted/KubernetesSetup.md
index 3a1bf8119..a96c294dd 100644
--- a/docs/GettingStarted/KubernetesSetup.md
+++ b/docs/GettingStarted/KubernetesSetup.md
@@ -49,3 +49,8 @@ We provide a sample
[k8s-deploy.yaml](https://github.com/apache/incubator-devlak
* `MYSQL_DATABASE`: use your RDS instance's DB name, you may need to
create a database first with `CREATE DATABASE <DB name>;`
* `MYSQL_URL`: set this for `grafana` in `$HOST:$PORT` format, where
$HOST and $PORT should be your RDS instance's endpoint and port respectively
* `DB_URL`: update the connection string with your RDS instance's info
for `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)
diff --git a/docs/GettingStarted/RainbondSetup.md
b/docs/GettingStarted/RainbondSetup.md
index 41b3c1545..fde883654 100644
--- a/docs/GettingStarted/RainbondSetup.md
+++ b/docs/GettingStarted/RainbondSetup.md
@@ -31,4 +31,9 @@ Install DevLake in Rainbond is the easiest way to get started.
## Next Step
-Creating a Blueprint, ref
[Tutorial](/docs/UserManuals/ConfigUI/Tutorial#creating-a-blueprint)
\ No newline at end of file
+Creating a Blueprint, ref
[Tutorial](/docs/UserManuals/ConfigUI/Tutorial#creating-a-blueprint)
+
+
+## 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)
diff --git a/docs/GettingStarted/TemporalSetup.md
b/docs/GettingStarted/TemporalSetup.md
index 58132999f..1d6ce844a 100644
--- a/docs/GettingStarted/TemporalSetup.md
+++ b/docs/GettingStarted/TemporalSetup.md
@@ -32,4 +32,9 @@ But, be careful, many API services like JIRA/GITHUB have a
request rate limit me
### How to setup
1. Clone and fire up the [temporalio](https://temporal.io/) services
-2. Clone this repo, and fire up DevLake with command `docker-compose -f
deployment/temporal/docker-compose-temporal.yml up -d`
\ No newline at end of file
+2. Clone this repo, and fire up DevLake with command `docker-compose -f
deployment/temporal/docker-compose-temporal.yml 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)
diff --git a/docs/Overview/SupportedDataSources.md
b/docs/Overview/SupportedDataSources.md
index 938d10f68..5f58eb4d2 100644
--- a/docs/Overview/SupportedDataSources.md
+++ b/docs/Overview/SupportedDataSources.md
@@ -15,7 +15,7 @@ Apache DevLake(incubating) supports the following data
sources. The data from ea
| GitLab (include GitLabCI) | Source Code Management, Code Review, Issue
Tracking, CI/CD | Cloud, Community Edition 13.x+ |Available
|`gitlab`, `gitextractor` | Full Refresh, Incremental Sync(for `issues`)|
| Gitee | Source Code Management, Code Review, Issue
Tracking | Cloud |Not Available
|`gitee`, `gitextractor` | Incremental Sync |
| BitBucket | Source Code Management, Code Review
| Cloud |Not Available
|`bitbucket`, `gitextractor` | Full Refresh |
-| Jira | Issue Tracking
| Cloud, Server 8.x+, Data Center 8.x+ |Available
|`jira` | Full Refresh, Incremental Sync(for `issues`,
`changelogs`, `worklogs`) |
+| Jira | Issue Tracking
| Cloud, Server 7.x+, Data Center 7.x+ |Available
|`jira` | Full Refresh, Incremental Sync(for `issues`,
`changelogs`, `worklogs`) |
| TAPD | Issue Tracking
| Cloud |Not Available
|`tapd` | Full Refresh, Incremental Sync(for `stories`,
`bugs`, `tasks`) |
| Jenkins | CI/CD
| 2.263.x+ |Available
|`jenkins` | Full Refresh |
| Feishu | Calendar
| Cloud |Not Available
|`feishu` | Full Refresh |
diff --git a/docs/UserManuals/FAQ.md b/docs/Troubleshooting/Configuration.md
similarity index 96%
rename from docs/UserManuals/FAQ.md
rename to docs/Troubleshooting/Configuration.md
index 709e8a58c..82ec1e7ee 100644
--- a/docs/UserManuals/FAQ.md
+++ b/docs/Troubleshooting/Configuration.md
@@ -1,8 +1,8 @@
---
-title: "FAQ"
-sidebar_position: 10
+title: "Configuration Troubleshotting"
+sidebar_position: 2
description: >
- Frequently Asked Questions
+ Configuration Troubleshotting
---
## Failed to collect data from the server with a self-signed certificate
diff --git a/docs/Troubleshooting/Dashboard.md
b/docs/Troubleshooting/Dashboard.md
new file mode 100644
index 000000000..1250cb01e
--- /dev/null
+++ b/docs/Troubleshooting/Dashboard.md
@@ -0,0 +1,13 @@
+---
+title: "Dashboard Troubleshooting"
+sidebar_position: 3
+description: >
+ Dashboard Troubleshooting
+---
+
+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)
diff --git a/docs/Troubleshooting/Installation.md
b/docs/Troubleshooting/Installation.md
new file mode 100644
index 000000000..65b7b0586
--- /dev/null
+++ b/docs/Troubleshooting/Installation.md
@@ -0,0 +1,12 @@
+---
+title: "Installation Troubleshooting"
+sidebar_position: 1
+description: >
+ Installation Troubleshooting
+---
+
+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)
diff --git a/docs/Troubleshooting/_category_.json
b/docs/Troubleshooting/_category_.json
new file mode 100644
index 000000000..ceac2b5c7
--- /dev/null
+++ b/docs/Troubleshooting/_category_.json
@@ -0,0 +1,8 @@
+{
+ "label": "Troubleshooting",
+ "position": 10,
+ "link":{
+ "type": "generated-index",
+ "slug": "Troubleshooting"
+ }
+}
diff --git a/docs/UserManuals/ConfigUI/AdvancedMode.md
b/docs/UserManuals/ConfigUI/AdvancedMode.md
index 7f984ed5c..805659218 100644
--- a/docs/UserManuals/ConfigUI/AdvancedMode.md
+++ b/docs/UserManuals/ConfigUI/AdvancedMode.md
@@ -95,3 +95,8 @@ This section is for editing a Blueprint in the Advanced Mode.
To edit in the Nor
To edit a Blueprint created in the Advanced mode, you can simply go the
Settings page of that Blueprint and click on Edit JSON to edit its
configuration.
+
+
+## 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)
diff --git a/docs/UserManuals/ConfigUI/GitHub.md
b/docs/UserManuals/ConfigUI/GitHub.md
index 17697899a..126ddc270 100644
--- a/docs/UserManuals/ConfigUI/GitHub.md
+++ b/docs/UserManuals/ConfigUI/GitHub.md
@@ -97,3 +97,8 @@ Please click `Save` to save the transformation rules for the
repo. In the data s
### Step 4 - Setting Sync Frequency
You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or enter a cron code to specify your prefered
schedule.
+
+
+## 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)
diff --git a/docs/UserManuals/ConfigUI/GitLab.md
b/docs/UserManuals/ConfigUI/GitLab.md
index 79f05d0d8..f5c109433 100644
--- a/docs/UserManuals/ConfigUI/GitLab.md
+++ b/docs/UserManuals/ConfigUI/GitLab.md
@@ -51,6 +51,6 @@ There are no transformation rules for GitLab repos.
You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or enter a cron code to specify your prefered
schedule.
-## FAQ
+## Troubleshooting
-If you run into any problem, please check the [FAQ](../FAQ.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/incubator-devlake/issues)
diff --git a/docs/UserManuals/ConfigUI/Jenkins.md
b/docs/UserManuals/ConfigUI/Jenkins.md
index 9db168120..195217737 100644
--- a/docs/UserManuals/ConfigUI/Jenkins.md
+++ b/docs/UserManuals/ConfigUI/Jenkins.md
@@ -42,3 +42,8 @@ There are no transformation rules for Jenkins.
### Step 4 - Setting Sync Frequency
You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or enter a cron code to specify your prefered
schedule.
+
+
+## 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)
diff --git a/docs/UserManuals/ConfigUI/Jira.md
b/docs/UserManuals/ConfigUI/Jira.md
index 952ecddea..a1b32a212 100644
--- a/docs/UserManuals/ConfigUI/Jira.md
+++ b/docs/UserManuals/ConfigUI/Jira.md
@@ -65,3 +65,8 @@ Each Jira board has at most ONE set of transformation rules.
### Step 4 - Setting Sync Frequency
You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or enter a cron code to specify your prefered
schedule.
+
+
+## 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)
diff --git a/docs/UserManuals/ConfigUI/Tapd.md
b/docs/UserManuals/ConfigUI/Tapd.md
index df233cb84..24064ac9e 100644
--- a/docs/UserManuals/ConfigUI/Tapd.md
+++ b/docs/UserManuals/ConfigUI/Tapd.md
@@ -29,4 +29,8 @@ For tapd, we suggest you to set rate limit to 3500
#### Test and Save Connection
Click `Test Connection`, if the connection is successful, click `Save
Connection` to add the connection.
-###
\ No newline at end of file
+
+
+## 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)
diff --git a/docs/UserManuals/ConfigUI/Tutorial.md
b/docs/UserManuals/ConfigUI/Tutorial.md
index 6d46e8c51..cb84ec8eb 100644
--- a/docs/UserManuals/ConfigUI/Tutorial.md
+++ b/docs/UserManuals/ConfigUI/Tutorial.md
@@ -68,3 +68,8 @@ The Settings page for editing Blueprints:
## Creating and Managing Data Connections
The Data Connections page allows you to view, create and manage all your data
connections in one place.
+
+
+## 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)
diff --git a/docs/UserManuals/ConfigUI/webhook.md
b/docs/UserManuals/ConfigUI/webhook.md
index 42ba628a0..8ce485e49 100644
--- a/docs/UserManuals/ConfigUI/webhook.md
+++ b/docs/UserManuals/ConfigUI/webhook.md
@@ -18,3 +18,8 @@ After clicking on "Generate POST URL", you will find four
webhook URLs. Copy the
For more usage: [plugins/webhook](/Plugins/webhook.md).
+
+
+## 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)
diff --git a/docs/UserManuals/DORA.md b/docs/UserManuals/DORA.md
index 75fe80619..81ac826b2 100644
--- a/docs/UserManuals/DORA.md
+++ b/docs/UserManuals/DORA.md
@@ -180,3 +180,8 @@ If you aren't familiar with Grafana, please refer to our
[Grafana doc](./Dashboa
<br/><br/><br/>
+
+
+## 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)
diff --git a/docs/UserManuals/Dashboards/GrafanaUserGuide.md
b/docs/UserManuals/Dashboards/GrafanaUserGuide.md
index 41a8e37f7..47a19f25d 100644
--- a/docs/UserManuals/Dashboards/GrafanaUserGuide.md
+++ b/docs/UserManuals/Dashboards/GrafanaUserGuide.md
@@ -118,3 +118,8 @@ To ensure we have properly connected our database to the
data source in Grafana,
- `database`
- `user`
- `secureJsonData/password`
+
+
+## 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)
diff --git a/docs/UserManuals/TeamConfiguration.md
b/docs/UserManuals/TeamConfiguration.md
index 84c9c6ac0..8457fd76a 100644
--- a/docs/UserManuals/TeamConfiguration.md
+++ b/docs/UserManuals/TeamConfiguration.md
@@ -186,3 +186,8 @@ FROM accounts a
join user_accounts ua on a.id = ua.account_id
join users u on ua.user_id = u.id
```
+
+
+## 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)
