Skip to content

Commit

Permalink
Fixes #22368: Prepare 7.3 doc (#951)
Browse files Browse the repository at this point in the history
  • Loading branch information
amousset committed Feb 13, 2023
1 parent 11444a1 commit a84c3bb
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 25 deletions.
6 changes: 3 additions & 3 deletions 7.1.yml → 7.3.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
site:
title: Rudder 7.1 Documentation
title: Rudder 7.3 Documentation
start_page: get-started::home
output:
dir: ./build/history/7.1
dir: ./build/history/7.3
content:
sources:
- url: .
Expand All @@ -12,6 +12,6 @@ content:
branches: master
start_path: src/rudder-by-example
- url: ./doc-build
branches: "branches/rudder/7.1"
branches: "branches/rudder/7.3"
start_path: src/reference

28 changes: 14 additions & 14 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ALL_VERSIONS = 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11 3.0 3.1 3.2 4.0 4.1 4.2 4.3 5.0 6.0 6.1 6.2 7.0 7.1 7.2
VERSIONS = 7.1 7.2
ALL_VERSIONS = 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11 3.0 3.1 3.2 4.0 4.1 4.2 4.3 5.0 6.0 6.1 6.2 7.0 7.1 7.2 7.3
VERSIONS = 7.2 7.3
VERSION_DOCS = $(addprefix doc-, $(VERSIONS))
VERSION_ARCHIVES = $(addsuffix .archive, $(VERSIONS))

