You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ju...@apache.org on 2021/02/25 06:07:03 UTC
[apisix-dashboard] 01/01: chore: improve docs structure
This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch chore-docs
in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
commit b445c7f7345f42f5934da933c33b6774ccc70971
Author: juzhiyuan <ju...@apache.org>
AuthorDate: Thu Feb 25 14:06:35 2021 +0800
chore: improve docs structure
---
README.md | 14 +++++------
docs/{ => assets}/images/architecture.png | Bin
docs/{ => assets}/images/manager-api.png | Bin
docs/{ => assets}/images/metrics-cn.png | Bin
docs/{ => assets}/images/metrics-en.png | Bin
.../images/route-create-done-list-cn.png | Bin
.../images/route-create-done-list-en.png | Bin
docs/{ => assets}/images/route-create-step1-cn.png | Bin
docs/{ => assets}/images/route-create-step1-en.png | Bin
docs/{ => assets}/images/route-create-step2-cn.png | Bin
docs/{ => assets}/images/route-create-step2-en.png | Bin
docs/{ => assets}/images/route-create-step3-cn.png | Bin
docs/{ => assets}/images/route-create-step3-en.png | Bin
docs/{ => assets}/images/route-create-step4-cn.png | Bin
docs/{ => assets}/images/route-create-step4-en.png | Bin
.../{ => assets}/images/route-debug-basic-auth.png | Bin
.../images/route-debug-body-params.png | Bin
.../images/route-debug-header-params.png | Bin
docs/{ => assets}/images/route-debug-offline.png | Bin
docs/{ => assets}/images/route-debug-published.png | Bin
.../images/route-debug-query-params.png | Bin
docs/{ => assets}/images/route-list-en.png | Bin
docs/{ => assets}/images/setting-cn.png | Bin
docs/{ => assets}/images/setting-en.png | Bin
docs/{ => assets}/images/ssl-list-cn.png | Bin
docs/{ => assets}/images/ssl-list-en.png | Bin
docs/{ => en/latest}/FAQ.md | 8 +++---
docs/{ => en/latest}/I18N_USER_GUIDE.md | 0
docs/{ => en/latest}/IMPORT_OPENAPI_USER_GUIDE.md | 0
docs/{ => en/latest}/USER_GUIDE.md | 28 ++++++++++-----------
docs/{ => en/latest}/api/api.md | 0
docs/{ => en/latest}/back-end-e2e.md | 0
docs/en/latest/config.json | 1 +
docs/{ => en/latest}/deploy-with-docker.md | 0
docs/{ => en/latest}/deploy-with-rpm.md | 0
docs/{ => en/latest}/deploy.md | 0
docs/{ => en/latest}/develop.md | 0
docs/{ => en/latest}/front-end-e2e.md | 0
38 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index c97ffc0..ba5891d 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@ This project includes `Manager API`, which will gradually replace `Admin API` in
Note: Currently the Dashboard does not have complete coverage of Apache APISIX features, [visit here](https://github.com/apache/apisix-dashboard/milestones) to view the milestones.
-
+
## Demo
@@ -78,19 +78,19 @@ Password: admin
Support the following ways currently.
-- [Source Codes](./docs/deploy.md)
-- [Docker](./docs/deploy-with-docker.md)
-- [RPM package（only for CentOS 7）](./docs/deploy-with-rpm.md)
+- [Source Codes](./docs/en/latest/deploy.md)
+- [Docker](./docs/en/latest/deploy-with-docker.md)
+- [RPM package（only for CentOS 7）](./docs/en/latest/deploy-with-rpm.md)
## Development
Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/apache/apisix-dashboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) and help us out!
-Please refer to the [Development Guide](./docs/develop.md).
+Please refer to the [Development Guide](./docs/en/latest/develop.md).
## User Guide
-Please refer to the [User Guide](./docs/USER_GUIDE.md).
+Please refer to the [User Guide](./docs/en/latest/USER_GUIDE.md).
## Contributing
@@ -98,7 +98,7 @@ Please refer to the [Contribution Guide](./CONTRIBUTING.md) for a more detailed
## FAQ
-Please refer to the [FAQ](./docs/FAQ.md) for more known issues.
+Please refer to the [FAQ](./docs/en/latest/FAQ.md) for more known issues.
## License
diff --git a/docs/images/architecture.png b/docs/assets/images/architecture.png
similarity index 100%
rename from docs/images/architecture.png
rename to docs/assets/images/architecture.png
diff --git a/docs/images/manager-api.png b/docs/assets/images/manager-api.png
similarity index 100%
rename from docs/images/manager-api.png
rename to docs/assets/images/manager-api.png
diff --git a/docs/images/metrics-cn.png b/docs/assets/images/metrics-cn.png
similarity index 100%
rename from docs/images/metrics-cn.png
rename to docs/assets/images/metrics-cn.png
diff --git a/docs/images/metrics-en.png b/docs/assets/images/metrics-en.png
similarity index 100%
rename from docs/images/metrics-en.png
rename to docs/assets/images/metrics-en.png
diff --git a/docs/images/route-create-done-list-cn.png b/docs/assets/images/route-create-done-list-cn.png
similarity index 100%
rename from docs/images/route-create-done-list-cn.png
rename to docs/assets/images/route-create-done-list-cn.png
diff --git a/docs/images/route-create-done-list-en.png b/docs/assets/images/route-create-done-list-en.png
similarity index 100%
rename from docs/images/route-create-done-list-en.png
rename to docs/assets/images/route-create-done-list-en.png
diff --git a/docs/images/route-create-step1-cn.png b/docs/assets/images/route-create-step1-cn.png
similarity index 100%
rename from docs/images/route-create-step1-cn.png
rename to docs/assets/images/route-create-step1-cn.png
diff --git a/docs/images/route-create-step1-en.png b/docs/assets/images/route-create-step1-en.png
similarity index 100%
rename from docs/images/route-create-step1-en.png
rename to docs/assets/images/route-create-step1-en.png
diff --git a/docs/images/route-create-step2-cn.png b/docs/assets/images/route-create-step2-cn.png
similarity index 100%
rename from docs/images/route-create-step2-cn.png
rename to docs/assets/images/route-create-step2-cn.png
diff --git a/docs/images/route-create-step2-en.png b/docs/assets/images/route-create-step2-en.png
similarity index 100%
rename from docs/images/route-create-step2-en.png
rename to docs/assets/images/route-create-step2-en.png
diff --git a/docs/images/route-create-step3-cn.png b/docs/assets/images/route-create-step3-cn.png
similarity index 100%
rename from docs/images/route-create-step3-cn.png
rename to docs/assets/images/route-create-step3-cn.png
diff --git a/docs/images/route-create-step3-en.png b/docs/assets/images/route-create-step3-en.png
similarity index 100%
rename from docs/images/route-create-step3-en.png
rename to docs/assets/images/route-create-step3-en.png
diff --git a/docs/images/route-create-step4-cn.png b/docs/assets/images/route-create-step4-cn.png
similarity index 100%
rename from docs/images/route-create-step4-cn.png
rename to docs/assets/images/route-create-step4-cn.png
diff --git a/docs/images/route-create-step4-en.png b/docs/assets/images/route-create-step4-en.png
similarity index 100%
rename from docs/images/route-create-step4-en.png
rename to docs/assets/images/route-create-step4-en.png
diff --git a/docs/images/route-debug-basic-auth.png b/docs/assets/images/route-debug-basic-auth.png
similarity index 100%
rename from docs/images/route-debug-basic-auth.png
rename to docs/assets/images/route-debug-basic-auth.png
diff --git a/docs/images/route-debug-body-params.png b/docs/assets/images/route-debug-body-params.png
similarity index 100%
rename from docs/images/route-debug-body-params.png
rename to docs/assets/images/route-debug-body-params.png
diff --git a/docs/images/route-debug-header-params.png b/docs/assets/images/route-debug-header-params.png
similarity index 100%
rename from docs/images/route-debug-header-params.png
rename to docs/assets/images/route-debug-header-params.png
diff --git a/docs/images/route-debug-offline.png b/docs/assets/images/route-debug-offline.png
similarity index 100%
rename from docs/images/route-debug-offline.png
rename to docs/assets/images/route-debug-offline.png
diff --git a/docs/images/route-debug-published.png b/docs/assets/images/route-debug-published.png
similarity index 100%
rename from docs/images/route-debug-published.png
rename to docs/assets/images/route-debug-published.png
diff --git a/docs/images/route-debug-query-params.png b/docs/assets/images/route-debug-query-params.png
similarity index 100%
rename from docs/images/route-debug-query-params.png
rename to docs/assets/images/route-debug-query-params.png
diff --git a/docs/images/route-list-en.png b/docs/assets/images/route-list-en.png
similarity index 100%
rename from docs/images/route-list-en.png
rename to docs/assets/images/route-list-en.png
diff --git a/docs/images/setting-cn.png b/docs/assets/images/setting-cn.png
similarity index 100%
rename from docs/images/setting-cn.png
rename to docs/assets/images/setting-cn.png
diff --git a/docs/images/setting-en.png b/docs/assets/images/setting-en.png
similarity index 100%
rename from docs/images/setting-en.png
rename to docs/assets/images/setting-en.png
diff --git a/docs/images/ssl-list-cn.png b/docs/assets/images/ssl-list-cn.png
similarity index 100%
rename from docs/images/ssl-list-cn.png
rename to docs/assets/images/ssl-list-cn.png
diff --git a/docs/images/ssl-list-en.png b/docs/assets/images/ssl-list-en.png
similarity index 100%
rename from docs/images/ssl-list-en.png
rename to docs/assets/images/ssl-list-en.png
diff --git a/docs/FAQ.md b/docs/en/latest/FAQ.md
similarity index 93%
rename from docs/FAQ.md
rename to docs/en/latest/FAQ.md
index 2218473..fdc59d1 100644
--- a/docs/FAQ.md
+++ b/docs/en/latest/FAQ.md
@@ -36,8 +36,8 @@ If you are using Apache APISIX below v2.0, be aware that the data from the etcd
Since the Dashboard caches the jsonschema data of the plugins in Apache APISIX, you need to synchronize the data in the Dashboard after you create your custom plugins in Apache APISIX, which currently **only supports manual operation**. Please follow the following guide.
1. Confirm that your APISIX is running and has enabled control API (enabled by default and only runs local access)
-Refer to the beginning in:
-https://github.com/apache/apisix/blob/master/doc/control-api.md
+ Refer to the beginning in:
+ https://github.com/apache/apisix/blob/master/doc/control-api.md
2. Execute the following commands to export jsonchema on your APISIX server (if it is configured for non-local access, it does not need to be executed on your APISIX server, and the access IP and port should be modified accordingly)
@@ -60,11 +60,11 @@ We use [go-swagger](https://github.com/go-swagger/go-swagger) to generate Swagge
2. Use the `go-swagger` tool to generate Swagger 2.0 documents.
```shell
-$ swagger generate spec -o ./docs/api/api.yaml --scan-models
+$ swagger generate spec -o ./docs/en/latest/api/api.yaml --scan-models
```
3. Use the `swagger-markdown` tool to convert Swagger 2.0 documents into markdown documents.
```shell
-$ swagger-markdown -i ./docs/api/api.yaml
+$ swagger-markdown -i ./docs/en/latest/api/api.yaml
```
diff --git a/docs/I18N_USER_GUIDE.md b/docs/en/latest/I18N_USER_GUIDE.md
similarity index 100%
rename from docs/I18N_USER_GUIDE.md
rename to docs/en/latest/I18N_USER_GUIDE.md
diff --git a/docs/IMPORT_OPENAPI_USER_GUIDE.md b/docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md
similarity index 100%
rename from docs/IMPORT_OPENAPI_USER_GUIDE.md
rename to docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md
diff --git a/docs/USER_GUIDE.md b/docs/en/latest/USER_GUIDE.md
similarity index 65%
rename from docs/USER_GUIDE.md
rename to docs/en/latest/USER_GUIDE.md
index 8e9c237..0f5639c 100644
--- a/docs/USER_GUIDE.md
+++ b/docs/en/latest/USER_GUIDE.md
@@ -25,7 +25,7 @@ The following are parts of the modules' snapshot.
We support the monitor page by referencing it in [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe). Before accessing [Grafana](https://grafana.com/), please Enable [`allow_embedding=true`](https://grafana.com/docs/grafana/latest/administration/configuration/#allow_embedding), which defaults to `false`. This causes the browser to fail to render Grafana pages properly due to security policies.
-
+
## Route
@@ -33,19 +33,19 @@ The Route module aims to control routes by UI instead of calling APIs.
### List
-
+
### Create
-
+
-
+
-
+
-
+
-
+
### Online debug
@@ -53,28 +53,28 @@ We can debug a route both published or offline with the online debug function, w
1. Debug a published route
-
+
2. Debug a offline route
-
+
3. Debug a published route with query params
-
+
4. Debug a published route with header params
-
+
5. Debug a published route with body params
-
+
6. Debug a published route with basic auth
-
+
## Setting
-
+
diff --git a/docs/api/api.md b/docs/en/latest/api/api.md
similarity index 100%
rename from docs/api/api.md
rename to docs/en/latest/api/api.md
diff --git a/docs/back-end-e2e.md b/docs/en/latest/back-end-e2e.md
similarity index 100%
rename from docs/back-end-e2e.md
rename to docs/en/latest/back-end-e2e.md
diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
new file mode 100644
index 0000000..0967ef4
--- /dev/null
+++ b/docs/en/latest/config.json
@@ -0,0 +1 @@
+{}
diff --git a/docs/deploy-with-docker.md b/docs/en/latest/deploy-with-docker.md
similarity index 100%
rename from docs/deploy-with-docker.md
rename to docs/en/latest/deploy-with-docker.md
diff --git a/docs/deploy-with-rpm.md b/docs/en/latest/deploy-with-rpm.md
similarity index 100%
rename from docs/deploy-with-rpm.md
rename to docs/en/latest/deploy-with-rpm.md
diff --git a/docs/deploy.md b/docs/en/latest/deploy.md
similarity index 100%
rename from docs/deploy.md
rename to docs/en/latest/deploy.md
diff --git a/docs/develop.md b/docs/en/latest/develop.md
similarity index 100%
rename from docs/develop.md
rename to docs/en/latest/develop.md
diff --git a/docs/front-end-e2e.md b/docs/en/latest/front-end-e2e.md
similarity index 100%
rename from docs/front-end-e2e.md
rename to docs/en/latest/front-end-e2e.md