From 420168646be4717e8ddd70f4f295f467ee371dba Mon Sep 17 00:00:00 2001
From: xysun <sunxiangyu@espressif.com>
Date: Sun, 28 Apr 2024 19:16:40 +0800
Subject: [PATCH] doc: Update get_started link

---
 .gitlab-ci.yml | 27 +++++++++++++++++++++++++--
 README.md      |  2 +-
 README_cn.md   |  4 ++--
 3 files changed, 28 insertions(+), 5 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index ce647543..02950945 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -4,9 +4,29 @@ stages:
 
 variables:
   # Versioned esp-idf-doc env image to use for all document building jobs
-  ESP_DOCS_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-2"
+  ESP_DOCS_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0" 
   ESP_DOCS_PATH: "$CI_PROJECT_DIR"
 
+.if-protected: &if-protected
+  if: '($CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_BRANCH =~ /^release\/v/ || $CI_COMMIT_TAG =~ /^v\d+\.\d+(\.\d+)?($|-)/)'
+
+.if-dev-push: &if-dev-push
+  if: '$CI_COMMIT_REF_NAME != "master" && $CI_COMMIT_BRANCH !~ /^release\/v/ && $CI_COMMIT_TAG !~ /^v\d+\.\d+(\.\d+)?($|-)/ && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "merge_request_event")'
+
+.if-label-build: &if-label-build
+  if: '$CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*build(?:,[^,\n\r]+)*$/i'
+
+
+.patterns-build_docs: &patterns-build_docs
+  - "docs/**/*"
+
+.rules:build_docs:docs:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-dev-push
+      changes: *patterns-build_docs
+
 .build_template:
   stage: build
   image: $ESP_DOCS_ENV_IMAGE
@@ -14,6 +34,7 @@ variables:
 build_esp_dl_html:
   extends:
     - .build_template
+    - .rules:build_docs:docs
   variables:
     DOCS_DIR: $CI_PROJECT_DIR/docs
   artifacts:
@@ -36,6 +57,7 @@ build_esp_dl_html:
 build_esp_dl_pdf:
   extends:
     - .build_template
+    - .rules:build_docs:docs
   variables:
     DOCS_DIR: $CI_PROJECT_DIR/docs
   artifacts:
@@ -72,6 +94,7 @@ build_esp_dl_pdf:
 deploy_docs_preview:
   extends:
     - .deploy_docs_template
+    - .rules:build_docs:docs
   variables:
     TYPE: "preview"
     DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
@@ -95,4 +118,4 @@ deploy_docs_production:
     DOCS_DEPLOY_SERVER: "$DOCS_PROD_SERVER"
     DOCS_DEPLOY_SERVER_USER: "$DOCS_PROD_SERVER_USER"
     DOCS_DEPLOY_PATH: "$DOCS_PROD_PATH"
-    DOCS_DEPLOY_URL_BASE: "https://docs.espressif.com/projects/esp-dl"
\ No newline at end of file
+    DOCS_DEPLOY_URL_BASE: "https://docs.espressif.com/projects/esp-dl"
diff --git a/README.md b/README.md
index f0be59f5..458be3bc 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ As ESP-DL does not need any peripherals, it can be used as a component of some p
 
 ## Get Started with ESP-DL
 
-For setup instructions to get started with ESP-DL, please read [Get Started](./docs/en/get_started.md).
+For setup instructions to get started with ESP-DL, please read [Get Started](https://docs.espressif.com/projects/esp-dl/en/latest/esp32s3/get-started.html).
 
 > Please use [ESP-IDF](https://github.com/espressif/esp-idf) `release/v5.0` or above.
 
diff --git a/README_cn.md b/README_cn.md
index 677e916e..30cbf29e 100644
--- a/README_cn.md
+++ b/README_cn.md
@@ -18,7 +18,7 @@ ESP-DL 无需借助任何外围设备，因此可作为一些项目的组件，
 
 ## 入门指南
 
-安装并入门 ESP-DL，请参考[快速入门](./docs/en/get_started.md)。
+安装并入门 ESP-DL，请参考[快速入门](https://docs.espressif.com/projects/esp-dl/en/latest/esp32s3/get-started.html)。
 > 请使用 ESP-IDF 5.0 或以上版本[最新版本](https://github.com/espressif/esp-idf/tree/release/v5.0)。
 
 
@@ -43,4 +43,4 @@ ESP-DL 在 [模型库](./include/model_zoo) 中提供了一些模型的 API，
 
 ## 反馈
 
-如果您在使用中发现了错误或者需要新的功能，请提交相关 [issue](https://github.com/espressif/esp-dl/issues)，我们会优先实现最受期待的功能。
\ No newline at end of file
+如果您在使用中发现了错误或者需要新的功能，请提交相关 [issue](https://github.com/espressif/esp-dl/issues)，我们会优先实现最受期待的功能。