Expand All @@ -12,8 +12,8 @@ LATEST_MAJOR=$(shell curl https://www.rudder-project.org/release-info/rudder/ver
.PHONY: prepare rudder-theme/build/ui-bundle.zip optipng doc-build changelogs-build build/sites/site/.htaccess build/files $(SITES)
.DEFAULT_GOAL := local

all: $(GENERIC_DOCS) build/sites/site/.htaccess build/history/7.1/.htaccess build/history/7.2/.htaccess $(VERSION_ARCHIVES) build/files test
online: site site-dev build/sites/site/.htaccess build/history/7.1/.htaccess build/history/7.2/.htaccess $(VERSION_ARCHIVES) build/files
all: $(GENERIC_DOCS) build/sites/site/.htaccess build/history/7.2/.htaccess build/history/7.3/.htaccess $(VERSION_ARCHIVES) build/files test
online: site site-dev build/sites/site/.htaccess build/history/7.2/.htaccess build/history/7.3/.htaccess $(VERSION_ARCHIVES) build/files
local: site-local test

rudder-theme/build/ui-bundle.zip:
Expand All @@ -23,21 +23,21 @@ rudder-theme/build/ui-bundle.zip:
# Ugly workaround until we can use custom generators in antora
doc-build:
[ -d $@ ] || git clone https://github.com/Normation/rudder-doc.git $@
cd $@ && git checkout branches/rudder/7.1 && git pull
cd $@/src/reference && make
cd $@ && git add -f src/reference && git commit --allow-empty -m "Build 7.1"
cd $@ && git clean -fd
cd $@ && git checkout branches/rudder/7.2 && git pull
cd $@/src/reference && make
cd $@ && git add -f src/reference && git commit --allow-empty -m "Build 7.2"
cd $@ && git clean -fd
cd $@ && git checkout branches/rudder/7.3 && git pull
cd $@/src/reference && make
cd $@ && git add -f src/reference && git commit --allow-empty -m "Build 7.3"

changelogs-build:
[ -d $@ ] || git clone https://github.com/Normation/rudder-doc.git $@
cd $@ && git checkout master && git pull
for version in $(ALL_VERSIONS); do \
cd $@ && git checkout master && git branch -df "branches/rudder/$$version" ; git checkout -b "branches/rudder/$$version" ; \
sed -i "s@version: \"7.2\"@version: \"$$version\"@" src/changelogs/antora.yml ; \
sed -i "s@RUDDER_VERSION = 7.2@RUDDER_VERSION = $$version@" src/changelogs/dependencies/Makefile ; \
sed -i "s@version: \"7.3\"@version: \"$$version\"@" src/changelogs/antora.yml ; \
sed -i "s@RUDDER_VERSION = 7.3@RUDDER_VERSION = $$version@" src/changelogs/dependencies/Makefile ; \
cd src/changelogs && make ; \
cd ../.. && git add -f src/changelogs && git commit --allow-empty -m "Build" ; cd .. ; \
done
Expand All @@ -60,14 +60,14 @@ build/sites/site/.htaccess:
echo 'Redirect /reference/current/ /reference/$(LATEST_MAJOR)/' > $@
echo 'Redirect /changelogs/current/ /changelogs/$(LATEST_MAJOR)/' >> $@

build/history/7.1/.htaccess:
mkdir -p build/history/7.1/
echo 'Redirect /rudder-doc/reference/current/ /rudder-doc/reference/7.1/' > $@

build/history/7.2/.htaccess:
mkdir -p build/history/7.2/
echo 'Redirect /rudder-doc/reference/current/ /rudder-doc/reference/7.2/' > $@

build/history/7.3/.htaccess:
mkdir -p build/history/7.3/
echo 'Redirect /rudder-doc/reference/current/ /rudder-doc/reference/7.3/' > $@

# Download documentation files
build/files:
mkdir -p build/files
Expand Down
4 changes: 2 additions & 2 deletions rudder-theme/src/partials/navigation-explore.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
<span class="title">Public API reference</span>
<ul class="versions">
<li class="version">
<a href="https://docs.rudder.io/api/v/16/">7.2 (v16)</a>
<a href="https://docs.rudder.io/api/v/17/">7.3 (v17)</a>
</li>
<li class="version">
<a href="https://docs.rudder.io/api/v/15/">7.1 (v15)</a>
<a href="https://docs.rudder.io/api/v/16/">7.2 (v16)</a>
</li>
<li class="version">
<a href="https://docs.rudder.io/api/v/">older</a>
Expand Down
2 changes: 1 addition & 1 deletion site-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ content:
branches: master
start_path: src/rudder-by-example
- url: ./doc-build
branches: ["branches/rudder/7.1", "branches/rudder/7.2"]
branches: ["branches/rudder/7.2", "branches/rudder/7.3"]
start_path: src/reference
- url: .
branches: master
Expand Down
3 changes: 2 additions & 1 deletion site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ content:
branches: master
start_path: src/rudder-by-example
- url: ./doc-build
branches: ["branches/rudder/7.1", "branches/rudder/7.2"]
branches: ["branches/rudder/7.2", "branches/rudder/7.3"]
start_path: src/reference
- url: ./changelogs-build
branches:
Expand All @@ -40,4 +40,5 @@ content:
- "branches/rudder/7.0"
- "branches/rudder/7.1"
- "branches/rudder/7.2"
- "branches/rudder/7.3"
start_path: src/changelogs
2 changes: 1 addition & 1 deletion src/changelogs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: changelogs
title: Changelogs
version: "7.2"
version: "7.3"
nav:
- modules/ROOT/nav.adoc

2 changes: 1 addition & 1 deletion src/changelogs/dependencies/Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Builds dynamic dependencies from other repos

RUDDER_VERSION = 7.2
RUDDER_VERSION = 7.3

.PHONY: clean changelogs
all: changelogs
Expand Down
2 changes: 1 addition & 1 deletion src/reference/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: reference
title: Reference manual
version: "7.2"
version: "7.3"
nav:
- modules/ROOT/nav.adoc
- modules/installation/nav.adoc
Expand Down
2 changes: 1 addition & 1 deletion src/reference/dependencies/Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Builds dynamic dependencies from other repos

RUDDER_VERSION = 7.2
RUDDER_VERSION = 7.3

.PHONY: clean generic_methods.adoc generic_methods_categories.txt rudder.adoc rudder-relayd.1.adoc hooks.adoc plugins versions.adoc version-compat.adoc
all: generic_methods.adoc hooks.adoc rudder.adoc rudder-relayd.1.adoc plugins version-compat.adoc
Expand Down

0 comments on commit a84c3bb

Please sign in to comment.