From 363216f5d589a69ea19fedb50ae9f868ad584263 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Garc=C3=ADa=20Crespo?= Date: Wed, 19 Jul 2023 19:50:14 +0000 Subject: [PATCH] Update hugo from 0.113.0 to 0.115.3 hugo now uses its own modules system so we don't need to import docsy using git submodules. --- .gitmodules | 3 --- hack/make/dep_hugo.mk | 2 +- netlify.toml | 16 ++++++------- website/config.toml | 2 +- website/content/en/docs/development/deps.md | 3 +-- .../content/en/docs/installation/_index.md | 7 +++--- website/go.mod | 5 ++++ website/go.sum | 8 +++++++ website/layouts/swagger/list.html | 23 +++++++++++++++++++ website/themes/docsy | 1 - 10 files changed, 50 insertions(+), 20 deletions(-) delete mode 100644 .gitmodules create mode 100644 website/go.mod create mode 100644 website/go.sum create mode 100644 website/layouts/swagger/list.html delete mode 160000 website/themes/docsy diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 4a9058b7..00000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "website/themes/docsy"] - path = website/themes/docsy - url = https://github.com/google/docsy.git diff --git a/hack/make/dep_hugo.mk b/hack/make/dep_hugo.mk index 8e243f25..6db29170 100644 --- a/hack/make/dep_hugo.mk +++ b/hack/make/dep_hugo.mk @@ -5,7 +5,7 @@ $(call _assert_var,UNAME_ARCH2) $(call _assert_var,CACHE_VERSIONS) $(call _assert_var,CACHE_BIN) -HUGO_VERSION ?= 0.115.2 +HUGO_VERSION ?= 0.115.3 HUGO := $(CACHE_VERSIONS)/hugo/$(HUGO_VERSION) $(HUGO): diff --git a/netlify.toml b/netlify.toml index b5d14d29..dcd3bc2d 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,32 +1,32 @@ [build] base = "website" publish = "public" -command = "git submodule update --init --recursive && hugo --gc --minify" +command = "hugo --gc --minify" ignore = "cd ..; git diff --quiet HEAD^ HEAD ./website ./internal/api/gen/http/openapi.json" [context.split1] -command = "git submodule update --init --recursive && hugo --gc --minify --enableGitInfo" +command = "hugo --gc --minify --enableGitInfo" [context.split1.environment] -HUGO_VERSION = "0.113.0" +HUGO_VERSION = "0.115.3" HUGO_ENV = "production" [context.deploy-preview] -command = "git submodule update --init --recursive && hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL" +command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL" [context.deploy-preview.environment] -HUGO_VERSION = "0.113.0" +HUGO_VERSION = "0.115.3" [context.branch-deploy] -command = "git submodule update --init --recursive && hugo --gc --minify -b $DEPLOY_PRIME_URL" +command = "hugo --gc --minify -b $DEPLOY_PRIME_URL" [context.branch-deploy.environment] -HUGO_VERSION = "รง" +HUGO_VERSION = "0.115.3" [context.next.environment] HUGO_ENABLEGITINFO = "true" [context.production.environment] -HUGO_VERSION = "0.113.0" +HUGO_VERSION = "0.115.3" HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" diff --git a/website/config.toml b/website/config.toml index 307a81b5..8417a146 100644 --- a/website/config.toml +++ b/website/config.toml @@ -4,7 +4,7 @@ title = "Enduro" enableRobotsTXT = true # Hugo allows theme composition (and inheritance). The precedence is from left to right. -theme = ["docsy"] +theme = ["github.com/google/docsy", "github.com/google/docsy/dependencies"] # Will give values to .Lastmod etc. enableGitInfo = true diff --git a/website/content/en/docs/development/deps.md b/website/content/en/docs/development/deps.md index a2e2088c..96f6f330 100644 --- a/website/content/en/docs/development/deps.md +++ b/website/content/en/docs/development/deps.md @@ -28,8 +28,7 @@ Use `npm run deps-minor` to install available updates. The version of Hugo is in `netlify.toml` and `hack/make/dep_hugo.mk`. -Docsy is the Hugo theme (`website/themes/docsy`), installed as a submodule. -We're still using v0.6.0 until we can address the update to Bootstrap 5.2. +Docsy is the Hugo theme (`website/themes/docsy`), installed as a Hugo module. ## Other tools diff --git a/website/content/en/docs/installation/_index.md b/website/content/en/docs/installation/_index.md index 8c3006dd..079ee687 100644 --- a/website/content/en/docs/installation/_index.md +++ b/website/content/en/docs/installation/_index.md @@ -30,9 +30,8 @@ We use MySQL 8, which serves as the data store for Enduro and Temporal. ### Temporal Temporal is the orchestration engine. There are [multiple ways to run a Temporal -Cluster](temporal-clusters). Our standard configuration uses an [Ansible -role](temporal-ansible-role) to deploy both Enduro and Temporal on a remote -server. +Cluster](temporal-clusters). Our standard configuration uses an [Ansible role] +to deploy both Enduro and Temporal on a remote server. More on this topic can be found at the official [Temporal Cluster deployment guide](temporal-deployment). @@ -108,7 +107,7 @@ the API via cURL is `curl -Ls 127.0.0.1:9000/collection | jq`: ``` [temporal-clusters]: https://docs.temporal.io/kb/all-the-ways-to-run-a-cluster -[temporal-ansible-role]: https://github.com/artefactual-labs/ansible-enduro-temporal +[Ansible role]: https://github.com/artefactual-labs/ansible-enduro-temporal [temporal-deployment]: https://docs.temporal.io/cluster-deployment-guide [temporal-web-ui]: https://docs.temporal.io/web-ui [minio-redis-access]: https://docs.min.io/docs/minio-bucket-notification-guide.html#Redis diff --git a/website/go.mod b/website/go.mod new file mode 100644 index 00000000..6d48602d --- /dev/null +++ b/website/go.mod @@ -0,0 +1,5 @@ +module github.com/artefactual-labs/enduro/website + +go 1.20 + +require github.com/google/docsy v0.7.1 // indirect diff --git a/website/go.sum b/website/go.sum new file mode 100644 index 00000000..1069a695 --- /dev/null +++ b/website/go.sum @@ -0,0 +1,8 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY= +github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE= +github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY= +github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc= +github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/website/layouts/swagger/list.html b/website/layouts/swagger/list.html new file mode 100644 index 00000000..9d67295e --- /dev/null +++ b/website/layouts/swagger/list.html @@ -0,0 +1,23 @@ +{{ define "main" }} +
+

{{ .Title }}

+ {{ with .Params.description }}
{{ . | markdownify }}
{{ end }} +
+ {{ partial "taxonomy_terms_article_wrapper.html" . -}} + {{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) -}} + {{ partial "reading-time.html" . -}} + {{ end -}} +
+ {{ .Content }} + {{ partial "section-index.html" . -}} + {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) -}} + {{ partial "feedback.html" .Site.Params.ui.feedback -}} +
+ {{ end -}} + {{ if (.Site.DisqusShortname) -}} +
+ {{ partial "disqus-comment.html" . -}} + {{ end -}} + {{ partial "page-meta-lastmod.html" . -}} +
+{{ end -}} diff --git a/website/themes/docsy b/website/themes/docsy deleted file mode 160000 index 5597d435..00000000 --- a/website/themes/docsy +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5597d435dc74ce68240e0c3871addf24567493b0