Skip to content

Commit

Permalink
Update theme 2024 05 13 (#6944)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
nmelehan committed May 13, 2024
1 parent 13e87a2 commit eda1a98
Show file tree
Hide file tree
Showing 13 changed files with 49 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update-algolia-on-schedule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
- name: Set up Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.116.1'
hugo-version: '0.125.7'

- name: Checkout docs repo
uses: actions/checkout@v3
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,18 @@ To Install the latest Node.js LTS release on Windows, navigate to the [downloads

### Install Hugo

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.
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.

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.

#### macOS and Linux

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

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**.
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**.

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

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

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

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

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**.
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**.

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

Expand Down Expand Up @@ -184,10 +184,10 @@ For more information about using Git, refer to the [official Git documentation](

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.

1. Upgrade Hugo to v0.116.1. On macOS, run the following commands in a temporary folder (not in your docs repo):
1. Upgrade Hugo to v0.125.7. On macOS, run the following commands in a temporary folder (not in your docs repo):

curl -OL https://github.com/gohugoio/hugo/releases/download/v0.116.1/hugo_extended_0.116.1_darwin-universal.tar.gz
tar -xvzf hugo_extended_0.116.1_darwin-universal.tar.gz
curl -OL https://github.com/gohugoio/hugo/releases/download/v0.125.7/hugo_extended_0.125.7_darwin-universal.tar.gz
tar -xvzf hugo_extended_0.125.7_darwin-universal.tar.gz
mv hugo /usr/local/bin

If you are using a different operating system, refer to the [Install Hugo](#install-hugo) section above.
Expand Down
2 changes: 1 addition & 1 deletion _vendor/github.com/linode/linode-docs-theme/config.toml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion _vendor/modules.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316
# github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530
# github.com/linode/linode-website-partials v0.0.0-20240426140442-12b76ccbfefd
# github.com/gohugoio/hugo-mod-jslibs-dist/alpinejs/v3 v3.401.201
# github.com/gohugoio/hugo-mod-jslibs/turbo/v7 v7.20300.20000
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Linode Guides & Tutorials"
title: "Cloud Guides & Tutorials"
license: "[CC BY-ND 4.0](http://creativecommons.org/licenses/by-nd/4.0/)"
linkTitle: "Guides"
---
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ go 1.15
require (
github.com/hotwired/turbo v7.0.1+incompatible // indirect
github.com/linode/linode-api-docs/v4 v4.175.0 // indirect
github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316 // indirect
github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530 // indirect
)
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,8 @@ github.com/linode/linode-docs-theme v0.0.0-20240503183252-c77f4f3e7a33 h1:xPjk1t
github.com/linode/linode-docs-theme v0.0.0-20240503183252-c77f4f3e7a33/go.mod h1:4bKPhuT/oYHgkQNryyd/F9NF5z98jBf19PYmSnDlUdM=
github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316 h1:cF+xtZZDuROvuLhY8de5Fa/fGdGkvNDOpeYT8Wby3NU=
github.com/linode/linode-docs-theme v0.0.0-20240503183507-a183b1963316/go.mod h1:4bKPhuT/oYHgkQNryyd/F9NF5z98jBf19PYmSnDlUdM=
github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530 h1:T8JRWQpBuQmuiLlIm86NfIwgU9sLX+P38JdmSmuYGGM=
github.com/linode/linode-docs-theme v0.0.0-20240513153907-436b4af1f530/go.mod h1:4bKPhuT/oYHgkQNryyd/F9NF5z98jBf19PYmSnDlUdM=
github.com/linode/linode-website-partials v0.0.0-20221205205120-b6ea1aaa59fb/go.mod h1:K1Em3lwb16JiCwNVftAFwWGhyB9Zkl/nXhxjBBUC1Ao=
github.com/linode/linode-website-partials v0.0.0-20221222200538-99862e429110/go.mod h1:K1Em3lwb16JiCwNVftAFwWGhyB9Zkl/nXhxjBBUC1Ao=
github.com/linode/linode-website-partials v0.0.0-20230201145731-a8703d0a954a/go.mod h1:K1Em3lwb16JiCwNVftAFwWGhyB9Zkl/nXhxjBBUC1Ao=
Expand Down
4 changes: 2 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ publish = "public"
command = "hugo version && hugo config && hugo --gc --minify -d public/docs;"

[context.production.environment]
HUGO_VERSION = "0.116.1"
HUGO_VERSION = "0.125.7"
HUGO_PARAMS_TESTENV="Netlify"

[context.deploy-preview.environment]
HUGO_VERSION = "0.116.1"
HUGO_VERSION = "0.125.7"
HUGO_PARAMS_TESTENV="Netlify"

[[plugins]]
Expand Down

0 comments on commit eda1a98

Please sign in to comment.