diff --git a/.github/workflows/update.yml b/.github/workflows/update.yml index 7d7a73151..b129f2d8b 100644 --- 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 index 788bc85e5..e93c0fc90 100644 --- 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 index 37d723b05..8b28ad93d 100644 --- 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 index abd0f08d6..13fbdbe35 100644 --- 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 index 68973ce78..88b6aa113 100644 --- 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 index 06581ce06..b30b042de 100644 --- 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 index 34c6e8a4c..d0c5e9b8a 100644 --- 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 index 48a394c9e..95982c0eb 100644 --- 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 index de45ca0db..de109d01b 100644 --- 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 deleted file mode 100755 index d4062c1de..000000000 --- a/scripts/download-appdev-en.sh +++ /dev/null @@ -1 +0,0 @@ -yarn download:appdev en diff --git a/scripts/download-appdev-zh.sh b/scripts/download-appdev-zh.sh deleted file mode 100755 index aedf48de5..000000000 --- a/scripts/download-appdev-zh.sh +++ /dev/null @@ -1 +0,0 @@ -yarn download:appdev zh diff --git a/scripts/download-appdev.sh b/scripts/download-appdev.sh deleted file mode 100755 index 214b7d56c..000000000 --- a/scripts/download-appdev.sh +++ /dev/null @@ -1,4 +0,0 @@ -DIR=$(cd $(dirname $0) && pwd) - -sh $DIR/download-appdev-en.sh -sh $DIR/download-appdev-zh.sh diff --git a/scripts/download-tidb-en.sh b/scripts/download-tidb-en.sh index 11693046b..b81abacdc 100755 --- 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 index d56457336..2fc0de657 100755 --- 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 index d465275e3..abd655029 100755 --- 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 diff --git a/scripts/get-latest-commits.sh b/scripts/get-latest-commits.sh index d387858ce..78f192fbf 100755 --- a/scripts/get-latest-commits.sh +++ b/scripts/get-latest-commits.sh @@ -4,12 +4,12 @@ CACHE_DIR="$DIR/../markdown-pages" GITHUB_AUTHORIZATION_TOKEN=$1 # repos in pingcap -repos=(docs docs-cn docs-dm docs-tidb-operator docs-appdev) -docs=(master release-6.0 release-5.4 release-5.3 release-5.2 release-5.1 release-5.0 release-4.0 release-3.1 release-3.0 release-2.1 i18n-ja-release-5.4) -docs_cn=(master release-6.0 release-5.4 release-5.3 release-5.2 release-5.1 release-5.0 release-4.0 release-3.1 release-3.0 release-2.1) +repos=(docs docs-cn docs-dm docs-tidb-operator) + +docs=(master release-6.1 release-6.0 release-5.4 release-5.3 release-5.2 release-5.1 release-5.0 release-4.0 release-3.1 release-3.0 release-2.1 i18n-ja-release-5.4) +docs_cn=(master release-6.1 release-6.0 release-5.4 release-5.3 release-5.2 release-5.1 release-5.0 release-4.0 release-3.1 release-3.0 release-2.1) docs_dm=(release-5.3 release-2.0 release-1.0) docs_tidb_operator=(master release-1.3 release-1.2 release-1.1 release-1.0) -docs_appdev=(master) for repo in ${repos[@]} do @@ -24,19 +24,20 @@ do done # repos in tidbcloud -tidbcloud=(dbaas-docs) -dbaas_docs=(master) +# tidbcloud had been merged into tidb en docs +# tidbcloud=(dbaas-docs) +# dbaas_docs=(master) -for repo in ${tidbcloud[@]} -do - repo_to_index="${repo//-/_}" - versions=$repo_to_index[@] +# for repo in ${tidbcloud[@]} +# do +# repo_to_index="${repo//-/_}" +# versions=$repo_to_index[@] - for v in ${!versions} - do - curl -s -H "Authorization: token $GITHUB_AUTHORIZATION_TOKEN" \ - -H "Accept: application/vnd.github.VERSION.sha" \ - "https://api.github.com/repos/tidbcloud/$repo/commits/$v" > $CACHE_DIR/$repo-$v.hash - echo "$repo-$v.hash" $(cat $CACHE_DIR/$repo-$v.hash) - done -done +# for v in ${!versions} +# do +# curl -s -H "Authorization: token $GITHUB_AUTHORIZATION_TOKEN" \ +# -H "Accept: application/vnd.github.VERSION.sha" \ +# "https://api.github.com/repos/tidbcloud/$repo/commits/$v" > $CACHE_DIR/$repo-$v.hash +# echo "$repo-$v.hash" $(cat $CACHE_DIR/$repo-$v.hash) +# done +# done diff --git a/src/layout/comp/Navbar.tsx b/src/layout/comp/Navbar.tsx index d9ec073f2..a48bc2a84 100644 --- a/src/layout/comp/Navbar.tsx +++ b/src/layout/comp/Navbar.tsx @@ -169,15 +169,6 @@ export function Navbar({ locale, is404 }: Props) { )} - {['en', 'zh'].includes(language) && ( - - - - )} diff --git a/src/lib/utils.js b/src/lib/utils.js index 8d7f1d491..07288ee31 100644 --- a/src/lib/utils.js +++ b/src/lib/utils.js @@ -1,11 +1,7 @@ import { navigate, withPrefix } from 'gatsby' export function wrapPathWithLang(repo, path, lang) { - if ( - repo === 'pingcap/docs-dm' || - repo === 'pingcap/docs-tidb-operator' || - repo === 'pingcap/docs-appdev' - ) { + if (repo === 'pingcap/docs-dm' || repo === 'pingcap/docs-tidb-operator') { return `${lang}/${path}` } diff --git a/src/lib/version.js b/src/lib/version.js index cae8433ab..b6b0d3c8e 100644 --- a/src/lib/version.js +++ b/src/lib/version.js @@ -36,8 +36,6 @@ export const operator = docs['tidb-in-kubernetes']['languages']['en'][ 'versions' ].map(d => convertVersionName(d, operatorStable)) export const cloud = null -export const appdev = - docs['appdev']['languages']['en']['versions'].map(convertVersionName) export const deprecated = { tidb: docs['tidb']['deprecated'], diff --git a/src/search/index.tsx b/src/search/index.tsx index 4452a3a9d..fcb960e5f 100644 --- a/src/search/index.tsx +++ b/src/search/index.tsx @@ -1,7 +1,6 @@ import { Trans, useI18next } from 'gatsby-plugin-react-i18next' import { useEffect, useState } from 'react' import { - appdev, cloud, convertVersionName, dm, @@ -35,8 +34,6 @@ const matchToVersionList = match => { return operator case 'tidbcloud': return cloud - case 'appdev': - return appdev default: return tidb } @@ -72,7 +69,9 @@ export default function Search() { const toAlgoliaVersion = version => version === 'stable' ? convertVersionName(replaceStableVersion(selectedType)) - : version !== 'null' ? version : null + : version !== 'null' + ? version + : null const [selectedVersion, _setSelectedVersion] = useState( toAlgoliaVersion(version) ) @@ -107,25 +106,12 @@ export default function Search() { const getDocsTypesByLang = () => { switch (language) { - case 'zh': + default: types.push({ - name: '开发指南', - match: 'appdev', + name: 'Cloud', + match: 'tidbcloud', }) - break - default: - types.push( - { - name: 'Cloud', - match: 'tidbcloud', - }, - { - name: 'App Dev', - match: 'appdev', - } - ) - break } @@ -147,7 +133,9 @@ export default function Search() { dispatch(setLoading(true)) const index = algoliaClient.initIndex( - `${language}-${selectedType}${selectedVersion ? '-' + selectedVersion : ''}` + `${language}-${selectedType}${ + selectedVersion ? '-' + selectedVersion : '' + }` ) index diff --git a/src/typing.ts b/src/typing.ts index 75f1f3e49..078885d98 100644 --- a/src/typing.ts +++ b/src/typing.ts @@ -3,7 +3,6 @@ export enum Repo { dm = 'tidb-data-migration', operator = 'tidb-in-kubernetes', tidbcloud = 'tidbcloud', - appdev = 'appdev', } export interface FrontMatter {