Support release 6.1 (#254)

* add release-6.1 support * rm appdev * temp modify siteUrl for algolia index build * Revert "do remember to revert (#261)" This reverts commit 3fec963. * revert 7bc676c * update for release 6.1
pingcap · Jun 13, 2022 · e612ad0 · e612ad0
1 parent 75baaaa
commit e612ad0
Show file tree

Hide file tree

Showing 21 changed files with 57 additions and 257 deletions.
diff --git a/.github/workflows/update.yml b/.github/workflows/update.yml
@@ -64,9 +64,9 @@ jobs:
         id: docs-cache
         with:
           path: markdown-pages
-          key: ${{ runner.os }}-docs-cache-202206091-${{ github.event.client_payload.sha }} # You can inc the version number to force cache rebuild
+          key: ${{ runner.os }}-docs-cache-20220613-${{ github.event.client_payload.sha }} # You can inc the version number to force cache rebuild
           restore-keys: |
-            ${{ runner.os }}-docs-cache-202206091-
+            ${{ runner.os }}-docs-cache-20220613-
 
       - name: Check file exists
         id: check-file-exists
@@ -89,7 +89,6 @@ jobs:
           yarn download:tidb-operator:all
           yarn filter:tidb-cloud:en --ref release-5.4
           yarn filter:tidb-cloud:ja --ref release-5.4
-          yarn download:appdev:all
 
       - name: Download specific docs
         if: github.event.client_payload.download_type == 'partial'

diff --git a/README.md b/README.md
@@ -32,12 +32,6 @@ Usually you have to download some docs before dev. We have pre-defined some comm
     "download:tidb-operator:all": "./scripts/download-tidb-operator.sh",
     "download:tidb-operator:en:all": "./scripts/download-tidb-operator-en.sh",
     "download:tidb-operator:zh:all": "./scripts/download-tidb-operator-zh.sh",
-    "download:dbaas": "pingcap-docs-download dl tidbcloud/dbaas-docs",
-    "download:dbaas:all": "./scripts/download-dbaas.sh",
-    "download:appdev": "pingcap-docs-download dl pingcap/docs-appdev",
-    "download:appdev:all": "./scripts/download-appdev.sh",
-    "download:appdev:en:all": "./scripts/download-appdev-en.sh",
-    "download:appdev:zh:all": "./scripts/download-appdev-zh.sh",
     "clean:docs": "pingcap-docs-download cl",
     "sync": "pingcap-docs-download sync"
   }

