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 all 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
82 changes: 51 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ Demo Environment:
- User/Password: apollo/admin

# Screenshots

![Screenshot](https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/docs/en/images/apollo-home-screenshot.jpg)

# Features

* **Unified management of the configurations of different environments and different clusters**
* Apollo provides a unified interface to centrally manage the configurations of different environments, different clusters, and different namespaces
* The same codebase could have different configurations when deployed in different clusters
Expand Down Expand Up @@ -71,55 +73,73 @@ 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)
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)

* [Apollo User Guide](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide)
* [Apollo Open APIs](https://www.apolloconfig.com/#/zh/portal/apollo-open-api-platform)
* [Apollo Use Cases](https://github.com/apolloconfig/apollo-use-cases)
* [Apollo User Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-practices)
* [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)

# SDK

* [Java SDK User Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide)
* [.Net SDK user Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide)
* [Golang SDK User Guide](https://www.apolloconfig.com/#/zh/client/goland-sdks-user-guide)
* [Python SDK User Guide](https://www.apolloconfig.com/#/zh/client/python-sdks-user-guide)
* [NodeJS SDK User Guide](https://www.apolloconfig.com/#/zh/client/nodejs-sdks-user-guide)
* [PHP SDK User Guide](https://www.apolloconfig.com/#/zh/client/php-sdks-user-guide)
* [C SDK User Guide](https://www.apolloconfig.com/#/zh/client/c-sdks-user-guide)
* [Rust SDK User Guide](https://www.apolloconfig.com/#/zh/client/rust-sdks-user-guide)
* [HTTP API Guide](https://www.apolloconfig.com/#/zh/client/other-language-client-user-guide)

# Design
* [Apollo Design](https://www.apolloconfig.com/#/zh/design/apollo-design)
* [Apollo Core Concept - Namespace](https://www.apolloconfig.com/#/zh/design/apollo-core-concept-namespace)
* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ)
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)

* [Apollo Design](https://www.apolloconfig.com/#/zh/design/apollo-design)
* [Apollo Core Concept - Namespace](https://www.apolloconfig.com/#/zh/design/apollo-core-concept-namespace)
* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ)
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)

# Development
* [Apollo Development Guide](https://www.apolloconfig.com/#/zh/development/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)

* [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)

# Deployment
* [Quick Start](https://www.apolloconfig.com/#/zh/deployment/quick-start)
* [Distributed Deployment Guide](https://www.apolloconfig.com/#/zh/deployment/distributed-deployment-guide)

* [Quick Start](https://www.apolloconfig.com/#/zh/deployment/quick-start)
* [Distributed Deployment Guide](https://www.apolloconfig.com/#/zh/deployment/distributed-deployment-guide)

# Release Notes
* [Releases](https://github.com/apolloconfig/apollo/releases)

* [Releases](https://github.com/apolloconfig/apollo/releases)

# FAQ
* [FAQ](https://www.apolloconfig.com/#/zh/faq/faq)
* [Common Issues in Deployment & Development Phase](https://www.apolloconfig.com/#/zh/faq/common-issues-in-deployment-and-development-phase)

* [FAQ](https://www.apolloconfig.com/#/zh/faq/faq)
* [Common Issues in Deployment & Development Phase](https://www.apolloconfig.com/#/zh/faq/common-issues-in-deployment-and-development-phase)

# Presentation
* [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420)
* [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf)
* [Configuration Center Makes Microservices Smart](https://2018.qconshanghai.com/presentation/799)
* [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/configuration-center-makes-microservices-smart.pdf)

* [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420)
* [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf)
* [Configuration Center Makes Microservices Smart](https://2018.qconshanghai.com/presentation/799)
* [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/configuration-center-makes-microservices-smart.pdf)

# Publication
* [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo)
* [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ)

* [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo)
* [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ)

# Community
* [Apollo Team](https://www.apolloconfig.com/#/en/community/team)
* [Community Governance](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md)
* [Contributing Guide](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md)

* [Apollo Team](https://www.apolloconfig.com/#/en/community/team)
* [Community Governance](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md)
* [Contributing Guide](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md)

# License

The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE).

# Known Users
Expand Down
36 changes: 0 additions & 36 deletions docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,40 +62,9 @@ Demo Environment:
* Currently, the only external dependency is MySQL, so the deployment is very simple. Apollo can run as long as Java and MySQL are installed
* 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)
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)

# Design
* [Apollo Design](en/design/apollo-design)
* [Apollo Core Concept - Namespace](en/design/apollo-core-concept-namespace)
* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ)
* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/)

# Development
* [Apollo Development Guide](en/development/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)

# Deployment
* [Quick Start](en/deployment/quick-start)
* [Distributed Deployment Guide](en/deployment/distributed-deployment-guide)

# Release Notes
* [Releases](https://github.com/apolloconfig/apollo/releases)

# FAQ
* [FAQ](en/faq/faq)
* [Common Issues in Deployment & Development Phase](en/faq/common-issues-in-deployment-and-development-phase)

# Presentation
* [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420)
* [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf)
Expand All @@ -106,10 +75,5 @@ Demo Environment:
* [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo)
* [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ)

# Community
* [Apollo Team](en/community/team)
* [Community Governance](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md)
* [Contributing Guide](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md)

# License
The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE).
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
Loading
Loading