centersl/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-03-27 05:58:30 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add version of 1.22 (#137)

Browse Source 
Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/137
This commit is contained in:
Lunny Xiao
2024-05-27 13:52:22 +00:00
parent 0274225b2a
commit 377f435a2b
11 changed files with 146 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.gitea/workflows/build-and-publish.yaml
View File

@@ -25,6 +25,10 @@ jobs:
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
@@ -39,7 +43,7 @@ jobs:
make prepare-zh-cn\#19
- name: prepare awesome list
run: |
make prepare-awesome-latest prepare-awesome\#21 prepare-awesome\#20 prepare-awesome\#19
make prepare-awesome-latest prepare-awesome\#22 prepare-awesome\#21 prepare-awesome\#20 prepare-awesome\#19
- name: build site
run: |
make build

6
.gitea/workflows/test.yaml
View File

@@ -19,6 +19,10 @@ jobs:
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
@@ -33,7 +37,7 @@ jobs:
make prepare-zh-cn\#19
- name: prepare awesome list
run: |
make prepare-awesome-latest prepare-awesome\#21 prepare-awesome\#20 prepare-awesome\#19
make prepare-awesome-latest prepare-awesome\#22 prepare-awesome\#21 prepare-awesome\#20 prepare-awesome\#19
- name: build site
run: |
make build

1
.gitignore vendored
View File

@@ -28,3 +28,4 @@ i18n/zh-cn/docusaurus-plugin-content-docs/current
i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19
i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20
i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21
i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22

5
Makefile
View File

@@ -59,7 +59,9 @@ prepare-latest-zh-cn:
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
@@ -83,7 +85,7 @@ install:
npm install
.PHONY: prepare-docs
prepare-docs: install prepare-latest prepare-latest-zh-cn 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-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
.PHONY: build
build:
@@ -104,3 +106,4 @@ clean:
rm -rf static/swagger-19.json
rm -rf static/swagger-20.json
rm -rf static/swagger-21.json
rm -rf static/swagger-22.json

20
docusaurus.config.js
View File

@@ -26,6 +26,10 @@ const apiConfig = [
spec: 'static/swagger-latest.json',
route: '/api/next/',
},
{
route: '/api/1.22/',
spec: 'static/swagger-22.json',
},
{
route: '/api/1.21/',
spec: 'static/swagger-21.json',
@@ -40,7 +44,7 @@ const apiConfig = [
},
{
route: '/api/',
spec: 'static/swagger-21.json',
spec: 'static/swagger-22.json',
}
]: [],
// Theme Options for modifying how redoc renders them
@@ -112,9 +116,12 @@ const config = {
},
versions: {
current: {
label: '1.22-rc1', // path is kept as next for dev (so users can always find "nightly" docs)
label: '1.23-dev', // path is kept as next for dev (so users can always find "nightly" docs)
banner: 'unreleased',
},
'1.22': {
label: '1.22.0',
},
'1.21': {
label: '1.21.11',
},
@@ -125,7 +132,7 @@ const config = {
label: '1.19.4',
}
},
lastVersion: '1.21',
lastVersion: '1.22',
async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
const {item} = args;
// Use the provided data to generate a custom sidebar slice
@@ -191,10 +198,10 @@ const config = {
label: 'Docs',
},
{
to: '/api/1.21/',
to: '/api/1.22/',
label: 'API',
position: 'left',
activeBaseRegex: 'api/(1.19|1.20|1.21|next)/',
activeBaseRegex: 'api/(1.19|1.20|1.21|1.22|next)/',
},
{
position: 'left',
@@ -208,7 +215,8 @@ const config = {
label: 'API Version',
position: 'right',
items: [
{to: '/api/next/', label: '1.22-dev' },
{to: '/api/next/', label: '1.23-dev' },
{to: '/api/1.22/', label: '1.22.0' },
{to: '/api/1.21/', label: '1.21.11' },
{to: '/api/1.20/', label: '1.20.6' },
{to: '/api/1.19/', label: '1.19.4' },

8
i18n/en-us/docusaurus-plugin-content-docs/version-1.19.json Normal file
View File

@@ -0,0 +1,8 @@
{
"sidebar.docs.category.actions": {
"message": "Actions"
},
"sidebar.docs.category.packages": {
"message": "Packages"
}
}

8
i18n/en-us/docusaurus-plugin-content-docs/version-1.21.json Normal file
View File

@@ -0,0 +1,8 @@
{
"sidebar.docs.category.actions": {
"message": "Actions"
},
"sidebar.docs.category.packages": {
"message": "Packages"
}
}

8
i18n/en-us/docusaurus-plugin-content-docs/version-1.22.json Normal file
View File

@@ -0,0 +1,8 @@
{
"sidebar.docs.category.actions": {
"message": "Actions"
},
"sidebar.docs.category.packages": {
"message": "Packages"
}
}

6
loop_docs.sh
View File

@@ -30,6 +30,8 @@ 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"
@@ -54,7 +56,9 @@ SED_INPLACE "s/@minGoVersion@/$minGoVer/" "$docs_dir/installation/from-source.$l
# TODO: improve this sed
# need confirmation
if [ "$version" == "latest" ]; then
SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.22-rc1"/' static/swagger-latest.json
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

87
versioned_sidebars/version-1.22-sidebars.json Normal file
View File

@@ -0,0 +1,87 @@
{
"docs": [
{
"type": "doc",
"id": "intro",
"label": "What is Gitea?"
},
{
"type": "category",
"label": "Installation",
"link": {
"type": "generated-index"
},
"items": [
{
"type": "autogenerated",
"dirName": "installation"
}
]
},
{
"type": "category",
"label": "Administration",
"link": {
"type": "generated-index"
},
"items": [
{
"type": "autogenerated",
"dirName": "administration"
}
]
},
{
"type": "category",
"label": "Usage",
"link": {
"type": "generated-index"
},
"items": [
{
"type": "autogenerated",
"dirName": "usage"
}
]
},
{
"type": "category",
"label": "Development",
"link": {
"type": "generated-index"
},
"items": [
{
"type": "autogenerated",
"dirName": "development"
}
]
},
{
"type": "category",
"label": "Contributing",
"link": {
"type": "generated-index"
},
"items": [
{
"type": "autogenerated",
"dirName": "contributing"
}
]
},
{
"type": "category",
"label": "Help",
"link": {
"type": "generated-index"
},
"items": [
{
"type": "autogenerated",
"dirName": "help"
}
]
}
]
}

1
versions.json
View File

@@ -1,4 +1,5 @@
[
"1.22",
"1.21",
"1.20",
"1.19"