Skip to content

Commit

Permalink
Changing hugo theme to relearn
Browse files Browse the repository at this point in the history
Using relearn 6.0.0
Also updating hugo version

Signed-off-by: Erik Jaegervall <[email protected]>
  • Loading branch information
erikbosch committed Jul 23, 2024
1 parent 88b54b8 commit cfc65a0
Show file tree
Hide file tree
Showing 12 changed files with 14 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/buildcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs-gen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
4 changes: 2 additions & 2 deletions docs-gen/config.toml
Original file line number Diff line number Diff line change
@@ -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".
Expand All @@ -24,4 +24,4 @@ weight = 12

# Generation of JSON index to allow search
[outputs]
home = [ "HTML", "RSS", "JSON"]
home = ['html', 'rss', 'search', 'searchpage']
4 changes: 1 addition & 3 deletions docs-gen/content/ecosystem/_index.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 1 addition & 3 deletions docs-gen/content/governance/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.

Expand Down
4 changes: 1 addition & 3 deletions docs-gen/content/introduction/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: Introduction
weight: 10
chapter: true
chapter: false
---

# Introduction

Discover what the Vehicle Signal Specification is all about.
4 changes: 1 addition & 3 deletions docs-gen/content/rule_set/_index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions docs-gen/content/rule_set/data_entry/_index.md
Original file line number Diff line number Diff line change
@@ -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/),
Expand Down
2 changes: 1 addition & 1 deletion docs-gen/content/rule_set/data_entry/allowed.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions docs-gen/themes/hugo-theme-relearn
Submodule hugo-theme-relearn added at 7947b8
1 change: 0 additions & 1 deletion docs-gen/themes/learn
Submodule learn deleted from 6cfd61

0 comments on commit cfc65a0

Please sign in to comment.