Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactor-docs-structure #5084

Merged
merged 3 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ Demo Environment:
* Apollo also provides a packaging script, which can generate all required installation packages with just one click, and supports customization of runtime parameters

# Usage
1. [Apollo User Guide](https://www.apolloconfig.com/#/zh/usage/apollo-user-guide)
2. [Java SDK User Guide](https://www.apolloconfig.com/#/zh/usage/java-sdk-user-guide)
3. [.Net SDK user Guide](https://www.apolloconfig.com/#/zh/usage/dotnet-sdk-user-guide)
4. [Third Party SDK User Guide](https://www.apolloconfig.com/#/zh/usage/third-party-sdks-user-guide)
5. [Other Language Client User Guide](https://www.apolloconfig.com/#/zh/usage/other-language-client-user-guide)
6. [Apollo Open APIs](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform)
1. [Apollo User Guide](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide)
2. [Java SDK User Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide)
3. [.Net SDK user Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide)
4. [Third Party SDK User Guide](https://www.apolloconfig.com/#/zh/client/third-party-sdks-user-guide)
5. [Other Language Client User Guide](https://www.apolloconfig.com/#/zh/client/other-language-client-user-guide)
6. [Apollo Open APIs](https://www.apolloconfig.com/#/zh/portal/apollo-open-api-platform)
7. [Apollo Use Cases](https://github.com/apolloconfig/apollo-use-cases)
8. [Apollo User Practices](https://www.apolloconfig.com/#/zh/usage/apollo-user-practices)
9. [Apollo Security Best Practices](https://www.apolloconfig.com/#/zh/usage/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3)
8. [Apollo User Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-practices)
9. [Apollo Security Best Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3)

# Design
* [Apollo Design](https://www.apolloconfig.com/#/zh/design/apollo-design)
Expand All @@ -88,7 +88,7 @@ Demo Environment:
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)

# Development
* [Apollo Development Guide](https://www.apolloconfig.com/#/zh/development/apollo-development-guide)
* [Apollo Development Guide](https://www.apolloconfig.com/#/zh/contribution/apollo-development-guide)
* Code Styles
* [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml)
* [Intellij Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml)
Expand Down
18 changes: 9 additions & 9 deletions docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ Demo Environment:
* Apollo also provides a packaging script, which can generate all required installation packages with just one click, and supports customization of runtime parameters

# Usage
1. [Apollo User Guide](en/usage/apollo-user-guide)
2. [Java SDK User Guide](en/usage/java-sdk-user-guide)
3. [.Net SDK user Guide](en/usage/dotnet-sdk-user-guide)
4. [Third Party SDK User Guide](en/usage/third-party-sdks-user-guide)
5. [Other Language Client User Guide](en/usage/other-language-client-user-guide)
6. [Apollo Open APIs](en/usage/apollo-open-api-platform)
1. [Apollo User Guide](en/portal/apollo-user-guide)
2. [Java SDK User Guide](en/client/java-sdk-user-guide)
3. [.Net SDK user Guide](en/client/dotnet-sdk-user-guide)
4. [Third Party SDK User Guide](en/client/third-party-sdks-user-guide)
nobodyiam marked this conversation as resolved.
Show resolved Hide resolved
5. [Other Language Client User Guide](en/client/other-language-client-user-guide)
6. [Apollo Open APIs](en/portal/apollo-open-api-platform)
7. [Apollo Use Cases](https://github.com/ctripcorp/apollo-use-cases)
8. [Apollo User Practices](en/usage/apollo-user-practices)
9. [Apollo Security Best Practices](en/usage/apollo-user-guide?id=_71-security-related)
8. [Apollo User Practices](en/portal/apollo-user-practices)
9. [Apollo Security Best Practices](en/portal/apollo-user-guide?id=_71-security-related)

# Design
* [Apollo Design](en/design/apollo-design)
Expand All @@ -80,7 +80,7 @@ Demo Environment:
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)

# Development
* [Apollo Development Guide](en/development/apollo-development-guide)
* [Apollo Development Guide](en/contribution/apollo-development-guide)
* Code Styles
* [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml)
* [Intellij Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml)
Expand Down
49 changes: 29 additions & 20 deletions docs/en/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,45 @@
- [Apollo Core Concept Namespace](en/design/apollo-core-concept-namespace.md)
- [Apollo Source Code Analysis](http://www.iocoder.cn/categories/Apollo/)

- Deployment Document
- Deployment Guide
- [Quick Start](en/deployment/quick-start.md)
- [Deployment Quick Start By Docker](en/deployment/quick-start-docker.md)
- [Deployment Architecture](en/deployment/deployment-architecture.md)
- [Distributed Deployment Guide](en/deployment/distributed-deployment-guide.md)
- Deployment By Third-party Tool
- [Install the HA Apollo cluster in Rainbond with one-click](en/deployment/third-party-tool-rainbond.md)
- [Release New Version Guide](en/development/apollo-release-guide.md)

- Development Document
- [Apollo Development Guide](en/development/apollo-development-guide.md)
- Admin Guide
- [Apollo Usage Guide](en/portal/apollo-user-guide.md)
- [Apollo Openapi Guide](en/portal/apollo-open-api-platform.md)
- [Apollo Security Best Practices](en/portal/apollo-user-guide?id=_71-security-related)
- [Apollo User Practices](en/portal/apollo-user-practices.md)
- [Apollo Use Cases](https://github.com/ctripcorp/apollo-use-cases)

- SDK Guide
- [Java Client Usage Guide](en/client/java-sdk-user-guide.md)
- [.Net Client Usage Guide](en/client/dotnet-sdk-user-guide.md)
- [Golang Client Usage Guide](en/client/golang-sdks-user-guide.md)
- [Python Client Usage Guide](en/client/python-sdks-user-guide.md)
- [NodeJS Client Usage Guide](en/client/nodejs-sdks-user-guide.md)
- [PHP Client Usage Guide](en/client/php-sdks-user-guide.md)
- [C Client Usage Guide](en/client/c-sdks-user-guide.md)
- [Rust Client Usage Guide](en/client/rust-sdks-user-guide.md)
- [HTTP API Guide](en/client/other-language-client-user-guide.md)

- Extension Guide
- [Portal Implement User Login Function](en/extension/portal-how-to-implement-user-login-function.md)
- [Portal Enable Email Service](en/extension/portal-how-to-enable-email-service.md)
- [Portal Enable Session Store](en/extension/portal-how-to-enable-session-store.md)
- [Portal Enable Webhook Notification](en/extension/portal-how-to-enable-webhook-notification.md)

- Contributor Guide
- [Apollo Development Guide](en/contribution/apollo-development-guide.md)
- Code Styles
- [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml)
- [Intellij Code Style](https://github.com/apolloconfig/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-security-related)
- [Release New Version Guide](en/contribution/apollo-release-guide.md)
- [Contributing Guide](en/contributing.md)

- FAQ
- [Frequently Asked Question](en/faq/faq.md)
Expand All @@ -47,5 +57,4 @@
- Community
- [Team](en/community/team.md)
- [Community Governance](en/governance.md)
- [Contributing Guide](en/contributing.md)
- [Acknowledgements](en/community/thank-you.md)
5 changes: 5 additions & 0 deletions docs/en/client/c-sdks-user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Apollo C client

Project address: [apollo-c-client](https://github.com/lzeqian/apollo)

> Thanks [@lzeqian](https://github.com/lzeqian) for providing support for the C Apollo client
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> Note: This document is intended for users of Apollo systems. If you are a developer/maintainer of Apollo systems in your company, it is recommended to refer to [Apollo Development Guide](en/development/apollo-development-guide) first.
> Note: This document is intended for users of Apollo systems. If you are a developer/maintainer of Apollo systems in your company, it is recommended to refer to [Apollo Development Guide](en/contribution/apollo-development-guide) first.

#  

Expand Down Expand Up @@ -173,7 +173,7 @@ string value = config.GetProperty(someKey, someDefaultValue);

## 3.4 Demo

There is a sample client project in apollo.net project: `ApolloDemo`, you can refer to [2.4 .Net sample client startup](en/development/apollo-development-guide?id=_24-net-sample-client-startup) for more information.
There is a sample client project in apollo.net project: `ApolloDemo`, you can refer to [2.4 .Net sample client startup](en/contribution/apollo-development-guide?id=_24-net-sample-client-startup) for more information.

>Net client open source version will output logs directly to the Console by default, you can implement your own logging-related features.
>
Expand Down
53 changes: 53 additions & 0 deletions docs/en/client/golang-sdks-user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
### Apollo Go client 1

Project address: [apolloconfig/agollo](https://github.com/apolloconfig/agollo)

> Thanks [@zouyx](https://github.com/zouyx) for providing support for the Go Apollo client

### Apollo Go client 2

Project address: [philchia/agollo](https://github.com/philchia/agollo)

> Thanks [@philchia](https://github.com/philchia) for providing support for the Go Apollo client

### Apollo Go client 3

Project address: [shima-park/agollo](https://github.com/shima-park/agollo)

> Thanks [@shima-park](https://github.com/shima-park) for providing support for the Go Apollo client

### Apollo Go client 4

Project address: [go-microservices/php_conf_agent](https://github.com/go-microservices/php_conf_agent)

> Thanks [@GanymedeNil](https://github.com/GanymedeNil) for providing support for the Go Apollo client

### Apollo Go client 5

Project address: [hyperjiang/lunar](https://github.com/hyperjiang/lunar)

> Thanks [@hyperjiang](https://github.com/hyperjiang) for providing support for the Go Apollo client

### Apollo Go client 6

Project address: [tagconfig/tagconfig](https://github.com/tagconfig/tagconfig)

> Thanks [@n0trace](https://github.com/n0trace) for providing support for the Go Apollo client

### Apollo Go client 7

Project address: [go-chassis/go-archaius](https://github.com/go-chassis/go-archaius/tree/master/examples/apollo)

> Thanks [@tianxiaoliang](https://github.com/tianxiaoliang) and [@Shonminh](https://github.com/Shonminh) for providing support for the Go Apollo client

### Apollo Go client 8

Project address: [xhrg-product/apollo-client-golang](https://github.com/xhrg-product/apollo-client-golang)

> Thanks [@xhrg](https://github.com/xhrg) for providing support for the Go Apollo client

### Apollo Go client 9

Project address: [xnzone/apollo-go](https://github.com/xnzone/apollo-go)

> Thanks [@xnzone](https://github.com/xnzone) for providing support for the Go Apollo client
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> Note: This document is intended for users of Apollo systems. If you are a developer/maintainer of Apollo systems in your company, it is recommended to refer to [Apollo Development Guide](en/development/apollo-development-guide) first.
> Note: This document is intended for users of Apollo systems. If you are a developer/maintainer of Apollo systems in your company, it is recommended to refer to [Apollo Development Guide](en/contribution/apollo-development-guide) first.

#  

Expand Down Expand Up @@ -90,14 +90,14 @@ The following ways to configure apollo meta server information are supported sin
* You can specify `apollo.meta=http://config-service-url` in `classpath:/META-INF/app.properties`
6. Via Java system property `${env}_meta`
* If the current [env](#_1241-environment) is `dev`, then the user can configure `-Ddev_meta=http://config-service-url`
* Using this configuration method, then the Environment must be configured correctly, see [1.2.4.1 Environment](en/usage/java-sdk-user-guide?id=_1241-environment) for details
* Using this configuration method, then the Environment must be configured correctly, see [1.2.4.1 Environment](en/client/java-sdk-user-guide?id=_1241-environment) for details
7. Via the OS System Environment `${ENV}_META` (supported since version 1.2.0)
* If the current [env](#_1241-environment) is `dev`, then the user can configure the OS System Environment `DEV_META=http://config-service-url`
* Note that the key is all-caps
* Using this configuration method, then the Environment must be configured correctly, see [1.2.4.1 Environment](en/usage/java-sdk-user-guide?id=_1241-environment) for details
* Using this configuration method, then the Environment must be configured correctly, see [1.2.4.1 Environment](en/client/java-sdk-user-guide?id=_1241-environment) for details
8. Via the `apollo-env.properties` file
* The user can also create an `apollo-env.properties` and put it under the classpath of the application or under the config directory of the spring boot application
* If you use this configuration, then you must configure the Environment correctly, see [1.2.4.1 Environment](en/usage/java-sdk-user-guide?id=_1241-environment)
* If you use this configuration, then you must configure the Environment correctly, see [1.2.4.1 Environment](en/client/java-sdk-user-guide?id=_1241-environment)
* The contents of the file look like this.

```properties
Expand Down Expand Up @@ -439,7 +439,7 @@ Apollo supports API approach and Spring integration approach, how to choose whic
* Replace the placeholder in the configuration file, e.g.: `spring.datasource.url: ${someKeyFromApollo:someDefaultValue}`
* Directly hosting spring's configuration, such as directly configuring `spring.datasource.url=jdbc:mysql://localhost:3306/somedb?characterEncoding=utf8` in apollo
* Spring boot's [@ConfigurationProperties](http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/properties/ConfigurationProperties.html) method
* Versions from v0.10.0 onwards support automatic update of placeholder at runtime, see [PR #972](https://github.com/apolloconfig/apollo/pull/972) for details. (Versions prior to v0.10.0 do not re-inject after configuration changes and require a restart to update. If you need real-time updates of configuration values, you can refer to the subsequent description in [3.2.2 Use of Spring Placeholder](en/usage/java-sdk-user-guide?id=_322-use-of-spring-placeholder)
* Versions from v0.10.0 onwards support automatic update of placeholder at runtime, see [PR #972](https://github.com/apolloconfig/apollo/pull/972) for details. (Versions prior to v0.10.0 do not re-inject after configuration changes and require a restart to update. If you need real-time updates of configuration values, you can refer to the subsequent description in [3.2.2 Use of Spring Placeholder](en/client/java-sdk-user-guide?id=_322-use-of-spring-placeholder)

* The Spring approach can also be used in combination with the API approach, such as injecting Apollo's Config object, you can get the configuration as usual through the API approach:

Expand Down Expand Up @@ -528,7 +528,7 @@ Apollo also supports integration with Spring (Spring 3.1.1+), and only requires

Apollo currently supports both the more traditional `XML-based` configuration and the currently more popular `Java-based (recommended)` configuration.

In case of Spring Boot environments, it is recommended to refer to [3.2.1.3 Spring Boot integration methods (recommended)](en/usage/java-sdk-user-guide?id=_3213-spring-boot-integration-methods-recommended) for configuration.
In case of Spring Boot environments, it is recommended to refer to [3.2.1.3 Spring Boot integration methods (recommended)](en/client/java-sdk-user-guide?id=_3213-spring-boot-integration-methods-recommended) for configuration.

Note that if you have previously used `org.springframework.beans.factory.config.PropertyPlaceholderConfigurer`, please replace it with `org.springframework.context.support.PropertySourcesPlaceholderConfigurer`. It is not recommended to use PropertyPlaceholderConfigurer after Spring 3.1, use PropertySourcesPlaceholderConfigurer instead.

Expand Down Expand Up @@ -1118,7 +1118,7 @@ eureka.instance.preferIpAddress = true

## 3.3 Demo

There is a sample client project in the project: `apollo-demo`, for details, please refer to [2.3 Java Sample Client Start](en/development/apollo-development-guide?id=_23-java-sample-client-startup) in [Apollo Development Guide](en/development/apollo-development-guide) section.
There is a sample client project in the project: `apollo-demo`, for details, please refer to [2.3 Java Sample Client Start](en/contribution/apollo-development-guide?id=_23-java-sample-client-startup) in [Apollo Development Guide](en/contribution/apollo-development-guide) section.

For more use case demos, please refer to [Apollo usage scenarios and sample code](https://github.com/ctripcorp/apollo-use-cases).

Expand Down Expand Up @@ -1153,7 +1153,7 @@ Modify the `/opt/settings/server.properties` (Mac/Linux) or `C:\opt\settings\ser
env=Local
```

For more ways to configure the environment, please refer to [1.2.4.1 Environment](en/usage/java-sdk-user-guide?id=_1241-environment)
For more ways to configure the environment, please refer to [1.2.4.1 Environment](en/client/java-sdk-user-guide?id=_1241-environment)

## 5.2 Preparing local configuration files

Expand Down
41 changes: 41 additions & 0 deletions docs/en/client/nodejs-sdks-user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
### Apollo NodeJS client 1

Project address: [node-apollo](https://github.com/Quinton/node-apollo)

> Thanks [@Quinton](https://github.com/Quinton) for providing support for the NodeJS Apollo client

### Apollo NodeJS client 2

Project address: [ctrip-apollo](https://github.com/kaelzhang/ctrip-apollo)

> Thanks [@kaelzhang](https://github.com/kaelzhang) for providing support for the NodeJS Apollo client

### Apollo NodeJS client 3

Project address: [node-apollo-client](https://github.com/shinux/node-apollo-client)

> Thanks [@shinux](https://github.com/shinux) for providing support for the NodeJS Apollo client

### Apollo NodeJS client 4

Project address: [ctrip-apollo-client](https://github.com/lvgithub/ctrip-apollo-client)

> Thanks [@lvgithub](https://github.com/lvgithub) for providing support for the NodeJS Apollo client

### Apollo NodeJS client 5

Project address: [apollo-node](https://github.com/lengyuxuan/apollo-node)

> Thanks [@lengyuxuan](https://github.com/lengyuxuan) for providing support for the NodeJS Apollo client

### Apollo NodeJS client 6

Project address: [egg-apollo-client](https://github.com/xuezier/egg-apollo-client)

> Thanks [@xuezier](https://github.com/xuezier) for providing support for the NodeJS Apollo client

### Apollo NodeJS client 7

Project address: [apollo-node-client](https://github.com/zhangxh1023/apollo-node-client)

> Thanks [@zhangxh1023](https://github.com/zhangxh1023) for providing support for the NodeJS Apollo client
Loading
Loading