Skip to content

Commit

Permalink
Adding versioning support to R2 (#133)
Browse files Browse the repository at this point in the history
Redoing #132 now without
merging the main branch to the R2 one.

Partly fixes nephio-project/nephio#738

---------

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
  • Loading branch information
CsatariGergely authored Jun 17, 2024
1 parent c92fc73 commit 4d63902
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 9 deletions.
24 changes: 20 additions & 4 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
baseURL = 'https://r2.docs.nephio.org/'
languageCode = 'en-us'
title = 'Nephio Documentation'
title = 'Nephio R2 Documentation'
# based on https://www.docsy.dev/docs/get-started/docsy-as-module/start-from-scratch/

# Language settings
Expand Down Expand Up @@ -49,17 +49,17 @@ version_menu = "Releases"
# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false
archived_version = true

# 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 = "0.0"
version = "latest"
version = "R2"

# 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://example.com"
url_latest_version = "https://docs.nephio.org/docs/"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/nephio-project/docs"
Expand Down Expand Up @@ -151,3 +151,19 @@ enable = false
# icon = "fa fa-envelope"
# desc = "Discuss development issues around the project"

# Add your release versions here
[[params.versions]]
version = "main"
url = "https://docs.nephio.org/docs/"

[[params.versions]]
version = "R3"
url = "https://nephio-r3.netlify.app/docs/"

[[params.versions]]
version = "R2"
url = "https://r2.docs.nephio.org/docs/"

[[params.versions]]
version = "R1"
url = "https://github.com/nephio-project/docs/tree/R1"
8 changes: 3 additions & 5 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Start
description: Documentation of the Nephio project
menu: {main: {weight: 10}}
---
{{< blocks/cover title="Welcome to the Nephio documentation" image_anchor="top" height="full" >}}
{{< blocks/cover title="Welcome to Release 2 of Nephio" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="https://nephio.org/">
Homepage <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
Expand All @@ -27,10 +27,8 @@ and network functions across large scale edge deployments."

{{% blocks/section type="row" %}}

{{% blocks/feature icon="fas fa-rocket" title="R1" %}}
Welcome to the R1 release of Nephio. Please use the documentation links below to learn more about Nephio R1, or checkout
our [Learning Nephio with R1](https://wiki.nephio.org/display/HOME/Learning+with+Nephio+R1) series, which includes a
[demo video](https://youtu.be/mFl71sy2Pdc) and short articles about different aspects of Nephio R1.
{{% blocks/feature icon="fas fa-rocket" title="R2" %}}
Welcome to the Release 2 (R2) of Nephio. Please use the documentation links below to learn more about Nephio R2.
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-wikipedia-w" title="Wiki" %}}
Expand Down

0 comments on commit 4d63902

Please sign in to comment.