You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@avro.apache.org by rs...@apache.org on 2022/06/28 18:00:34 UTC
[avro] branch branch-1.11 updated: AVRO-3539: Separate the versions to be installed (#1735)
This is an automated email from the ASF dual-hosted git repository.
rskraba pushed a commit to branch branch-1.11
in repository https://gitbox.apache.org/repos/asf/avro.git
The following commit(s) were added to refs/heads/branch-1.11 by this push:
new 01f020f95 AVRO-3539: Separate the versions to be installed (#1735)
01f020f95 is described below
commit 01f020f959093185a2ab4562a3f4de88d76b23b5
Author: Ryan Skraba <ry...@skraba.com>
AuthorDate: Tue Jun 28 19:59:44 2022 +0200
AVRO-3539: Separate the versions to be installed (#1735)
---
build.sh | 3 ++-
doc/config.toml | 12 +++++++-----
.../{next => ++version++}/Getting started (Java)/_index.md | 0
.../{next => ++version++}/Getting started (Python)/_index.md | 0
.../en/docs/{next => ++version++}/IDL Language/_index.md | 0
.../en/docs/{next => ++version++}/MapReduce guide/_index.md | 0
.../en/docs/{next => ++version++}/SASL profile/_index.md | 0
.../en/docs/{next => ++version++}/Specification/_index.md | 0
doc/content/en/docs/{next => ++version++}/_index.md | 5 ++---
doc/content/en/docs/{next => ++version++}/api-c++.md | 4 ++--
doc/content/en/docs/{next => ++version++}/api-c.md | 4 ++--
doc/content/en/docs/{next => ++version++}/api-csharp.md | 4 ++--
doc/content/en/docs/{next => ++version++}/api-java.md | 4 ++--
13 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/build.sh b/build.sh
index 118d6e8ec..125fc975f 100755
--- a/build.sh
+++ b/build.sh
@@ -179,9 +179,10 @@ do
# build docs
cp -r doc/ build/staging-web/
find build/staging-web/ -type f -print0 | xargs -0 sed -r -i "s#\+\+version\+\+#${VERSION,,}#g"
+ mv build/staging-web/content/en/docs/++version++ build/staging-web/content/en/docs/"${VERSION,,}"
read -n 1 -s -r -p "Build build/staging-web/ manually now. Press a key to continue..."
# If it was a SNAPSHOT, it was lowercased during the build.
- cp -R build/staging-web/public/docs/next/* "build/$DOC_DIR/"
+ cp -R build/staging-web/public/docs/"${VERSION,,}"/* "build/$DOC_DIR/"
# add LICENSE and NOTICE for docs
mkdir -p "build/$DOC_DIR"
cp doc/LICENSE "build/$DOC_DIR"
diff --git a/doc/config.toml b/doc/config.toml
index 449096474..506a4287f 100644
--- a/doc/config.toml
+++ b/doc/config.toml
@@ -112,7 +112,7 @@ weight = 1
section = ["HTML", "print", "RSS"]
[params]
-avroversion = "1.11.0"
+avroversion = "++version++"
copyright = "The Apache Software Foundation"
privacy_policy = "http://www.apache.org/foundation/policies/privacy.html"
@@ -131,14 +131,16 @@ archived_version = false
# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
-version = "1.11.0"
+version = "++version++"
# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://avro.apache.org"
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
-github_repo = "https://github.com/apache/avro/doc"
+github_repo = "https://github.com/apache/avro"
+github_subdir = "doc"
+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/apache/avro"
@@ -233,8 +235,8 @@ enable = true
desc = "Discuss development issues around the project"
[[params.versions]]
- version = "next"
- url = "/docs/next/"
+ version = "++version++ (Current)"
+ url = "/docs/++version++/"
[[params.versions]]
version = "1.11.0"
diff --git a/doc/content/en/docs/next/Getting started (Java)/_index.md b/doc/content/en/docs/++version++/Getting started (Java)/_index.md
similarity index 100%
rename from doc/content/en/docs/next/Getting started (Java)/_index.md
rename to doc/content/en/docs/++version++/Getting started (Java)/_index.md
diff --git a/doc/content/en/docs/next/Getting started (Python)/_index.md b/doc/content/en/docs/++version++/Getting started (Python)/_index.md
similarity index 100%
rename from doc/content/en/docs/next/Getting started (Python)/_index.md
rename to doc/content/en/docs/++version++/Getting started (Python)/_index.md
diff --git a/doc/content/en/docs/next/IDL Language/_index.md b/doc/content/en/docs/++version++/IDL Language/_index.md
similarity index 100%
rename from doc/content/en/docs/next/IDL Language/_index.md
rename to doc/content/en/docs/++version++/IDL Language/_index.md
diff --git a/doc/content/en/docs/next/MapReduce guide/_index.md b/doc/content/en/docs/++version++/MapReduce guide/_index.md
similarity index 100%
rename from doc/content/en/docs/next/MapReduce guide/_index.md
rename to doc/content/en/docs/++version++/MapReduce guide/_index.md
diff --git a/doc/content/en/docs/next/SASL profile/_index.md b/doc/content/en/docs/++version++/SASL profile/_index.md
similarity index 100%
rename from doc/content/en/docs/next/SASL profile/_index.md
rename to doc/content/en/docs/++version++/SASL profile/_index.md
diff --git a/doc/content/en/docs/next/Specification/_index.md b/doc/content/en/docs/++version++/Specification/_index.md
similarity index 100%
rename from doc/content/en/docs/next/Specification/_index.md
rename to doc/content/en/docs/++version++/Specification/_index.md
diff --git a/doc/content/en/docs/next/_index.md b/doc/content/en/docs/++version++/_index.md
similarity index 97%
rename from doc/content/en/docs/next/_index.md
rename to doc/content/en/docs/++version++/_index.md
index 63c0ef142..13b815d86 100755
--- a/doc/content/en/docs/next/_index.md
+++ b/doc/content/en/docs/++version++/_index.md
@@ -1,7 +1,6 @@
-
---
-title: "Documentation for master branch"
-linkTitle: "Next (not yet released)"
+title: "Apache Avro™ ++version++ Documentation"
+linkTitle: "++version++"
type: docs
weight: 10
---
diff --git a/doc/content/en/docs/next/api-c++.md b/doc/content/en/docs/++version++/api-c++.md
similarity index 87%
rename from doc/content/en/docs/next/api-c++.md
rename to doc/content/en/docs/++version++/api-c++.md
index 0e717502c..7a61a39e7 100644
--- a/doc/content/en/docs/next/api-c++.md
+++ b/doc/content/en/docs/++version++/api-c++.md
@@ -2,7 +2,7 @@
title: "C++ API"
linkTitle: "C++ API"
weight: 102
-manualLink: next/api/c++/html/
+manualLink: ++version++/api/c++/html/
---
<!--
@@ -26,4 +26,4 @@ manualLink: next/api/c++/html/
-->
-The C++ API documentation can be found <a href="next/api/c++/html/">here</a>.
+The C++ API documentation can be found <a href="++version++/api/c++/html/">here</a>.
diff --git a/doc/content/en/docs/next/api-c.md b/doc/content/en/docs/++version++/api-c.md
similarity index 88%
rename from doc/content/en/docs/next/api-c.md
rename to doc/content/en/docs/++version++/api-c.md
index 4656eb253..b68f3bb19 100644
--- a/doc/content/en/docs/next/api-c.md
+++ b/doc/content/en/docs/++version++/api-c.md
@@ -2,7 +2,7 @@
title: "C API"
linkTitle: "C API"
weight: 101
-manualLink: next/api/c/
+manualLink: ++version++/api/c/
---
<!--
@@ -26,4 +26,4 @@ manualLink: next/api/c/
-->
-The C API documentation can be found <a href="next/api/c/">here</a>.
+The C API documentation can be found <a href="++version++/api/c/">here</a>.
diff --git a/doc/content/en/docs/next/api-csharp.md b/doc/content/en/docs/++version++/api-csharp.md
similarity index 86%
rename from doc/content/en/docs/next/api-csharp.md
rename to doc/content/en/docs/++version++/api-csharp.md
index b319a9d4d..fd9821488 100644
--- a/doc/content/en/docs/next/api-csharp.md
+++ b/doc/content/en/docs/++version++/api-csharp.md
@@ -2,7 +2,7 @@
title: "C# API"
linkTitle: "C# API"
weight: 103
-manualLink: next/api/csharp/html/
+manualLink: ++version++/api/csharp/html/
---
<!--
@@ -26,4 +26,4 @@ manualLink: next/api/csharp/html/
-->
-The C# API documentation can be found <a href="next/api/csharp/html/">here</a>.
+The C# API documentation can be found <a href="++version++/api/csharp/html/">here</a>.
diff --git a/doc/content/en/docs/next/api-java.md b/doc/content/en/docs/++version++/api-java.md
similarity index 89%
rename from doc/content/en/docs/next/api-java.md
rename to doc/content/en/docs/++version++/api-java.md
index 70bbf4a61..343a2fd82 100644
--- a/doc/content/en/docs/next/api-java.md
+++ b/doc/content/en/docs/++version++/api-java.md
@@ -2,7 +2,7 @@
title: "Java API"
linkTitle: "Java API"
weight: 100
-manualLink: next/api/java/
+manualLink: ++version++/api/java/
---
<!--
@@ -26,4 +26,4 @@ manualLink: next/api/java/
-->
-The Javadocs can be found <a href="next/api/java/">here</a>.
+The Javadocs can be found <a href="++version++/api/java/">here</a>.