From a33c704da8794622b549ba63781df93a7ed0ac4f Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 6 Jun 2024 21:08:01 +0800 Subject: [PATCH] Remove unnecessary files --- .gitea/workflows/build-and-publish.yaml | 20 ----- .gitea/workflows/test.yaml | 23 ------ Makefile | 60 +-------------- README.md | 32 +------- loop_docs.sh | 97 ------------------------- 5 files changed, 4 insertions(+), 228 deletions(-) delete mode 100755 loop_docs.sh diff --git a/.gitea/workflows/build-and-publish.yaml b/.gitea/workflows/build-and-publish.yaml index 4c3406bf..b2547c12 100644 --- a/.gitea/workflows/build-and-publish.yaml +++ b/.gitea/workflows/build-and-publish.yaml @@ -21,26 +21,6 @@ jobs: run: | apt update -y && apt install -y rsync python3 python3-pip python-is-python3 pip install awscli - - name: prepare nightly docs - run: | - make prepare-latest - make prepare-latest-zh-cn - - name: prepare 1.22 docs - run: | - make prepare\#22 - make prepare-zh-cn\#22 - - name: prepare 1.21 docs - run: | - make prepare\#21 - make prepare-zh-cn\#21 - - name: prepare 1.20 docs - run: | - make prepare\#20 - make prepare-zh-cn\#20 - - name: prepare 1.19 docs - run: | - make prepare\#19 - make prepare-zh-cn\#19 - name: prepare awesome list run: | make prepare-awesome-latest prepare-awesome\#22 prepare-awesome\#21 prepare-awesome\#20 prepare-awesome\#19 diff --git a/.gitea/workflows/test.yaml b/.gitea/workflows/test.yaml index 78d382ee..17f5514f 100644 --- a/.gitea/workflows/test.yaml +++ b/.gitea/workflows/test.yaml @@ -12,29 +12,6 @@ jobs: with: node-version: 20 cache: npm - - name: install necessary tools - run: | - apt update -y && apt install -y rsync python3 python3-pip python-is-python3 - - name: prepare nightly docs - run: | - make prepare-latest - make prepare-latest-zh-cn - - name: prepare 1.22 docs - run: | - make prepare\#22 - make prepare-zh-cn\#22 - - name: prepare 1.21 docs - run: | - make prepare\#21 - make prepare-zh-cn\#21 - - name: prepare 1.20 docs - run: | - make prepare\#20 - make prepare-zh-cn\#20 - - name: prepare 1.19 docs - run: | - make prepare\#19 - make prepare-zh-cn\#19 - name: prepare awesome list run: | make prepare-awesome-latest prepare-awesome\#22 prepare-awesome\#21 prepare-awesome\#20 prepare-awesome\#19 diff --git a/Makefile b/Makefile index bd2fefc2..d97a9845 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,5 @@ export NODE_OPTIONS := "--max-old-space-size=8192" -GITEA_REMOTE := https://github.com/go-gitea/gitea -GITEA_LATEST_BRANCH := main -GITEA_VERSION_BRANCH_PREFIX := release/v1. GITEA_AWESOME_REMOTE := https://gitea.com/gitea/awesome-gitea.git GITEA_AWESOME_BRANCH := main @@ -11,11 +8,7 @@ all: build .PHONY: create_dir create_dir: - mkdir -p .tmp docs versioned_docs awesome - -.PHONY: clone -clone: create_dir - git clone $(GITEA_REMOTE) .tmp/upstream-docs || true + mkdir -p .tmp awesome .PHONY: clone_awesome clone_awesome: create_dir @@ -29,59 +22,12 @@ prepare-awesome-latest: clone_awesome prepare-awesome\#%: cp .tmp/upstream-awesome/README.md versioned_docs/version-1.$*/awesome.md -.PHONY: clone_main -clone_main: clone - cd .tmp/upstream-docs && git clean -f && git reset --hard && git checkout $(GITEA_LATEST_BRANCH) - cur_path=`pwd` - mkdir -p .tmp/upstream-docs/docs/scripts - cp .trans-copy.sh .tmp/upstream-docs/docs/scripts/trans-copy.sh - cd .tmp/upstream-docs/docs && bash scripts/trans-copy.sh - rm .tmp/upstream-docs/docs/scripts/trans-copy.sh - cd $(cur_path) - bash check_outdated.sh zh-cn - -.PHONY: prepare-latest -prepare-latest: clone_main - cp -r .tmp/upstream-docs/docs/static/* static/ - rsync -avz --prune-empty-dirs --include '*/' --include='*.en-us.md' --exclude '*' .tmp/upstream-docs/docs/content/ docs/ - cp .tmp/upstream-docs/templates/swagger/v1_json.tmpl static/swagger-latest.json - bash loop_docs.sh latest en-us - -.PHONY: prepare-latest-zh-cn -prepare-latest-zh-cn: - mkdir -p i18n/zh-cn/docusaurus-plugin-content-docs/current - rsync -avz --prune-empty-dirs --include '*/' --include='*.zh-cn.md' --exclude '*' .tmp/upstream-docs/docs/content/ i18n/zh-cn/docusaurus-plugin-content-docs/current/ - bash loop_docs.sh latest zh-cn - -.PHONY: clone_\#% -clone_\#%: clone - cd .tmp/upstream-docs && git clean -f && git reset --hard && git checkout $(GITEA_VERSION_BRANCH_PREFIX)$* - cur_path=`pwd` - cp .trans-copy.sh .tmp/upstream-docs/docs/scripts/trans-copy.sh - cd .tmp/upstream-docs/docs && bash scripts/trans-copy.sh - rm .tmp/upstream-docs/docs/scripts/trans-copy.sh - cd $(cur_path) - bash check_outdated.sh zh-cn - -.PHONY: prepare\#% -prepare\#%: clone_\#% - cp -r .tmp/upstream-docs/docs/static/* static/ - rsync -a --prune-empty-dirs --include '*/' --include='*.en-us.md' --exclude '*' .tmp/upstream-docs/docs/content/ versioned_docs/version-1.$*/ - cp .tmp/upstream-docs/templates/swagger/v1_json.tmpl static/swagger-$*.json - bash loop_docs.sh $* en-us - -.PHONY: prepare-zh-cn\#% -prepare-zh-cn\#%: - mkdir -p i18n/zh-cn/docusaurus-plugin-content-docs/version-1.$* - rsync -avz --prune-empty-dirs --include '*/' --include='*.zh-cn.md' --exclude '*' .tmp/upstream-docs/docs/content/ i18n/zh-cn/docusaurus-plugin-content-docs/version-1.$*/ - bash loop_docs.sh $* zh-cn - .PHONY: install install: npm install .PHONY: prepare-docs -prepare-docs: install prepare-latest prepare-latest-zh-cn prepare\#22 prepare-zh-cn\#22 prepare\#21 prepare-zh-cn\#21 prepare\#20 prepare-zh-cn\#20 prepare\#19 prepare-zh-cn\#19 prepare-awesome-latest prepare-awesome\#19 prepare-awesome\#20 prepare-awesome\#21 prepare-awesome\#22 +prepare-docs: install prepare-awesome-latest prepare-awesome\#19 prepare-awesome\#20 prepare-awesome\#21 prepare-awesome\#22 .PHONY: build build: @@ -95,8 +41,6 @@ serve: prepare-docs .PHONY: clean clean: rm -rf .tmp - rm -rf docs - rm -rf versioned_docs/ rm -rf static/_* rm -rf static/swagger-latest.json rm -rf static/swagger-19.json diff --git a/README.md b/README.md index 7fa4dc04..ce8e838a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Gitea Docusaurus ![badge](https://gitea.com/gitea/gitea-docusaurus/actions/workflows/build-and-publish.yaml/badge.svg) +# Gitea Docs ![badge](https://gitea.com/gitea/docs/actions/workflows/build-and-publish.yaml/badge.svg) ## How to build @@ -18,34 +18,6 @@ make serve ## Test en version -``` +```shell npm run start ``` - -## Test zh-cn version - -``` -npm run start -- --locale zh-cn -``` - -## Translate presets for zh-cn version - -``` -npx docusaurus write-translations --locale zh-cn -``` - -## Test both zh-cn and en versions - -``` -npm run build -npm run serve -``` - -## Use CSR Api - -This is for development, api pages will be CSR so this saves building time - -``` -npm run start-CSRApi -npm run build-CSRApi -``` diff --git a/loop_docs.sh b/loop_docs.sh deleted file mode 100755 index c8d0100b..00000000 --- a/loop_docs.sh +++ /dev/null @@ -1,97 +0,0 @@ -#!/bin/bash - -# The script takes two params: -# version: "latest" or a specific version number -# locale - -set -xe - -SED_INPLACE() { - if sed --version 2>/dev/null | grep -q GNU; then - sed -i "$@" - else - sed -i '' "$@" - fi -} - -version="$1" -if [ "$version" != "latest" ]; then - version="1.$1" -fi -locale="$2" -minNodeVer="16" -minGoVer="1.20" -goVer="1.20" -minorVer="main-nightly" -if [ "$version" == "1.19" ]; then - minorVer="1.19.4" - minGoVer="1.19" -elif [ "$version" == "1.20" ]; then - minorVer="1.20.6" -elif [ "$version" == "1.21" ]; then - minorVer="1.21.11" -elif [ "$version" == "1.22" ]; then - minorVer="1.22.0" -fi - -docs_dir="versioned_docs/version-$version" -if [ "$version" == "latest" ]; then - if [ "$locale" == "en-us" ]; then - docs_dir="docs" - else - docs_dir="i18n/$locale/docusaurus-plugin-content-docs/current" - fi -else - if [ "$locale" != "en-us" ]; then - docs_dir="i18n/$locale/docusaurus-plugin-content-docs/version-$version" - fi -fi - -SED_INPLACE "s/@minNodeVersion@/$minNodeVer/" "$docs_dir/development/hacking-on-gitea.$locale.md" -SED_INPLACE "s/@minGoVersion@/$minGoVer/" "$docs_dir/development/hacking-on-gitea.$locale.md" -SED_INPLACE "s/@goVersion@/$goVer/" "$docs_dir/development/hacking-on-gitea.$locale.md" -SED_INPLACE "s/@minNodeVersion@/$minNodeVer/" "$docs_dir/installation/from-source.$locale.md" -SED_INPLACE "s/@minGoVersion@/$minGoVer/" "$docs_dir/installation/from-source.$locale.md" - -# TODO: improve this sed -# need confirmation -if [ "$version" == "latest" ]; then - SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.23-dev"/' static/swagger-latest.json -elif [ "$version" == "1.22" ]; then - SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.22.0"/' static/swagger-22.json -elif [ "$version" == "1.21" ]; then - SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.21.11"/' static/swagger-21.json -elif [ "$version" == "1.20" ]; then - SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.20.6"/' static/swagger-20.json -elif [ "$version" == "1.19" ]; then - SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.19.4"/' static/swagger-19.json -fi -SED_INPLACE 's/"basePath": "{{AppSubUrl | JSEscape | Safe}}/"basePath": "https:\/\/gitea.com/' static/swagger-"$1".json - -for file in `find ./"$docs_dir" -name "*.md"`; do - if [ "$version" == "lastest" ]; then - SED_INPLACE 's/dl.gitea.com\/gitea\/@version@/dl.gitea.com\/gitea\/main/g' $file - SED_INPLACE 's/gitea\/gitea\:@version@/gitea\/gitea\:nightly/g' $file - fi - SED_INPLACE "s/@version@/$minorVer/g" $file -done - -for file in "$docs_dir"/*; do - if [ -d $file ]; then - continue - fi - if [ "$file" == "$docs_dir/intro.md" ]; then - continue - fi - rm $file || true -done - -# file names under docs/ and i18n/zh-cn/docusaurus-plugin-content-docs/current/ should be the same for docusaurus -# to recognize them as tanslated. -for file in `find "$docs_dir" -name "*.$locale.md"`; do - mv "${file}" "${file/.$locale/}" -done - -if [ -f "$docs_dir/help/search.md" ]; then - rm "$docs_dir/help/search.md" -fi