From cfc65a039047d904c0cdf643c6e16191f3653de7 Mon Sep 17 00:00:00 2001 From: Erik Jaegervall Date: Tue, 23 Jul 2024 09:06:04 +0200 Subject: [PATCH] Changing hugo theme to relearn Using relearn 6.0.0 Also updating hugo version Signed-off-by: Erik Jaegervall --- .github/workflows/buildcheck.yml | 2 +- .gitmodules | 6 +++--- docs-gen/README.md | 2 +- docs-gen/config.toml | 4 ++-- docs-gen/content/ecosystem/_index.md | 4 +--- docs-gen/content/governance/_index.md | 4 +--- docs-gen/content/introduction/_index.md | 4 +--- docs-gen/content/rule_set/_index.md | 4 +--- docs-gen/content/rule_set/data_entry/_index.md | 3 +-- docs-gen/content/rule_set/data_entry/allowed.md | 2 +- docs-gen/themes/hugo-theme-relearn | 1 + docs-gen/themes/learn | 1 - 12 files changed, 14 insertions(+), 23 deletions(-) create mode 160000 docs-gen/themes/hugo-theme-relearn delete mode 160000 docs-gen/themes/learn diff --git a/.github/workflows/buildcheck.yml b/.github/workflows/buildcheck.yml index 989461e85..ab72f1943 100644 --- a/.github/workflows/buildcheck.yml +++ b/.github/workflows/buildcheck.yml @@ -65,7 +65,7 @@ jobs: - name: Install hugo env: - HUGO_VER : 0.103.1 + HUGO_VER : 0.129.0 run: | curl -LO https://github.com/gohugoio/hugo/releases/download/v${HUGO_VER}/hugo_${HUGO_VER}_linux-amd64.deb sudo dpkg -i hugo_${HUGO_VER}_linux-amd64.deb diff --git a/.gitmodules b/.gitmodules index c6f6c4a95..d7413a1a4 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,6 @@ [submodule "vss-tools"] path = vss-tools url = https://github.com/covesa/vss-tools -[submodule "docs-gen/themes/learn"] - path = docs-gen/themes/learn - url = https://github.com/matcornic/hugo-theme-learn.git +[submodule "docs-gen/themes/hugo-theme-relearn"] + path = docs-gen/themes/hugo-theme-relearn + url = https://github.com/McShelby/hugo-theme-relearn.git diff --git a/docs-gen/README.md b/docs-gen/README.md index 84f6f8e45..1deacab4e 100644 --- a/docs-gen/README.md +++ b/docs-gen/README.md @@ -52,7 +52,7 @@ Run check with `Check linked documents recursively` The static page is generated with: - [HUGO](https://gohugo.io/) -- [Learn Theme](https://github.com/matcornic/hugo-theme-learn) +- [Relearn Theme](https://github.com/McShelby/hugo-theme-relearn) Please follow the [documentation](https://gohugo.io/documentation/) for installation and further questions around the framework. Currently, the HUGO version used for generating VSS documentation is `0.103.1`, diff --git a/docs-gen/config.toml b/docs-gen/config.toml index ac9bbcde8..8de348d7d 100644 --- a/docs-gen/config.toml +++ b/docs-gen/config.toml @@ -1,7 +1,7 @@ baseURL = "https://covesa.github.io/vehicle_signal_specification/" languageCode = "en-us" title = "Vehicle Signal Specification" -theme = "learn" +theme = "hugo-theme-relearn" publishDir = "../docs" [params] # Change default color scheme with a variant one. Can be "red", "blue", "green". @@ -24,4 +24,4 @@ weight = 12 # Generation of JSON index to allow search [outputs] -home = [ "HTML", "RSS", "JSON"] +home = ['html', 'rss', 'search', 'searchpage'] diff --git a/docs-gen/content/ecosystem/_index.md b/docs-gen/content/ecosystem/_index.md index 3b0963d80..1bfa0e11a 100644 --- a/docs-gen/content/ecosystem/_index.md +++ b/docs-gen/content/ecosystem/_index.md @@ -1,10 +1,8 @@ --- title: "Ecosystem" date: 2023-05-18T15:12:25+02:00 -chapter: true +chapter: false weight: 40 --- -# Ecosystem - VSS is used in different products, solutions and use cases. This section will give some pointers to the wider VSS ecosystem diff --git a/docs-gen/content/governance/_index.md b/docs-gen/content/governance/_index.md index 65525b2b3..719c560b5 100644 --- a/docs-gen/content/governance/_index.md +++ b/docs-gen/content/governance/_index.md @@ -4,8 +4,6 @@ weight: 15 chapter: false --- -# Governance - The Vehicle Signal Specification (VSS) project is an initiative by [COVESA](https://www.covesa.global/) to define a syntax and a catalog for vehicle signals. The artifacts maintained by the VSS project consist of: @@ -63,7 +61,7 @@ VSS is however an evolving syntax and catalog and there are still areas where ch Changes that breaks backward compatibility are typically introduced only in major releases (e.g. `X.0`) and shall be documented in release notes. This concerns changes to syntax and signals, but also to tools. -The VSS project has introduced a [deprecation concept]({{< ref "../rule_set/basics.md#deprecation-since-version-21" >}}). +The VSS project has introduced a [deprecation concept]({{% ref "../rule_set/basics.md#deprecation-since-version-21" %}}). If possible, when e.g. renaming or moving a signal or changing tools the old signal or parameter set shall be kept but marked as deprecated. That allows the change to be introduced in a minor version (e.g. `X.Y`). The old signal shall be removed first in the next major release, or later if needed. diff --git a/docs-gen/content/introduction/_index.md b/docs-gen/content/introduction/_index.md index c962663c1..0bfe1d156 100644 --- a/docs-gen/content/introduction/_index.md +++ b/docs-gen/content/introduction/_index.md @@ -1,9 +1,7 @@ --- title: Introduction weight: 10 -chapter: true +chapter: false --- -# Introduction - Discover what the Vehicle Signal Specification is all about. diff --git a/docs-gen/content/rule_set/_index.md b/docs-gen/content/rule_set/_index.md index 3487fae70..9a39184fc 100644 --- a/docs-gen/content/rule_set/_index.md +++ b/docs-gen/content/rule_set/_index.md @@ -1,11 +1,9 @@ --- title: Rule Set weight: 20 -chapter: true +chapter: false --- -# Rule Set - The `Rule Set` of a [domain taxonomy](/vehicle_signal_specification/introduction/taxonomy/) is used to describe how to write the data definition syntactically. This chapter defines and describes the rule set for VSS. diff --git a/docs-gen/content/rule_set/data_entry/_index.md b/docs-gen/content/rule_set/data_entry/_index.md index dfc953e2d..5b7f32990 100644 --- a/docs-gen/content/rule_set/data_entry/_index.md +++ b/docs-gen/content/rule_set/data_entry/_index.md @@ -1,11 +1,10 @@ --- title: "Data Entry" date: 2019-08-04T11:11:30+02:00 -chapter: true +chapter: false weight: 2 --- -# Data Entry Leaf nodes of the tree contain metadata describing the data associated to the node. In order to help application developers, who are using the specification, it makes a distinction between three types of signals - [```sensor```](/vehicle_signal_specification/rule_set/data_entry/sensor_actuator/), diff --git a/docs-gen/content/rule_set/data_entry/allowed.md b/docs-gen/content/rule_set/data_entry/allowed.md index 033cb401e..184236b66 100644 --- a/docs-gen/content/rule_set/data_entry/allowed.md +++ b/docs-gen/content/rule_set/data_entry/allowed.md @@ -72,4 +72,4 @@ Example of an invalid array: ## Allowed for struct datatypes -Please see [struct]({{< ref "data_types_struct#allowed-values" >}} ) documentation. +Please see [struct]({{% ref "data_types_struct#allowed-values" %}} ) documentation. diff --git a/docs-gen/themes/hugo-theme-relearn b/docs-gen/themes/hugo-theme-relearn new file mode 160000 index 000000000..7947b8efb --- /dev/null +++ b/docs-gen/themes/hugo-theme-relearn @@ -0,0 +1 @@ +Subproject commit 7947b8efb900ca3d8f6c36c6a49994291587a4da diff --git a/docs-gen/themes/learn b/docs-gen/themes/learn deleted file mode 160000 index 6cfd61e0f..000000000 --- a/docs-gen/themes/learn +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 6cfd61e0f675b45ba85f8325e206d23a4337a14c