diff --git a/docs.json b/docs.json
@@ -1,12 +1,13 @@
 {
   "docs": {
     "tidb": {
-      "stable": "release-5.4",
+      "stable": "release-6.1",
       "languages": {
         "en": {
           "repo": "pingcap/docs",
           "versions": [
             "master",
+            "release-6.1",
             "release-6.0",
             "release-5.4",
             "release-5.3",
@@ -23,6 +24,7 @@
           "repo": "pingcap/docs-cn",
           "versions": [
             "master",
+            "release-6.1",
             "release-6.0",
             "release-5.4",
             "release-5.3",
@@ -37,7 +39,7 @@
         },
         "ja": {
           "repo": "pingcap/docs",
-          "versions": ["release-5.4"]
+          "versions": ["release-6.1", "release-5.4"]
         }
       },
       "deprecated": ["v2.1", "v3.0", "v3.1"],
@@ -93,18 +95,6 @@
           "versions": ["master"]
         }
       }
-    },
-    "appdev": {
-      "languages": {
-        "en": {
-          "repo": "pingcap/docs-appdev",
-          "versions": ["master"]
-        },
-        "zh": {
-          "repo": "pingcap/docs-appdev",
-          "versions": ["master"]
-        }
-      }
     }
   },
   "ignore": [

diff --git a/gatsby/path.ts b/gatsby/path.ts
@@ -38,7 +38,7 @@ export function generateConfig(slug: string): {
   const name = rest[rest.length - 1]
 
   let filePath = rest.join('/') + '.md'
-  if (repo === Repo.dm || repo === Repo.operator || repo === Repo.appdev) {
+  if (repo === Repo.dm || repo === Repo.operator) {
     filePath = `${locale}/${filePath}`
   }
 
@@ -65,8 +65,6 @@ function branchToVersion(repo: Repo, branch: string) {
     }
     case Repo.dm:
       return branch.replace('release-', 'v')
-    case Repo.appdev:
-      return 'dev'
 
     case Repo.tidbcloud:
       return null

diff --git a/gatsby/utils.ts b/gatsby/utils.ts
@@ -37,7 +37,6 @@ export function renameVersionByDoc(doc: Repo, version: string) {
     case 'tidb':
     case 'tidb-data-migration':
     case 'tidb-in-kubernetes':
-    case 'appdev':
       return renameVersion(version, getStable(doc))
     case 'tidbcloud':
       return

diff --git a/package.json b/package.json
@@ -102,12 +102,6 @@
     "download:tidb-operator:all": "./scripts/download-tidb-operator.sh",
     "download:tidb-operator:en:all": "./scripts/download-tidb-operator-en.sh",
     "download:tidb-operator:zh:all": "./scripts/download-tidb-operator-zh.sh",
-    "download:dbaas": "pingcap-docs-download dl tidbcloud/dbaas-docs",
-    "download:dbaas:all": "./scripts/download-dbaas.sh",
-    "download:appdev": "pingcap-docs-download dl pingcap/docs-appdev",
-    "download:appdev:all": "./scripts/download-appdev.sh",
-    "download:appdev:en:all": "./scripts/download-appdev-en.sh",
-    "download:appdev:zh:all": "./scripts/download-appdev-zh.sh",
     "clean:docs": "pingcap-docs-download cl",
     "sync": "pingcap-docs-download sync",
     "prepare": "is-ci || husky install"

diff --git a/packages/download/download.ts b/packages/download/download.ts
@@ -41,8 +41,6 @@ function renameDoc(repo: string) {
       return 'tidb-data-migration'
     case 'pingcap/docs-tidb-operator':
       return 'tidb-in-kubernetes'
-    case 'pingcap/docs-appdev':
-      return 'appdev'
   }
 }
 
@@ -74,32 +72,6 @@ export function download(argv) {
       break
     case 'pingcap/docs-dm':
     case 'pingcap/docs-tidb-operator':
-    case 'pingcap/docs-appdev':
-      if (!path) {
-        sig.warn(
-          'For docs-dm/docs-tidb-operator/docs-appdev, you must provide en or zh path.'
-        )
-
-        return
-      }
-
-      const name = renameDoc(repo)
-
-      retrieveAllMDs(
-        {
-          repo,
-          path,
-          ref,
-        },
-        genDest(
-          repo,
-          path,
-          nPath.resolve(dest, `${path.split('/')[0]}/${name}/${ref}`)
-        ),
-        options
-      )
-
-      break
     case 'tidbcloud/dbaas-docs':
       retrieveAllMDs(
         {
@@ -142,34 +114,6 @@ export function sync(argv) {
       break
     case 'pingcap/docs-dm':
     case 'pingcap/docs-tidb-operator':
-    case 'pingcap/docs-appdev':
-      const name = renameDoc(repo)
-
-      handleSync(
-        {
-          repo,
-          ref,
-          base,
-          head,
-        },
-        nPath.resolve(dest, `en/${name}/${ref}`), // use en as a placeholder
-        options
-      )
-
-      break
-    case 'tidbcloud/dbaas-docs':
-      handleSync(
-        {
-          repo,
-          ref,
-          base,
-          head,
-        },
-        nPath.resolve(dest, `en/tidbcloud/${ref}`),
-        options
-      )
-
-      break
   }
 }
 

diff --git a/packages/download/index.js b/packages/download/index.js
@@ -48,8 +48,6 @@ function renameDoc(repo) {
       return 'tidb-data-migration'
     case 'pingcap/docs-tidb-operator':
       return 'tidb-in-kubernetes'
-    case 'pingcap/docs-appdev':
-      return 'appdev'
   }
 }
 
@@ -60,63 +58,25 @@ export function download(argv) {
 
   switch (repo) {
     case 'pingcap/docs-cn':
-      if (ref === 'master') {
-        const tmpRef = 'mock-dev'
-        retrieveAllMDsFromZip(
-          {
-            repo,
-            path,
-            ref: tmpRef,
-          },
-          genDest(
-            repo,
-            path,
-            nPath.resolve(
-              dest,
-              `${repo.endsWith('-cn') ? 'zh' : 'en'}/tidb/master`
-            )
-          ),
-          options
-        )
-      } else {
-        retrieveAllMDsFromZip(
-          {
-            repo,
-            path,
-            ref,
-          },
-          genDest(
-            repo,
-            path,
-            nPath.resolve(
-              dest,
-              `${repo.endsWith('-cn') ? 'zh' : 'en'}/tidb/${ref}`
-            )
-          ),
-          options
-        )
-      }
+      retrieveAllMDsFromZip(
+        {
+          repo,
+          path,
+          ref,
+        },
+        genDest(
+          repo,
+          path,
+          nPath.resolve(
+            dest,
+            `${repo.endsWith('-cn') ? 'zh' : 'en'}/tidb/${ref}`
+          )
+        ),
+        options
+      )
       break
     case 'pingcap/docs':
-      if (ref === 'master') {
-        const tmpRef = 'dev-20220525'
-        retrieveAllMDsFromZip(
-          {
-            repo,
-            path,
-            ref: tmpRef,
-          },
-          genDest(
-            repo,
-            path,
-            nPath.resolve(
-              dest,
-              `${repo.endsWith('-cn') ? 'zh' : 'en'}/tidb/master`
-            )
-          ),
-          options
-        )
-      } else if (ref.startsWith('i18n-')) {
+      if (ref.startsWith('i18n-')) {
         const refDataList = ref.split('-')
         refDataList.shift()
         const refLang = refDataList.shift()
@@ -151,32 +111,6 @@ export function download(argv) {
       break
     case 'pingcap/docs-dm':
     case 'pingcap/docs-tidb-operator':
-    case 'pingcap/docs-appdev':
-      if (!path) {
-        sig.warn(
-          'For docs-dm/docs-tidb-operator/docs-appdev, you must provide en or zh path.'
-        )
-
-        return
-      }
-
-      const name = renameDoc(repo)
-
-      retrieveAllMDs(
-        {
-          repo,
-          path,
-          ref,
-        },
-        genDest(
-          repo,
-          path,
-          nPath.resolve(dest, `${path.split('/')[0]}/${name}/${ref}`)
-        ),
-        options
-      )
-
-      break
   }
 }
 
@@ -237,21 +171,6 @@ export function sync(argv) {
       break
     case 'pingcap/docs-dm':
     case 'pingcap/docs-tidb-operator':
-    case 'pingcap/docs-appdev':
-      const name = renameDoc(repo)
-
-      handleSync(
-        {
-          repo,
-          ref,
-          base,
-          head,
-        },
-        nPath.resolve(dest, `en/${name}/${ref}`), // use en as a placeholder
-        options
-      )
-
-      break
   }
 }
 

diff --git a/packages/download/utils.js b/packages/download/utils.js
@@ -21,7 +21,6 @@ export const imageCDNs = {
   'docs-dm': IMAGE_CDN_PREFIX + '/tidb-data-migration',
   'docs-tidb-operator': IMAGE_CDN_PREFIX + '/tidb-in-kubernetes',
   'dbaas-docs': IMAGE_CDN_PREFIX + '/tidbcloud',
-  'docs-appdev': IMAGE_CDN_PREFIX + '/appdev',
 }
 
 /**
@@ -88,13 +87,7 @@ export async function retrieveAllMDs(metaInfo, destDir, options) {
  * @param {string} destDir
  */
 export function genDest(repo, path, destDir, sync) {
-  if (
-    [
-      'pingcap/docs-dm',
-      'pingcap/docs-tidb-operator',
-      'pingcap/docs-appdev',
-    ].includes(repo)
-  ) {
+  if (['pingcap/docs-dm', 'pingcap/docs-tidb-operator'].includes(repo)) {
     const pathArr = path.split('/')
     const lang = pathArr[0]
     const pathWithoutLang = pathArr.slice(1).join('/')

diff --git a/scripts/download-appdev-en.sh b/scripts/download-appdev-en.sh
diff --git a/scripts/download-appdev-zh.sh b/scripts/download-appdev-zh.sh
diff --git a/scripts/download-appdev.sh b/scripts/download-appdev.sh
diff --git a/scripts/download-tidb-en.sh b/scripts/download-tidb-en.sh
@@ -1,4 +1,5 @@
 yarn download:tidb:en
+yarn download:tidb:en --ref release-6.1
 yarn download:tidb:en --ref release-6.0
 yarn download:tidb:en --ref release-5.4
 yarn download:tidb:en --ref release-5.3

diff --git a/scripts/download-tidb-ja.sh b/scripts/download-tidb-ja.sh
@@ -1 +1,2 @@
+yarn download:tidb:ja --ref i18n-ja-release-6.1
 yarn download:tidb:ja --ref i18n-ja-release-5.4
diff --git a/scripts/download-tidb-zh.sh b/scripts/download-tidb-zh.sh
@@ -1,4 +1,5 @@
 yarn download:tidb:zh
+yarn download:tidb:zh --ref release-6.1
 yarn download:tidb:zh --ref release-6.0
 yarn download:tidb:zh --ref release-5.4
 yarn download:tidb:zh --ref release-5.3
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		yarn download:tidb:ja --ref i18n-ja-release-6.1
		yarn download:tidb:ja --ref i18n-ja-release-5.4