Skip to content

Commit

Permalink
fix: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nisiyong committed Jan 31, 2024
1 parent b001d2a commit aea6f48
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 261 deletions.
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/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/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)

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

* [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/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)
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/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)
* [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/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](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).
2 changes: 1 addition & 1 deletion docs/en/client/other-language-client-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ At present, Apollo team only provides Java and .Net clients due to manpower cons

Also, if any team/individual is interested, they are welcome to help us to implement the client in other languages, please contact @nobodyiam and @lepdou for details.

>Note: There are already clients for Go, Python, NodeJS, PHP, C++ contributed by enthusiastic users, for more information you can refer to [Go, Python, NodeJS, PHP and other clients usage guide](en/client/third-party-sdks-user-guide)
>Note: There are already clients for Go, Python, NodeJS, PHP, C++ contributed by enthusiastic users, for more information you can refer to "SDK Guide"
## 1.1 Application access to Apollo

Expand Down
151 changes: 0 additions & 151 deletions docs/en/client/third-party-sdks-user-guide.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/zh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,45 +64,9 @@ Java客户端不依赖任何框架,能够运行于所有Java运行时环境,
* 目前唯一的外部依赖是MySQL,所以部署非常简单,只要安装好Java和MySQL就可以让Apollo跑起来
* Apollo还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数

# Usage
1. [应用接入指南](zh/portal/apollo-user-guide)
2. [Java客户端使用指南](zh/client/java-sdk-user-guide)
3. [.Net客户端使用指南](zh/client/java-sdk-user-guide)
4. [Go、Python、NodeJS、PHP等客户端使用指南](zh/client/third-party-sdks-user-guide)
5. [其它语言客户端接入指南](zh/client/other-language-client-user-guide)
6. [Apollo开放平台接入指南](zh/portal/apollo-open-api-platform)
7. [Apollo使用场景和示例代码](https://github.com/ctripcorp/apollo-use-cases)
8. [Apollo实践案例](zh/portal/apollo-user-practices)
9. [Apollo安全相关最佳实践](zh/portal/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3)

# Design
- [Apollo配置中心设计](zh/design/apollo-design.md)
- [Apollo配置中心介绍](zh/design/apollo-introduction.md)
- [Apollo核心概念之“Namespace”](zh/design/apollo-core-concept-namespace.md)
- [Apollo源码解析](http://www.iocoder.cn/categories/Apollo/)(据说Apollo非常适合作为初学者第一个通读源码学习的分布式中间件产品)

# Development
- [Apollo开发指南](zh/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实现用户登录功能](zh/extension/portal-how-to-implement-user-login-function.md)
- [Portal接入邮件服务](zh/extension/portal-how-to-enable-email-service.md)
- [Portal启用webhook通知](zh/extension/portal-how-to-enable-webhook-notification.md)
- [Apollo 版本发布操作手册](zh/contribution/apollo-release-guide.md)

# Deployment
- [Quick Start](zh/deployment/quick-start.md)
- [Docker方式部署Quick Start](zh/deployment/quick-start-docker.md)
- [分布式部署指南](zh/deployment/distributed-deployment-guide.md)

# Release Notes
* [版本发布历史](https://github.com/apolloconfig/apollo/releases)

# FAQ
* [常见问题回答](zh/faq/faq.md)
* [部署&开发遇到的常见问题](zh/faq/common-issues-in-deployment-and-development-phase.md)

# Presentation
* [开源配置中心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 Down Expand Up @@ -133,10 +97,5 @@ Java客户端不依赖任何框架,能够运行于所有Java运行时环境,
</tbody>
</table>

# 社区
* [团队](zh/community/team)
* [社区治理](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md)
* [贡献指南](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).
2 changes: 1 addition & 1 deletion docs/zh/client/other-language-client-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

另外,如果有团队/个人有兴趣的话,也欢迎帮助我们来实现其它语言的客户端,具体细节可以联系@nobodyiam@lepdou

>注:目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端,更多信息可以参考[Go、Python、NodeJS、PHP等客户端使用指南](zh/client/third-party-sdks-user-guide)
>注:目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端,更多信息可以参考"客户端指南"
## 1.1 应用接入Apollo
首先需要在Apollo中接入你的应用,具体步骤可以参考[应用接入文档](zh/portal/apollo-user-guide?id=一、普通应用接入指南)
Expand Down

0 comments on commit aea6f48

Please sign in to comment.