docs: Optimize search and logo click, Update image links, navbar and …

…sidebar links (#4061) * docs: Optimize search and logo click * docs: Update image links, navbar and sidebar links * docs: Update other links
apolloconfig · Oct 27, 2021 · 24be3c2 · 24be3c2
1 parent fb135bb
commit 24be3c2
Show file tree

Hide file tree

Showing 30 changed files with 600 additions and 563 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 ## Contributing to apollo
 
-Apollo is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.
+Apollo is released under the non-restrictive Apache 2.0 license, and follows a very standard GitHub development process, using GitHub tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.
 
 ### Sign the Contributor License Agreement
 

diff --git a/README.md b/README.md
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="30%">
+<img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="30%">
 
 > A reliable configuration management system
 

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="40%">
+<img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="40%">
 
 # Introduction
 
@@ -82,15 +82,15 @@ Demo Environment:
 # Development
 * [Apollo Development Guide](zh/development/apollo-development-guide)
 * 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)
+    * [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](zh/deployment/quick-start)
 * [Distributed Deployment Guide](zh/deployment/distributed-deployment-guide)
 
 # Release Notes
-* [Releases](https://github.com/ctripcorp/apollo/releases)
+* [Releases](https://github.com/apolloconfig/apollo/releases)
 
 # FAQ
 * [FAQ](zh/faq/faq)
@@ -108,8 +108,8 @@ Demo Environment:
 
 # Community
   * [Apollo Team](en/community/team)
-  * [Community Governance](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)
-  * [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md)
+  * [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/ctripcorp/apollo/blob/master/LICENSE).
+The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE).
diff --git a/docs/en/_navbar.md b/docs/en/_navbar.md
@@ -1,7 +1,7 @@
 - Community
   - [Team](en/community/team.md)
-  - [Community Governance](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)
-  - [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md)
+  - [Community Governance](en/governance.md)
+  - [Contributing Guide](en/contributing.md)
   - [Acknowledgements](en/community/thank-you.md)
 
 - Translations

diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md
@@ -16,8 +16,8 @@
 - 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)
+    - [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)
@@ -39,11 +39,11 @@
   - [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)
