diff --git a/README.md b/README.md index fa7d5601e80..87d6bfe97e0 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Demo Environment: 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/usage/third-party-sdks-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) diff --git a/docs/en/README.md b/docs/en/README.md index e229c785b7c..1cd03b0e016 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -66,8 +66,8 @@ Demo Environment: 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/usage/third-party-sdks-user-guide) -5. [Other Language Client User Guide](en/usage/other-language-client-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) diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md index db2da4a156c..66c9b5ba1cf 100644 --- a/docs/en/_sidebar.md +++ b/docs/en/_sidebar.md @@ -30,7 +30,7 @@ - [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/usage/other-language-client-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) diff --git a/docs/en/client/other-language-client-user-guide.md b/docs/en/client/other-language-client-user-guide.md index 9ce5bd5cf52..1de4c0b50bf 100644 --- a/docs/en/client/other-language-client-user-guide.md +++ b/docs/en/client/other-language-client-user-guide.md @@ -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/usage/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 [Go, Python, NodeJS, PHP and other clients usage guide](en/client/third-party-sdks-user-guide) ## 1.1 Application access to Apollo @@ -12,7 +12,7 @@ First you need to access your application in Apollo, you can refer to [applicati This interface will fetch the configuration from the cache and is suitable for more frequent configuration pull requests, such as a simple polling of the configuration every 30 seconds. -Since the cache has a delay of at most one second, if you need to work with configuration push notifications to achieve real-time configuration updates, please refer to [1.3 Reading configuration from Apollo via Http interface without cache](en/usage/other-language-client-user-guide?id=_13-reading-configuration-from-apollo-via-http-interface-without-cache). +Since the cache has a delay of at most one second, if you need to work with configuration push notifications to achieve real-time configuration updates, please refer to [1.3 Reading configuration from Apollo via Http interface without cache](en/client/other-language-client-user-guide?id=_13-reading-configuration-from-apollo-via-http-interface-without-cache). ### 1.2.1 Http interface description @@ -129,7 +129,7 @@ Once you have the notifications Map, you can request services. Here we describe If the notificationId is found to be older than the server, the latest notificationId of the corresponding namespace, HttpStatus 200, will be returned directly. 5. After the client gets the server side return, determine the return HttpStatus . 6. If the returned HttpStatus is 304, that the configuration has not changed, re-execute step 1. -7. If the returned HttpStauts is 200, the configuration has changed, for the change of namespace to pull configuration from the server again, see [1.3 Read configuration from Apollo through the Http interface without cache](en/usage/other-language-client-user-guide?id=_13-reading-configuration-from-apollo-via-http-interface-without-cache). Also update the notificationId in the notifications map. re-run step 1. +7. If the returned HttpStauts is 200, the configuration has changed, for the change of namespace to pull configuration from the server again, see [1.3 Read configuration from Apollo through the Http interface without cache](en/client/other-language-client-user-guide?id=_13-reading-configuration-from-apollo-via-http-interface-without-cache). Also update the notificationId in the notifications map. re-run step 1. ### 1.4.2 Http interface description diff --git a/docs/en/design/apollo-core-concept-namespace.md b/docs/en/design/apollo-core-concept-namespace.md index 9a5da1e0ceb..44ebafd7f26 100644 --- a/docs/en/design/apollo-core-concept-namespace.md +++ b/docs/en/design/apollo-core-concept-namespace.md @@ -22,7 +22,7 @@ When Apollo creates a project, it creates an `application` namespace by default. Configuration files come in various formats such as properties, xml, yml, yaml, json, etc. Similarly Namespace also has these formats. In the Portal UI, you can see that the Namespace for `application` has a `properties` tag, indicating that `application` is in properties format. ->Note1: For the namespace in non-properties format, you need to call `ConfigService.getConfigFile(String namespace, ConfigFileFormat configFileFormat)` to get it when you use the client, if you use the [Http interface direct call](en/usage/other-language-client-user-guide), the corresponding namespace parameter needs to be passed in the namespace name plus the suffix name, such as datasources.json. +>Note1: For the namespace in non-properties format, you need to call `ConfigService.getConfigFile(String namespace, ConfigFileFormat configFileFormat)` to get it when you use the client, if you use the [Http interface direct call](en/client/other-language-client-user-guide), the corresponding namespace parameter needs to be passed in the namespace name plus the suffix name, such as datasources.json. >Note 2: apollo-client version 1.3.0 has better support for yaml/yml, which is consistent with the properties format: `Config config = ConfigService.getConfig("application.yml");`, Spring's The Spring injection is also consistent with properties. diff --git a/docs/en/portal/apollo-user-guide.md b/docs/en/portal/apollo-user-guide.md index e730b1e6798..cb84a8e6faa 100644 --- a/docs/en/portal/apollo-user-guide.md +++ b/docs/en/portal/apollo-user-guide.md @@ -123,7 +123,7 @@ After the configuration is successfully published, the application can read the Apollo currently provides a Java client. For more information, please click [Java Client Usage Documentation](en/client/java-sdk-user-guide). -If the application uses other languages, you can also get the configuration by directly accessing the Http interface, for details, please refer to [other-language-client-access-guide](en/usage/other-language-client-user-guide) +If the application uses other languages, you can also get the configuration by directly accessing the Http interface, for details, please refer to [other-language-client-access-guide](en/client/other-language-client-user-guide) ## 1.6 Rollback published configuration @@ -219,7 +219,7 @@ Once the configuration is successfully published, the application can read the c Apollo currently provides a Java client. For more information, click [Java Client Usage Documentation](en/client/java-sdk-user-guide). -If the application uses other languages, you can also get the configuration by directly accessing the Http interface, for details, please refer to [other-language-client-access-guide](en/usage/other-language-client-user-guide) +If the application uses other languages, you can also get the configuration by directly accessing the Http interface, for details, please refer to [other-language-client-access-guide](en/client/other-language-client-user-guide) For reading the configuration of public components, you can refer to the "Getting the Configuration of Public Namespace" section in the above document. @@ -513,4 +513,4 @@ In addition to user permissions, system access also needs to be considered in te 1. `apollo-configservice` and `apollo-adminservice` are designed based on the intranet trusted network, so for security reasons, `apollo-configservice` and `apollo-adminservice` are prohibited from being exposed directly to the public network 2. For sensitive configurations, consider enabling [access secret key](en/portal/apollo-user-guide?id=_62-configuring-access-keys) so that only authenticated clients can access sensitive configurations 3. version 1.7.1 and above can consider enabling [access control](en/deployment/distributed-deployment-guide?id=_326-admin-servicesaccesscontrolenabled-configure-whether-apollo-adminservice-has-access-control-enabled) for `apollo-adminservice`, so that only [controlled](en/deployment/distributed-deployment-guide?id=_3112-admin-servicesaccesstokens-set-the-access-token-required-by-apollo-portal-to-access-the-apollo-adminservice-for-each-environment) `apollo-portal` can access the corresponding interface to enhance security -4. version 2.1.0 and above can consider enabling [access control](en/deployment/distributed-deployment-guide?id=_329-apolloeurekaserversecurityenabled-configure-whether-to-enable-eureka-login-authentication) for `eureka`, so that only controlled `apollo-configservice` and `apollo-adminservice` can be registered to `eureka` to enhance security \ No newline at end of file +4. version 2.1.0 and above can consider enabling [access control](en/deployment/distributed-deployment-guide?id=_329-apolloeurekaserversecurityenabled-configure-whether-to-enable-eureka-login-authentication) for `eureka`, so that only controlled `apollo-configservice` and `apollo-adminservice` can be registered to `eureka` to enhance security diff --git a/docs/zh/README.md b/docs/zh/README.md index eeead44bd70..31b6d254154 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -68,7 +68,7 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境， 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/usage/third-party-sdks-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) diff --git a/docs/zh/_sidebar.md b/docs/zh/_sidebar.md index a30ec25a47e..26f563e090f 100644 --- a/docs/zh/_sidebar.md +++ b/docs/zh/_sidebar.md @@ -25,7 +25,7 @@ - [Java 客户端使用指南](zh/client/java-sdk-user-guide.md) - [.Net 客户端使用指南](zh/client/dotnet-sdk-user-guide.md) - [Golang 客户端使用指南](zh/client/golang-sdks-user-guide.md) - - [Python 户端使用指南](zh/client/python-sdks-user-guide.md) + - [Python 客户端使用指南](zh/client/python-sdks-user-guide.md) - [NodeJS 客户端使用指南](zh/client/nodejs-sdks-user-guide.md) - [PHP 客户端使用指南](zh/client/php-sdks-user-guide.md) - [C 客户端使用指南](zh/client/c-sdks-user-guide.md) diff --git a/docs/zh/client/other-language-client-user-guide.md b/docs/zh/client/other-language-client-user-guide.md index ad095add153..a3a555af5ce 100644 --- a/docs/zh/client/other-language-client-user-guide.md +++ b/docs/zh/client/other-language-client-user-guide.md @@ -2,7 +2,7 @@ 另外，如果有团队/个人有兴趣的话，也欢迎帮助我们来实现其它语言的客户端，具体细节可以联系@nobodyiam和@lepdou。 ->注：目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端，更多信息可以参考[Go、Python、NodeJS、PHP等客户端使用指南](zh/usage/third-party-sdks-user-guide) +>注：目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端，更多信息可以参考[Go、Python、NodeJS、PHP等客户端使用指南](zh/client/third-party-sdks-user-guide) ## 1.1 应用接入Apollo 首先需要在Apollo中接入你的应用，具体步骤可以参考[应用接入文档](zh/portal/apollo-user-guide?id=一、普通应用接入指南)。