Merge branch 'feature/add_cn_to_idf_github_assets' into 'master'

feat(tools): Add dl.espressif.cn IDF_GITHUB_ASSET to documentation Closes IDF-8065 See merge request espressif/esp-idf!25613
TrackliDev · Sep 5, 2023 · f28daac · f28daac
2 parents 5b001f9 + 2333498
commit f28daac
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/docs/en/api-guides/tools/idf-tools.rst b/docs/en/api-guides/tools/idf-tools.rst
@@ -52,7 +52,7 @@ Most of the tools downloaded by the tools installer are GitHub Release Assets, w
 
 If GitHub downloads are inaccessible or slow to access, a GitHub assets mirror can be configured.
 
-To use Espressif's download server, set the environment variable ``IDF_GITHUB_ASSETS`` to ``dl.espressif.com/github_assets``. When the install process is downloading a tool from ``github.com``, the URL will be rewritten to use this server instead.
+To use Espressif's download server, set the environment variable ``IDF_GITHUB_ASSETS`` to ``dl.espressif.com/github_assets``, or ``dl.espressif.cn/github_assets`` for faster download in China. When the install process is downloading a tool from ``github.com``, the URL will be rewritten to use this server instead.
 
 Any mirror server can be used provided the URL matches the ``github.com`` download URL format. For any GitHub asset URL that the install process downloads, it will replace ``https://github.com`` with ``https://${IDF_GITHUB_ASSETS}``.
 

diff --git a/docs/en/get-started/linux-macos-setup.rst b/docs/en/get-started/linux-macos-setup.rst
@@ -204,6 +204,15 @@ To prefer the Espressif download server when installing tools, use the following
     export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
     ./install.sh
 
+.. note::
+    For users in China, we recommend using our download server located in China for faster download speed.
+
+    .. code-block:: bash
+
+        cd ~/esp/esp-idf
+        export IDF_GITHUB_ASSETS="dl.espressif.cn/github_assets"
+        ./install.sh
+
 Customizing the Tools Installation Path
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/zh_CN/api-guides/tools/idf-tools.rst b/docs/zh_CN/api-guides/tools/idf-tools.rst
@@ -52,7 +52,7 @@ GitHub 资源镜像
 
 如果无法访问 GitHub 下载或访问速度较慢，可以配置一个 GitHub 资源镜像。
 
-要使用乐鑫下载服务器，请将环境变量  ``IDF_GITHUB_ASSETS`` 设置为 ``dl.espressif.com/github_assets``。安装过程中，当从 ``github.com`` 下载工具时，URL 将重写为使用乐鑫下载服务器。
+要使用乐鑫下载服务器，请将环境变量  ``IDF_GITHUB_ASSETS`` 设置为 ``dl.espressif.com/github_assets``，在国内下载时，也可设置为 ``dl.espressif.cn/github_assets`` 加快下载速度。安装过程中，当从 ``github.com`` 下载工具时，URL 将重写为使用乐鑫下载服务器。
 
 只要 URL 与 ``github.com`` 的下载 URL 格式匹配，任何镜像服务器均可使用，安装过程中下载的 GitHub 资源 URL 将把 ``https://github.com`` 替换为 ``https://${IDF_GITHUB_ASSETS}``。
 

diff --git a/docs/zh_CN/get-started/linux-macos-setup.rst b/docs/zh_CN/get-started/linux-macos-setup.rst
@@ -204,6 +204,15 @@ ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具，
     export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
     ./install.sh
 
+.. note::
+    推荐国内用户使用国内的下载服务器，以加快下载速度。
+
+    .. code-block:: bash
+
+        cd ~/esp/esp-idf
+        export IDF_GITHUB_ASSETS="dl.espressif.cn/github_assets"
+        ./install.sh
+
 自定义工具安装路径
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~