+   - [Release History](https://github.com/apolloconfig/apollo/releases)
    - [Apollo Benchmark](en/misc/apollo-benchmark.md)
 
 - Community
   - [Team](en/community/team.md)
-  - [Community Governance](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)
-  - [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md)
+  - [Community Governance](en/governance.md)
+  - [Contributing Guide](en/contributing.md)
   - [Acknowledgements](en/community/thank-you.md)
diff --git a/docs/en/community/team.md b/docs/en/community/team.md
@@ -2,23 +2,23 @@
 
 The Apollo team is comprised of Members and Contributors. Members have direct access to the source of Apollo project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. All contributions to Apollo are greatly appreciated, whether for trivial cleanups, big new features or other material rewards.
 
-For more information about the community governance model, please refer [GOVERNANCE.md](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md).
+For more information about the community governance model, please refer [GOVERNANCE.md](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md).
 
 ## Members
 
 Members include Project Management Committee members and committers. The list is in alphabet order.
 
 ### Project Management Committee
 
-| Github ID  | Name       | Organization |
+| GitHub ID  | Name       | Organization |
 | ---------- | ---------- | ------------ |
 | JaredTan95 | Jared Tan  | DaoCloud     |
 | kezhenxu94 | Zhenxu Ke  | Tetrate      |
 | nobodyiam  | Jason Song | Ant Group    |
 | zouyx      | Joe Zou    | Shein        |
 
 ### Committer
-| Github ID   | Name          | Organization |
+| GitHub ID   | Name          | Organization |
 | ----------- | ------------- | ------------ |
 | Anilople    | Xiaoquan Wang | Some Bank    |
 | Accelerater | Zhuohao Li    | Daocloud     |
@@ -38,4 +38,4 @@ Members include Project Management Committee members and committers. The list is
 
 ## Becoming a Committer
 
-Please refer [How to become a Committer](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md#how-to-become-a-committer).
+Please refer [How to become a Committer](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md#how-to-become-a-committer).
diff --git a/docs/index.html b/docs/index.html
@@ -67,6 +67,15 @@
         '/en/.*/_navbar.md': '/en/_navbar.md',
         '/zh/(.*)': 'zh/$1',
         '/en/(.*)': 'en/$1',
+        '.*?/governance':
+                'https://raw.githubusercontent.com/apolloconfig/apollo/master/GOVERNANCE.md',
+        '.*?/contributing':
+                'https://raw.githubusercontent.com/apolloconfig/apollo/master/CONTRIBUTING.md',
+      },
+      nameLink: {
+        '/zh/': '#/zh/',
+        '/en/': '#/en/',
+        '/': '#/',
       },
       auto2top: true,
       // Only coverpage is loaded when visiting the home page.
@@ -78,7 +87,7 @@
       maxLevel: 6,
       subMaxLevel: 5,
       name: 'Apollo',
-      repo: 'https://github.com/ctripcorp/apollo/',
+      repo: 'https://github.com/apolloconfig/apollo/',
       search: {
         noData: {
           '/zh/': '没有结果!',
@@ -91,6 +100,7 @@
           '/en/': 'Search',
           '/': '搜索',
         },
+        pathNamespaces: ['/zh', '/en']
       },
       // click to copy.
       copyCode: {
@@ -136,7 +146,7 @@
                 .replace('raw.githubusercontent.com', 'github.com')
                 .replace(/\/master/, '/blob/master')
             } else {
-              url = 'https://github.com/ctripcorp/apollo/blob/master/docs/' + vm.route.file
+              url = 'https://github.com/apolloconfig/apollo/blob/master/docs/' + vm.route.file
             }
             var editHtml = '[:memo: Edit Document](' + url + ')\n\n'
 
@@ -162,7 +172,7 @@
   <!-- Medium's image zoom -->
   <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
   <!-- Add a simple Click to copy button to all preformatted code blocks to effortlessly allow users to copy example code from your docs -->
-  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code@2.1.1/dist/docsify-copy-code.min.js"></script>
   <!-- docsify-pagination -->
   <script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
 

diff --git a/docs/zh/README.md b/docs/zh/README.md
@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="40%">
+<img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="40%">
 
 # Introduction
 
@@ -15,13 +15,14 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境，
 本地快速部署请参见[Quick Start](zh/deployment/quick-start)
 
 演示环境（Demo）:
+
 - [http://106.54.227.205](http://106.54.227.205/)
 - 账号/密码:apollo/admin
 
-> 如访问github速度缓慢，可以访问[gitee镜像](https://gitee.com/nobodyiam/apollo)，不定期同步
+> 如访问GitHub速度缓慢，可以访问[Gitee镜像](https://gitee.com/apolloconfig/apollo)，不定期同步
 
 # Screenshots
-![配置界面](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-home-screenshot.jpg)
+![配置界面](https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/doc/images/apollo-home-screenshot.jpg)
 
 # Features
 * **统一管理不同环境、不同集群的配置**
@@ -83,8 +84,8 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境，
 # Development
   - [Apollo开发指南](zh/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)
+    - [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/development/portal-how-to-implement-user-login-function.md)
   - [Portal接入邮件服务](zh/development/portal-how-to-enable-email-service.md)
   - [Portal启用webhook通知](zh/development/portal-how-to-enable-webhook-notification.md)
@@ -96,7 +97,7 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境，
   - [分布式部署指南](zh/deployment/distributed-deployment-guide.md)
 
 # Release Notes
-  * [版本发布历史](https://github.com/ctripcorp/apollo/releases)
+  * [版本发布历史](https://github.com/apolloconfig/apollo/releases)
 
 # FAQ
   * [常见问题回答](zh/faq/faq.md)
@@ -123,19 +124,19 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境，
   </thead>
   <tbody>
     <tr>
-      <td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-2.png" alt="tech-support-qq-2"></td>
-      <td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-5.png" alt="tech-support-qq-5"></td>
-      <td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-4.png" alt="tech-support-qq-4"></td>
-      <td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-3.png" alt="tech-support-qq-3"></td>
-      <td><img src="https://raw.githubusercontent.com/ctripcorp/apollo-community/master/images/tech-support/tech-support-qq-1.png" alt="tech-support-qq-1"></td>
+      <td><img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo-community@master/images/tech-support/tech-support-qq-2.png" alt="tech-support-qq-2"></td>
+      <td><img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo-community@master/images/tech-support/tech-support-qq-5.png" alt="tech-support-qq-5"></td>
+      <td><img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo-community@master/images/tech-support/tech-support-qq-4.png" alt="tech-support-qq-4"></td>
+      <td><img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo-community@master/images/tech-support/tech-support-qq-3.png" alt="tech-support-qq-3"></td>
+      <td><img src="https://cdn.jsdelivr.net/gh/apolloconfig/apollo-community@master/images/tech-support/tech-support-qq-1.png" alt="tech-support-qq-1"></td>
     </tr>
   </tbody>
 </table>
 
 # 社区
   * [团队](zh/community/team)
-  * [社区治理](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)
-  * [贡献指南](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md)
+  * [社区治理](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/ctripcorp/apollo/blob/master/LICENSE).
+The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE).
diff --git a/docs/zh/_navbar.md b/docs/zh/_navbar.md
@@ -1,7 +1,7 @@
 - 社区
   - [团队](zh/community/team.md)
-  - [社区治理](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)
-  - [贡献指南](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md)
+  - [社区治理](zh/governance.md)
+  - [贡献指南](zh/contributing.md)
   - [致谢](zh/community/thank-you.md)
 
 - Translations

diff --git a/docs/zh/_sidebar.md b/docs/zh/_sidebar.md
@@ -15,8 +15,8 @@
 - 开发文档
   - [Apollo开发指南](zh/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)
+    - [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/development/portal-how-to-implement-user-login-function.md)
   - [Portal接入邮件服务](zh/development/portal-how-to-enable-email-service.md)
   - [Portal 共享 session](zh/development/portal-how-to-enable-session-store.md)
@@ -39,12 +39,12 @@
   - [部署&开发遇到的常见问题](zh/faq/common-issues-in-deployment-and-development-phase.md)
 
 - 其它
-   - [版本历史](https://github.com/ctripcorp/apollo/releases)
+   - [版本历史](https://github.com/apolloconfig/apollo/releases)
    - [Apollo性能测试报告](zh/misc/apollo-benchmark.md)
 
 - 社区
   - [团队](zh/community/team.md)
-  - [社区治理](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)
-  - [贡献指南](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md)
+  - [社区治理](zh/governance.md)
+  - [贡献指南](zh/contributing.md)
   - [致谢](zh/community/thank-you.md)
 
diff --git a/docs/zh/community/team.md b/docs/zh/community/team.md
@@ -2,23 +2,23 @@
 
 Apollo 团队由 Member 和 Contributor 组成。Member 可以直接访问 Apollo 项目的源代码并基于代码库积极演进。Contributor 通过向 Member 提交补丁和建议来改善项目，项目的贡献者数量是没有限制的。无论是进行小规模的清理，提交新的功能或其它形式的贡献，都将受到极大的赞赏。
 
-有关社区治理模型的更多信息，请参考[GOVERNANCE.md](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md)。
+有关社区治理模型的更多信息，请参考[GOVERNANCE.md](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md)。
 
 ## Member
 
 Member 包括 PMC 成员和 Committer，该列表按字母顺序排列。
 
 ### Project Management Committee(PMC)
 
-| Github ID  | Name       | Organization |
+| GitHub ID  | Name       | Organization |
 | ---------- | ---------- | ------------ |
 | JaredTan95 | Jared Tan  | DaoCloud     |
 | kezhenxu94 | Zhenxu Ke  | Tetrate      |
 | nobodyiam  | Jason Song | Ant Group    |
 | zouyx      | Joe Zou    | Shein        |
 
 ### Committer
-| Github ID   | Name          | Organization |
+| GitHub ID   | Name          | Organization |
 | ----------- | ------------- | ------------ |
 | Anilople    | Xiaoquan Wang | Some Bank    |
 | Accelerater | Zhuohao Li    | Daocloud     |
@@ -32,12 +32,12 @@ Member 包括 PMC 成员和 Committer，该列表按字母顺序排列。
 
 ### Apollo 主仓库
 
-<a href="https://github.com/ctripcorp/apollo/graphs/contributors"><img src="https://opencollective.com/apollo/contributors.svg?width=880&button=false" /></a>
+<a href="https://github.com/apolloconfig/apollo/graphs/contributors"><img src="https://opencollective.com/apollo/contributors.svg?width=880&button=false" /></a>
 
 ### apollo.net
 
 <a href="https://github.com/ctripcorp/apollo.net/graphs/contributors"><img src="https://opencollective.com/apollonet/contributors.svg?width=880&button=false" /></a>
 
 ## **如何成为提交者**
 
-请参考 [How to become a Committer](https://github.com/ctripcorp/apollo/blob/master/GOVERNANCE.md#how-to-become-a-committer).
+请参考 [How to become a Committer](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md#how-to-become-a-committer).
diff --git a/docs/zh/deployment/deployment-architecture.md b/docs/zh/deployment/deployment-architecture.md
@@ -910,7 +910,7 @@ ConfigDB和PortalDB在图中没有放入idc1或者idc2，需要自行选用合
 ## 4.1 ctrip
 
 以ctrip为例，我们的部署策略如下：
-![Deployment](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-deployment.png)
+![Deployment](https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/doc/images/apollo-deployment.png)
 
 * Portal部署在生产环境的机房，通过它来直接管理FAT、UAT、PRO等环境的配置
 * Meta Server、Config Service和Admin Service在每个环境都单独部署，使用独立的数据库
@@ -921,4 +921,4 @@ ConfigDB和PortalDB在图中没有放入idc1或者idc2，需要自行选用合
 
 [@lyliyongblue](https://github.com/lyliyongblue) 贡献的样例部署图（建议右键新窗口打开看大图）：
 
-![Deployment](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/lyliyongblue-apollo-deployment.png)
+![Deployment](https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/doc/images/lyliyongblue-apollo-deployment.png)