Skip to content

Commit eda1a98

Browse files
authored
Update theme 2024 05 13 (linode#6944)
* Theme updates - Upgrade Hugo to 0.125.7 - Nested ordered lists now have alphabetical/roman numeral styling - Guides renamed to Cloud Guides & Tutorials in Explore Docs menu * Update Hugo to 0.125.7 in contributing docs and CICD workflows * Rename Guides section page title to Cloud Guides & Tutorials
1 parent 13e87a2 commit eda1a98

File tree

13 files changed

+49
-20
lines changed

13 files changed

+49
-20
lines changed

.github/workflows/update-algolia-on-schedule.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
- name: Set up Hugo
4848
uses: peaceiris/actions-hugo@v2
4949
with:
50-
hugo-version: '0.116.1'
50+
hugo-version: '0.125.7'
5151

5252
- name: Checkout docs repo
5353
uses: actions/checkout@v3

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,18 @@ To Install the latest Node.js LTS release on Windows, navigate to the [downloads
7070

7171
### Install Hugo
7272

73-
The Linode documentation library is built using [Hugo](http://gohugo.io), an open-source static site generator. In order to preview your guide before submission, you need to install Hugo on your local computer. This site currently uses **Hugo v0.116.1**. To remain consistent in the testing and development process, it's recommended to install this version instead of using a newer version.
73+
The Linode documentation library is built using [Hugo](http://gohugo.io), an open-source static site generator. In order to preview your guide before submission, you need to install Hugo on your local computer. This site currently uses **Hugo v0.125.7**. To remain consistent in the testing and development process, it's recommended to install this version instead of using a newer version.
7474

7575
Note: If you observe any issues on a newer version, please [file an issue](https://github.com/linode/docs/issues) in the docs GitHub repository.
7676

7777
#### macOS and Linux
7878

7979
To install Hugo, download the appropriate binary for your system, extract it, and move it to a directory within your PATH.
8080

81-
1. Download the file below that corresponds with the OS and platform on your local system. If you don't see your system on this list, you can find additional files on the [Hugo v0.116.1 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.116.1) under **Assets**.
81+
1. Download the file below that corresponds with the OS and platform on your local system. If you don't see your system on this list, you can find additional files on the [Hugo v0.125.7 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.125.7) under **Assets**.
8282

83-
- **macOS:** https://github.com/gohugoio/hugo/releases/download/v0.116.1/hugo_extended_0.116.1_darwin-universal.tar.gz
84-
- **Linux:** https://github.com/gohugoio/hugo/releases/download/v0.116.1/hugo_extended_0.116.1_Linux-64bit.tar.gz
83+
- **macOS:** https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_darwin-universal.tar.gz
84+
- **Linux:** https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_Linux-64bit.tar.gz
8585

8686
You can download this file through a terminal using the curl command, replacing [url] with the URL for your platform:
8787

@@ -115,7 +115,7 @@ To install Hugo, download the appropriate binary for your system, extract it, an
115115

116116
While macOS and Linux are preferred by most of the core Linode Docs team, it's also possible to use Hugo on Windows.
117117

118-
1. Download the [hugo_extended_0.116.1_windows-amd64.zip](https://github.com/gohugoio/hugo/releases/download/v0.116.1/hugo_extended_0.116.1_windows-amd64.zip) file. Additional files for other operating systems can be found on the [Hugo v0.116.1 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.116.1) under **Assets**.
118+
1. Download the [hugo_extended_0.125.7_windows-amd64.zip](https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_windows-amd64.zip) file. Additional files for other operating systems can be found on the [Hugo v0.125.7 GitHub release page](https://github.com/gohugoio/hugo/releases/tag/v0.125.7) under **Assets**.
119119

120120
1. Extract the file to the directory you'd like to install Hugo under, such as `C:\Hugo\bin`.
121121

@@ -184,10 +184,10 @@ For more information about using Git, refer to the [official Git documentation](
184184
185185
This section is only relevant to contributors who have previously worked on the docs repo prior to the Tailwind v3 upgrade (which occurred on July 6th, 2023 in docs release v1.252.0). After you merge in changes from this release (and onward), you will likely notice display issues when previewing the site locally. This is due to Tailwind v3 and the way it integrates with Hugo (and our theme). To complete the upgrade locally and fix any display issues, follow the steps below.
186186
187-
1. Upgrade Hugo to v0.116.1. On macOS, run the following commands in a temporary folder (not in your docs repo):
187+
1. Upgrade Hugo to v0.125.7. On macOS, run the following commands in a temporary folder (not in your docs repo):
188188
189-
curl -OL https://github.com/gohugoio/hugo/releases/download/v0.116.1/hugo_extended_0.116.1_darwin-universal.tar.gz
190-
tar -xvzf hugo_extended_0.116.1_darwin-universal.tar.gz
189+
curl -OL https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_darwin-universal.tar.gz
190+
tar -xvzf hugo_extended_0.125.7_darwin-universal.tar.gz
191191
mv hugo /usr/local/bin
192192
193193
If you are using a different operating system, refer to the [Install Hugo](#install-hugo) section above.

_vendor/github.com/linode/linode-docs-theme/config.toml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/linode/linode-docs-theme/content/testpages/large-diagram/index.md

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/linode/linode-docs-theme/content/testpages/placeholder.md

+11-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/linode/linode-docs-theme/layouts/partials/sections/search/get-sections-meta.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/linode/linode-docs-theme/layouts/shortcodes/command.html

+10-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/linode/linode-docs-theme/tailwind.config.js

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/modules.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316
1+
# github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530
22
# github.com/linode/linode-website-partials v0.0.0-20240426140442-12b76ccbfefd
33
# github.com/gohugoio/hugo-mod-jslibs-dist/alpinejs/v3 v3.401.201
44
# github.com/gohugoio/hugo-mod-jslibs/turbo/v7 v7.20300.20000

docs/guides/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Linode Guides & Tutorials"
2+
title: "Cloud Guides & Tutorials"
33
license: "[CC BY-ND 4.0](http://creativecommons.org/licenses/by-nd/4.0/)"
44
linkTitle: "Guides"
55
---

go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ go 1.15
55
require (
66
github.com/hotwired/turbo v7.0.1+incompatible // indirect
77
github.com/linode/linode-api-docs/v4 v4.175.0 // indirect
8-
github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316 // indirect
8+
github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530 // indirect
99
)

go.sum

+2
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,8 @@ github.com/linode/linode-docs-theme v0.0.0-20240503183252-c77f4f3e7a33 h1:xPjk1t
267267
github.com/linode/linode-docs-theme v0.0.0-20240503183252-c77f4f3e7a33/go.mod h1:4bKPhuT/oYHgkQNryyd/F9NF5z98jBf19PYmSnDlUdM=
268268
github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316 h1:cF+xtZZDuROvuLhY8de5Fa/fGdGkvNDOpeYT8Wby3NU=
269269
github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316/go.mod h1:4bKPhuT/oYHgkQNryyd/F9NF5z98jBf19PYmSnDlUdM=
270+
github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530 h1:T8JRWQpBuQmuiLlIm86NfIwgU9sLX+P38JdmSmuYGGM=
271+
github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530/go.mod h1:4bKPhuT/oYHgkQNryyd/F9NF5z98jBf19PYmSnDlUdM=
270272
github.com/linode/linode-website-partials v0.0.0-20221205205120-b6ea1aaa59fb/go.mod h1:K1Em3lwb16JiCwNVftAFwWGhyB9Zkl/nXhxjBBUC1Ao=
271273
github.com/linode/linode-website-partials v0.0.0-20221222200538-99862e429110/go.mod h1:K1Em3lwb16JiCwNVftAFwWGhyB9Zkl/nXhxjBBUC1Ao=
272274
github.com/linode/linode-website-partials v0.0.0-20230201145731-a8703d0a954a/go.mod h1:K1Em3lwb16JiCwNVftAFwWGhyB9Zkl/nXhxjBBUC1Ao=

netlify.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ publish = "public"
33
command = "hugo version && hugo config && hugo --gc --minify -d public/docs;"
44

55
[context.production.environment]
6-
HUGO_VERSION = "0.116.1"
6+
HUGO_VERSION = "0.125.7"
77
HUGO_PARAMS_TESTENV="Netlify"
88

99
[context.deploy-preview.environment]
10-
HUGO_VERSION = "0.116.1"
10+
HUGO_VERSION = "0.125.7"
1111
HUGO_PARAMS_TESTENV="Netlify"
1212

1313
[[plugins]]

0 commit comments

Comments
 (0)