From 9bd47037886468040dacb693db370e6417b31aad Mon Sep 17 00:00:00 2001 From: wxq Date: Mon, 19 Jul 2021 21:26:02 +0800 Subject: [PATCH] docs: English catalog in sidebar (#3831) * docs: English catalog in sidebar * Update CHANGES.md * revert en/README.md Co-authored-by: Jason Song --- CHANGES.md | 1 + docs/en/_sidebar.md | 40 ++++++++++++++++++- .../distributed-deployment-guide.md | 1 + docs/en/deployment/quick-start-docker.md | 1 + docs/en/deployment/quick-start.md | 1 + .../design/apollo-core-concept-namespace.md | 1 + docs/en/design/apollo-design.md | 1 + docs/en/design/apollo-introduction.md | 1 + .../development/apollo-development-guide.md | 1 + .../portal-how-to-enable-email-service.md | 1 + .../portal-how-to-enable-session-store.md | 1 + ...rtal-how-to-enable-webhook-notification.md | 1 + ...al-how-to-implement-user-login-function.md | 1 + ...ues-in-deployment-and-development-phase.md | 1 + docs/en/faq/faq.md | 1 + docs/en/misc/apollo-benchmark.md | 1 + docs/en/usage/apollo-open-api-platform.md | 1 + docs/en/usage/apollo-user-guide.md | 1 + docs/en/usage/apollo-user-practices.md | 1 + docs/en/usage/dotnet-sdk-user-guide.md | 1 + docs/en/usage/java-sdk-user-guide.md | 1 + .../usage/other-language-client-user-guide.md | 1 + docs/en/usage/third-party-sdks-user-guide.md | 1 + 23 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 docs/en/deployment/distributed-deployment-guide.md create mode 100644 docs/en/deployment/quick-start-docker.md create mode 100644 docs/en/deployment/quick-start.md create mode 100644 docs/en/design/apollo-core-concept-namespace.md create mode 100644 docs/en/design/apollo-design.md create mode 100644 docs/en/design/apollo-introduction.md create mode 100644 docs/en/development/apollo-development-guide.md create mode 100644 docs/en/development/portal-how-to-enable-email-service.md create mode 100644 docs/en/development/portal-how-to-enable-session-store.md create mode 100644 docs/en/development/portal-how-to-enable-webhook-notification.md create mode 100644 docs/en/development/portal-how-to-implement-user-login-function.md create mode 100644 docs/en/faq/common-issues-in-deployment-and-development-phase.md create mode 100644 docs/en/faq/faq.md create mode 100644 docs/en/misc/apollo-benchmark.md create mode 100644 docs/en/usage/apollo-open-api-platform.md create mode 100644 docs/en/usage/apollo-user-guide.md create mode 100644 docs/en/usage/apollo-user-practices.md create mode 100644 docs/en/usage/dotnet-sdk-user-guide.md create mode 100644 docs/en/usage/java-sdk-user-guide.md create mode 100644 docs/en/usage/other-language-client-user-guide.md create mode 100644 docs/en/usage/third-party-sdks-user-guide.md diff --git a/CHANGES.md b/CHANGES.md index 13b58679325..bdc13fc51c3 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -58,6 +58,7 @@ Apollo 1.9.0 * [feature: add the delegating password encoder for apollo-portal simple auth](https://github.com/ctripcorp/apollo/pull/3804) * [support release apollo-client-config-data](https://github.com/ctripcorp/apollo/pull/3822) * [Reduce bootstrap time in the situation with large properties](https://github.com/ctripcorp/apollo/pull/3816) +* [docs: English catalog in sidebar](https://github.com/ctripcorp/apollo/pull/3831) ------------------ All issues and pull requests are [here](https://github.com/ctripcorp/apollo/milestone/6?closed=1) diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md index 18988255748..4cd724652ed 100644 --- a/docs/en/_sidebar.md +++ b/docs/en/_sidebar.md @@ -1,6 +1,44 @@ - [**Home**](en/README.md) -- [Releases](https://github.com/ctripcorp/apollo/releases) +- Design Document + - [Apollo Config Center Design](en/design/apollo-design.md) + - [Apollo Config Center Introduction](en/design/apollo-introduction.md) + - [Apollo Core Concept Namespace](en/design/apollo-core-concept-namespace.md) + - [Apollo Source Code Analysis](http://www.iocoder.cn/categories/Apollo/) + +- Deployment Document + - [Quick Start](en/deployment/quick-start.md) + - [Deployment Quick Start By Docker](en/deployment/quick-start-docker.md) + - [Distributed Deployment Guide](en/deployment/distributed-deployment-guide.md) + +- Development Document + - [Apollo Development Guide](en/development/apollo-development-guide.md) + - Code Styles + - [Eclipse Code Style](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) + - [Intellij Code Style](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) + - [Portal Implement User Login Function](en/development/portal-how-to-implement-user-login-function.md) + - [Portal Enable Email Service](en/development/portal-how-to-enable-email-service.md) + - [Portal Enable Session Store](en/development/portal-how-to-enable-session-store.md) + - [Portal Enable Webhook Notification](en/development/portal-how-to-enable-webhook-notification.md) + +- Usage Document + - [Apollo Usage Guide](en/usage/apollo-user-guide.md) + - [Java Client Usage Guide](en/usage/java-sdk-user-guide.md) + - [.Net Client Usage Guide](en/usage/dotnet-sdk-user-guide.md) + - [Go、Python、NodeJS、PHP etc. Client Usage Guide](en/usage/third-party-sdks-user-guide.md) + - [Other Language Client User Guide](en/usage/other-language-client-user-guide.md) + - [Apollo Openapi Guide](en/usage/apollo-open-api-platform.md) + - [Apollo Use Cases](https://github.com/ctripcorp/apollo-use-cases) + - [Apollo User Practices](en/usage/apollo-user-practices.md) + - [Apollo Security Best Practices](en/usage/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3) + +- FAQ + - [Frequently Asked Question](en/faq/faq.md) + - [Common Issues In Deployment & Development Phase](en/faq/common-issues-in-deployment-and-development-phase.md) + +- Other + - [Release History](https://github.com/ctripcorp/apollo/releases) + - [Apollo Benchmark](en/misc/apollo-benchmark.md) - Community - [Team](en/community/team.md) diff --git a/docs/en/deployment/distributed-deployment-guide.md b/docs/en/deployment/distributed-deployment-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/deployment/distributed-deployment-guide.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/deployment/quick-start-docker.md b/docs/en/deployment/quick-start-docker.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/deployment/quick-start-docker.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/deployment/quick-start.md b/docs/en/deployment/quick-start.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/deployment/quick-start.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/design/apollo-core-concept-namespace.md b/docs/en/design/apollo-core-concept-namespace.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/design/apollo-core-concept-namespace.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/design/apollo-design.md b/docs/en/design/apollo-design.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/design/apollo-design.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/design/apollo-introduction.md b/docs/en/design/apollo-introduction.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/design/apollo-introduction.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/development/apollo-development-guide.md b/docs/en/development/apollo-development-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/development/apollo-development-guide.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/development/portal-how-to-enable-email-service.md b/docs/en/development/portal-how-to-enable-email-service.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/development/portal-how-to-enable-email-service.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/development/portal-how-to-enable-session-store.md b/docs/en/development/portal-how-to-enable-session-store.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/development/portal-how-to-enable-session-store.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/development/portal-how-to-enable-webhook-notification.md b/docs/en/development/portal-how-to-enable-webhook-notification.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/development/portal-how-to-enable-webhook-notification.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/development/portal-how-to-implement-user-login-function.md b/docs/en/development/portal-how-to-implement-user-login-function.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/development/portal-how-to-implement-user-login-function.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/faq/common-issues-in-deployment-and-development-phase.md b/docs/en/faq/common-issues-in-deployment-and-development-phase.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/faq/common-issues-in-deployment-and-development-phase.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/faq/faq.md b/docs/en/faq/faq.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/faq/faq.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/misc/apollo-benchmark.md b/docs/en/misc/apollo-benchmark.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/misc/apollo-benchmark.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/apollo-open-api-platform.md b/docs/en/usage/apollo-open-api-platform.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/apollo-open-api-platform.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/apollo-user-guide.md b/docs/en/usage/apollo-user-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/apollo-user-guide.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/apollo-user-practices.md b/docs/en/usage/apollo-user-practices.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/apollo-user-practices.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/dotnet-sdk-user-guide.md b/docs/en/usage/dotnet-sdk-user-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/dotnet-sdk-user-guide.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/java-sdk-user-guide.md b/docs/en/usage/java-sdk-user-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/java-sdk-user-guide.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/other-language-client-user-guide.md b/docs/en/usage/other-language-client-user-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/other-language-client-user-guide.md @@ -0,0 +1 @@ +TODO diff --git a/docs/en/usage/third-party-sdks-user-guide.md b/docs/en/usage/third-party-sdks-user-guide.md new file mode 100644 index 00000000000..1333ed77b7e --- /dev/null +++ b/docs/en/usage/third-party-sdks-user-guide.md @@ -0,0 +1 @@ +TODO