gitea/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-06-23 20:55:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add v1.20 documentation (#28)

Browse Source 
Modified `loop_docs.sh` to take `version` and `locale` and params so do not need other `loop_docs*` scripts.

Need confirmation with version information for 1.20 and latest.
Like version in `static/20-swagger.json` and `static/latest-swagger.json`, and version used to replace `{{< version >}}`

Will wait for a stable version for 1.20

![Screen Shot 2023-06-14 at 12.12.18](/attachments/1b316978-0daf-46bb-90a7-632a0fc80898)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/28
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
This commit is contained in:
HesterG
2023-06-14 07:05:13 +00:00
committed by Lunny Xiao
parent 9bc53d050e
commit 7ca358b43e
12 changed files with 212 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
loop_docs.sh Normal file → Executable file
View File

@@ -1,5 +1,9 @@
#!/bin/bash
# The script takes two params:
# version: "latest" or a specific version number
# locale
set -xe
if sed --version 2>/dev/null | grep -q GNU; then
@@ -8,37 +12,76 @@ else
SED_INPLACE="sed -i ''"
fi
$SED_INPLACE 's/\\<empty/<empty/' docs/administration/config-cheat-sheet.en-us.md
$SED_INPLACE 's/<empty>/<empty\\>/' docs/administration/config-cheat-sheet.en-us.md
$SED_INPLACE 's/^url:.*//' docs/intro.md
$SED_INPLACE 's/^slug:.*/slug: \//' docs/intro.md
$SED_INPLACE 's/.\/guidelines-frontend.md/.\/guidelines-frontend/' docs/development/hacking-on-gitea.en-us.md
$SED_INPLACE 's/{{< min-node-version >}}/16/' docs/development/hacking-on-gitea.en-us.md
$SED_INPLACE 's/{{< min-go-version >}}/1.20/' docs/development/hacking-on-gitea.en-us.md
$SED_INPLACE 's/{{< go-version >}}/1.20/' docs/development/hacking-on-gitea.en-us.md
$SED_INPLACE 's/{{< min-node-version >}}/16/' docs/installation/from-source.en-us.md
$SED_INPLACE 's/{{< min-go-version >}}/1.20/' docs/installation/from-source.en-us.md
version="$1"
if [ "$version" != "lastest" ]; 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.3"
minGoVer="1.19"
elif ["$version" == "1.20"]; then
minorVer="1.20.0-rc0"
fi
$SED_INPLACE 's/"version":.*/"version":"1.20-dev"/' static/latest-swagger.json
docs_dir="versioned_docs/version-$version"
if [ "$version" == "lastest" ]; 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
for file in `find ./docs -name "*.md"`; do
if [ -f "$docs_dir/installation/with-docker.$locale.md" ]; then
$SED_INPLACE 's/\\<empty>/<empty\\>/' "$docs_dir/installation/with-docker.$locale.md"
fi
$SED_INPLACE 's/\\<empty/<empty/' "$docs_dir/administration/config-cheat-sheet.$locale.md"
$SED_INPLACE 's/<empty>/<empty\\>/' "$docs_dir/administration/config-cheat-sheet.$locale.md"
$SED_INPLACE 's/^url:.*//' "$docs_dir/intro.md"
$SED_INPLACE 's/^slug:.*/slug: \//' "$docs_dir/intro.md"
$SED_INPLACE "s/{{< min-node-version >}}/$minNodeVer/" "$docs_dir/development/hacking-on-gitea.$locale.md"
$SED_INPLACE "s/{{< min-go-version >}}/$minGoVer/" "$docs_dir/development/hacking-on-gitea.$locale.md"
$SED_INPLACE "s/{{< go-version >}}/$goVer/" "$docs_dir/development/hacking-on-gitea.$locale.md"
$SED_INPLACE "s/{{< min-node-version >}}/$minNodeVer/" "$docs_dir/installation/from-source.$locale.md"
$SED_INPLACE "s/{{< min-go-version >}}/$minGoVer/" "$docs_dir/installation/from-source.$locale.md"
# TODO: improve this sed
# need confirmation
if [ "$version" == "lastest" ]; then
$SED_INPLACE 's/"version":.*/"version":"1.21-dev"/' static/latest-swagger.json
elif [ "$version" == "1.20" ]; then
$SED_INPLACE 's/"version":.*/"version":"1.20.0-rc0"/' static/20-swagger.json
elif [ "$version" == "1.19" ]; then
$SED_INPLACE 's/"version":.*/"version":"1.19.3"/' static/19-swagger.json
fi
for file in `find ./"$docs_dir" -name "*.md"`; do
# hide hugo toc
$SED_INPLACE 's/{{< toc >}}//' $file
$SED_INPLACE 's/dl.gitea.com\/gitea\/{{< version >}}/dl.gitea.com\/gitea\/main/g' $file
$SED_INPLACE 's/{{< version >}}/main-nightly/g' $file
$SED_INPLACE "s/{{< version >}}/$minorVer/g" $file
$SED_INPLACE 's/{{< relref "doc\///g' $file
$SED_INPLACE 's/.en-us.md/.md/g' $file
$SED_INPLACE "s/.$locale.md/.md/g" $file
$SED_INPLACE 's/" >}}//g' $file
$SED_INPLACE 's/\*\*Table of Contents\*\*//' $file
$SED_INPLACE 's/weight:/sidebar_position:/g' $file
#sed -i 's/^slug:.*//' $file
done
for file in docs/*; do
for file in "$docs_dir"/*; do
if [ -d $file ]; then
continue
fi
if [ "$file" == "docs/intro.md" ]; then
if [ "$file" == "$docs_dir/intro.md" ]; then
continue
fi
rm $file || true
@@ -46,6 +89,10 @@ 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 -name "*.en-us.md"`; do
mv "${file}" "${file/.en-us/}"
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