This is an automated email from the ASF dual-hosted git repository. juzhiyuan pushed a commit to branch docs-refactor-contents in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
commit 78e9146fa13a35fa2290ff3024f43175f7dbc587 Author: juzhiyuan <[email protected]> AuthorDate: Mon Mar 1 11:21:05 2021 +0800 docs: refactor contents --- docs/en/latest/FAQ.md | 13 ++++--------- docs/en/latest/I18N_USER_GUIDE.md | 13 ++++--------- docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md | 15 +++++---------- docs/en/latest/USER_GUIDE.md | 13 ++++--------- docs/en/latest/api/api.md | 13 ++++--------- docs/en/latest/back-end-e2e.md | 11 ++++------- docs/en/latest/config.json | 16 ++++++---------- docs/en/latest/deploy-with-docker.md | 13 ++++--------- docs/en/latest/deploy-with-rpm.md | 13 ++++--------- docs/en/latest/deploy.md | 13 ++++--------- docs/en/latest/develop.md | 13 ++++--------- docs/en/latest/front-end-e2e.md | 11 ++++------- 12 files changed, 51 insertions(+), 106 deletions(-) diff --git a/docs/en/latest/FAQ.md b/docs/en/latest/FAQ.md index d378970..344304c 100644 --- a/docs/en/latest/FAQ.md +++ b/docs/en/latest/FAQ.md @@ -1,3 +1,7 @@ +--- +title: FAQ +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: fqa -title: FAQ - ---- - -# FAQ - ### 1. Vue.js version of the Dashboard If you need a Vue.js build of the Apache APISIX Dashboard 1.0, use the [master-vue branch](https://github.com/apache/apisix-dashboard/tree/master-vue). diff --git a/docs/en/latest/I18N_USER_GUIDE.md b/docs/en/latest/I18N_USER_GUIDE.md index d51ec95..00f5db3 100644 --- a/docs/en/latest/I18N_USER_GUIDE.md +++ b/docs/en/latest/I18N_USER_GUIDE.md @@ -1,3 +1,7 @@ +--- +title: i18n User Guide +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: i18n-guide -title: i18n Guide - ---- - -# Apache APISIX Dashboard I18N User Guide - The Apache APISIX Dashboard uses [@umijs/plugin-locale](https://umijs.org/plugins/plugin-locale) to solve the i18n issues, in order to make the i18n more clear and reasonable, we would recommend to obey the following rules ## Location of locale configuration： diff --git a/docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md b/docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md index 988baf9..67281bb 100644 --- a/docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md +++ b/docs/en/latest/IMPORT_OPENAPI_USER_GUIDE.md @@ -1,3 +1,7 @@ +--- +title: Import OpenAPI Guide +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,16 +21,7 @@ # --> ---- - -id: import-openapi-guide -title: Import OpenAPI Guide - ---- - -# Import OpenApi User Guide - -> The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. +The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. Apache APISIX Dashboard supports importing [OpenApi3.0](https://swagger.io/specification/)(we will use OAS3.0 for short) files to create the Route. Currently we support support most of the OpenApi specifications, but there are some differences, which are in terms of compatibility and extended fields. diff --git a/docs/en/latest/USER_GUIDE.md b/docs/en/latest/USER_GUIDE.md index d3b2494..a46b7d3 100644 --- a/docs/en/latest/USER_GUIDE.md +++ b/docs/en/latest/USER_GUIDE.md @@ -1,3 +1,7 @@ +--- +title: User Guide +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: userguide -title: User Guide - ---- - -# User Guide - The following are parts of the modules' snapshot. ## Metrics diff --git a/docs/en/latest/api/api.md b/docs/en/latest/api/api.md index 58970a2..57814c5 100644 --- a/docs/en/latest/api/api.md +++ b/docs/en/latest/api/api.md @@ -1,3 +1,7 @@ +--- +title: API doc of Manager API. +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: api -title: API Guide - ---- - -# API doc of Manager API. - Manager API directly operates ETCD and provides data management for Apache APISIX, provides APIs for Front-end or other clients. **License:** [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) diff --git a/docs/en/latest/back-end-e2e.md b/docs/en/latest/back-end-e2e.md index de3d791..88ec209 100644 --- a/docs/en/latest/back-end-e2e.md +++ b/docs/en/latest/back-end-e2e.md @@ -1,3 +1,7 @@ +--- +title: Backend E2E +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,13 +21,6 @@ # --> ---- - -id: backend-e2e -title: Backend E2E - ---- - This document describes how to use E2E test locally. ## Start with source code diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json index 87e01fd..e3ea7c2 100644 --- a/docs/en/latest/config.json +++ b/docs/en/latest/config.json @@ -1,17 +1,13 @@ { "version": 2.4, "docs": { - "Getting Started": ["userguide", "import-openapi-guide", "api"], - "Installation": [ - "deploy-with-source-codes", - "deploy-with-docker", - "deploy-with-rpm" - ], + "Getting Started": ["USER_GUIDE", "IMPORT_OPENAPI_USER_GUIDE", "api/api"], + "Installation": ["deploy-with", "deploy-with-docker", "deploy-with-rpm"], "Contributing": [ - "development-guide", - "frontend-e2e", - "backend-e2e", - "i18n-guide" + "develop", + "front-end-e2e", + "back-end-e2e", + "I18N_USER_GUIDE" ], "FAQ": ["faq"] } diff --git a/docs/en/latest/deploy-with-docker.md b/docs/en/latest/deploy-with-docker.md index 78e40a7..9a81e9e 100644 --- a/docs/en/latest/deploy-with-docker.md +++ b/docs/en/latest/deploy-with-docker.md @@ -1,3 +1,7 @@ +--- +title: Deploy with Docker +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: deploy-with-docker -title: Deploy with Docker - ---- - -# Building and Launching with Docker - **NOTE:** We support Docker Image, please visit [DockerHub](https://hub.docker.com/r/apache/apisix-dashboard) for more information. The following steps are for building Docker Image manually. To build the Dashboard with Docker, you simply download the `Dockerfile` file from the **root directory** to your device (no need to download all source codes) then follow this guide. diff --git a/docs/en/latest/deploy-with-rpm.md b/docs/en/latest/deploy-with-rpm.md index f80854d..b3820be 100644 --- a/docs/en/latest/deploy-with-rpm.md +++ b/docs/en/latest/deploy-with-rpm.md @@ -1,3 +1,7 @@ +--- +title: Deploy with RPM +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: deploy-with-rpm -title: Deploy with RPM - ---- - -# Deploy with RPM - **NOTE:** Only support CentOS 7 currently, for more information, please refer to [here](./deploy.md). ## Install from RPM diff --git a/docs/en/latest/deploy.md b/docs/en/latest/deploy.md index 37ae5cc..b841544 100644 --- a/docs/en/latest/deploy.md +++ b/docs/en/latest/deploy.md @@ -1,3 +1,7 @@ +--- +title: Deploy with Source Codes +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: deploy-with-source-codes -title: Deploy with Source Codes - ---- - -# Build and launch with source codes - The Dashboard contains both `manager-api` and `web`, but `web` is _optional_. The `manager-api` and `web` will be included in this build guide product. diff --git a/docs/en/latest/develop.md b/docs/en/latest/develop.md index b9fb7f2..6fbeff9 100644 --- a/docs/en/latest/develop.md +++ b/docs/en/latest/develop.md @@ -1,3 +1,7 @@ +--- +title: Development Guide +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,15 +21,6 @@ # --> ---- - -id: development-guide -title: Development Guide - ---- - -# Development Guide - The Dashboard contains both `manager-api` and `web` parts, so you need to start the development environment separately. ## Prerequisites diff --git a/docs/en/latest/front-end-e2e.md b/docs/en/latest/front-end-e2e.md index 44bbd78..c1b330b 100644 --- a/docs/en/latest/front-end-e2e.md +++ b/docs/en/latest/front-end-e2e.md @@ -1,3 +1,7 @@ +--- +title: Frontend E2E +--- + <!-- # # Licensed to the Apache Software Foundation (ASF) under one or more @@ -17,13 +21,6 @@ # --> ---- - -id: frontend-e2e -title: Frontend E2E - ---- - This project uses [Cypress](https://www.cypress.io/) as the front-end E2E test framework. 1. To start the front-end project locally, please refer to [develop](./develop.md) web section.
