Upgrade Hugo #3369

Kalaiselvi84 · 2023-09-08T22:33:20Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug

/kind cleanup

/kind documentation
/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:

Which issue(s) this PR fixes:

Work on #3346

Special notes for your reviewer:

agones-bot · 2023-09-08T23:11:47Z

Build Failed 😱

Build Id: 3cb31877-3bc3-4e61-a24e-f74cdc1af549

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

markmandel · 2023-09-08T23:20:22Z

site/docs/third-party-content/videos-and-presentations/index.html
  target does not exist --- site/docs/third-party-content/videos-and-presentations/index.html --> /css/prism.css
  target does not exist --- site/docs/third-party-content/videos-and-presentations/index.html --> /js/prism.js

I wonder why that is? Those files should (in theory) be coming from the docsy theme 🤔

Kalaiselvi84 · 2023-09-08T23:22:25Z

Targets with no Issue:
make site-server -> https://gist.github.com/Kalaiselvi84/3de02d537f998b79f74932abbf87321e
hugo server -> https://gist.github.com/Kalaiselvi84/2390cc082561579efed898f38ac9dc35
make site-static-preview -> https://gist.github.com/Kalaiselvi84/80e878043979fe0a910e65e2e30c6407

Issue:
Hugo test -> https://gist.github.com/Kalaiselvi84/0ccffae8405ba1bc7dfc37b54874e80f

markmandel · 2023-09-08T23:24:22Z

When you run make site-server does the prism code syntax highlighting work for you locally?

Kalaiselvi84 · 2023-09-08T23:49:11Z

When you run make site-server does the prism code syntax highlighting work for you locally?

both css/prism.css and js/prism.css have 200 OK
https://screenshot.googleplex.com/4H6yJ2reVqYmPSx

https://screenshot.googleplex.com/7JwhtWmTW2WFR6B

Am I answering your question?

markmandel · 2023-09-12T00:28:29Z

You are!

If you look at the source code the page, is there more than one reference to a prism.js ?

Kalaiselvi84 · 2023-09-12T18:11:40Z

I hope that you are referring to the HTML source code that is present in the Elements tab of the web page.

https://screenshot.googleplex.com/6oKRPcvTgpYunsN

Console tab says unable to load a source map file for the "asciinema-player.js" file
https://screenshot.googleplex.com/4w5iM5dxxeP68j9

markmandel · 2023-09-12T18:33:51Z

I hope that you are referring to the HTML source code that is present in the Elements tab of the web page.

Yep! And clicking through to /js/prism.js - that all just works? 🤔 don't know what's up - that's odd it's failing on test.

Kalaiselvi84 · 2023-09-12T20:50:05Z

clicking through to /js/prism.js - that all just works?

yes, the prism.js code is there.
https://screenshot.googleplex.com/9ZYbWNCXbQXc9Dt

markmandel · 2023-09-12T20:58:35Z

The only weird idea I have is that htmltest doesn't like a /from/root path like this when testing a folder? But that also seems weird.

Interesting test: On the old version of the website, is the html source for the prism files the same?

Kalaiselvi84 · 2023-09-12T21:33:19Z

On the old version of the website, is the html source for the prism files the same?

Yes, I have compared js/prism.js between the main branch and this Hugo feature branch, and there are no differences between these two branches

markmandel · 2023-09-12T22:44:42Z

Yes, I have compared js/prism.js between the main branch and this Hugo feature branch, and there are no differences between these two branches

Not the files themselves, but the path to the files in the html source.

If I look at: view-source:https://agones.dev/site/docs/installation/install-agones/yaml/ I see:

<link rel="stylesheet" href="[/site/css/prism.css](https://agones.dev/site/css/prism.css)"/>

So it looks like it's the same.

For the test though we do generate to a local directory as a static copy of the website, so might be worth doing a compare and contrast of what is statically generated.

Kalaiselvi84 · 2023-09-12T23:45:31Z

words are disappearing😅. Pasted the differences in the buganizer ticket

Kalaiselvi84 · 2023-09-13T18:18:40Z

@markmandel

I've tried including different path configurations like 'css' or 'site,' or omitting these two, and I've used 'relURL' or 'absURL' for the prism reference. However, I'm still encountering a failure with the hugo-test target.

markmandel · 2023-09-13T19:34:22Z

Can you push one of the options to this draft PR, so I can have a look?

Kalaiselvi84 · 2023-09-13T20:32:31Z

I included /site/ and used absURL in this PR.
Hugo-test log - https://gist.github.com/Kalaiselvi84/98e9280c3be7f052a834446a4c7386d6

agones-bot · 2023-09-13T21:10:00Z

Build Failed 😱

Build Id: 6af478a8-0187-43d3-8919-d8f55adaae33

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

markmandel

This doesn't solve all the issues (looks like there are a couple of other broken links with the version upgrade), but this solves the prism issues.

Approach taken from https://github.com/google/docsy/blob/5295589fd575084a17774a0e93a12f5708e9b7c4/layouts/partials/head.html#L41 (latest Docsy theme).

markmandel · 2023-09-13T22:38:36Z

site/themes/docsy/layouts/partials/head.html

@@ -34,7 +33,7 @@
 {{end}}
 {{ if .Site.Params.prism_syntax_highlighting }}
 <!-- stylesheet for Prism -->
-<link rel="stylesheet" href="{{ "/css/prism.css" | relURL }}"/>
+<link rel="stylesheet" href="{{ "/site/prism.css" | absURL }}"/>


Suggested change

<link rel="stylesheet" href="{{ "/site/prism.css" | absURL }}"/>

<link rel="stylesheet" href="{{ "css/prism.css" | relURL }}"/>

Updated it. hugo-test failed with two errors. Details: https://gist.github.com/Kalaiselvi84/7f12221fa15b8e8707587039fcba59ec

markmandel · 2023-09-13T22:39:11Z

site/layouts/partials/head.html

 {{- template "_internal/schema.html" . -}}
 {{- template "_internal/twitter_cards.html" . -}}
 {{ if eq (getenv "HUGO_ENV") "production" }}
 {{ template "_internal/google_analytics.html" . }}
 {{ end }}
 {{ if .Site.Params.prism_syntax_highlighting }}
 <!-- stylesheet for Prism -->
-<link rel="stylesheet" href="{{ "/css/prism.css" | relURL }}"/>
+<link rel="stylesheet" href="{{ "/site/prism.css" | absURL }}"/>


Suggested change

<link rel="stylesheet" href="{{ "/site/prism.css" | absURL }}"/>

<link rel="stylesheet" href="{{ "css/prism.css" | relURL }}"/>

Kalaiselvi84 · 2023-09-13T23:10:22Z

Moved the 404.html file to the 'docsy' folder, and the error related to this file is resolved. Is it acceptable to keep the file in this location?

Kalaiselvi84 · 2023-09-13T23:22:57Z

hugo-test is passed. here is the successful log - - https://gist.github.com/Kalaiselvi84/c044264e40b461a5b8db2a7a6f0ebbaf

agones-bot · 2023-09-14T00:29:49Z

Build Succeeded 👏

Build Id: 807a95cf-7750-4a8b-aa10-f7f997559099

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://0253ae1-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3369/head:pr_3369 && git checkout pr_3369
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.35.0-dev-0253ae1-amd64

markmandel · 2023-09-14T20:53:54Z

Moved the 404.html file to the 'docsy' folder, and the error related to this file is resolved. Is it acceptable to keep the file in this location?

We don't actually use the 404, so I think we can delete it!

https://gohugo.io/templates/404/

This is what a 404 looks like for us: https://agones.dev/site/index3.html

markmandel · 2023-09-14T21:31:12Z

Cool cool - let's take a look at the preview when it comes up.

Kalaiselvi84 · 2023-09-14T21:34:59Z

The hugo-test, site-server, site-static, and site-static-preview targets have successfully completed, with the total of two warnings.

markmandel · 2023-09-14T21:37:54Z

The hugo-test, site-server, site-static, and site-static-preview targets have successfully completed, with the total of two warnings.

Sweet! I would like to give a look to see if anything's broken from a rendering perspective as well.

agones-bot · 2023-09-14T23:10:39Z

Build Succeeded 👏

Build Id: 015fac38-ec1a-4076-9c27-d559c9b40767

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://9b1c1be-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3369/head:pr_3369 && git checkout pr_3369
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.35.0-dev-9b1c1be-amd64

markmandel

Clicking through, this looks good!

Next stop 😄 let's try upgrading Docsy once this is merged.

google-oss-prow · 2023-09-14T23:18:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Kalaiselvi84, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Kalaiselvi84 · 2023-09-14T23:25:48Z

Next stop 😄 let's try upgrading Docsy once this is merged.

Could you kindly advise on the most appropriate option for our project from the link?

markmandel · 2023-09-14T23:58:10Z

I know they don't seem to advocate for it, but let's start with a copy of docsy in our folder. I feel like we often need to make changes to the docsy theme, so having our own copy seems like a good idea.

Upgrade Hugo

57ba515

Kalaiselvi84 requested a review from markmandel September 8, 2023 22:33

google-oss-prow bot added do-not-merge/work-in-progress size/S labels Sep 8, 2023

github-actions bot added the kind/cleanup Refactoring code, fixing up documentation, etc label Sep 8, 2023

google-oss-prow bot requested review from cyriltovena and EricFortin September 8, 2023 22:33

change prism reference path

9f6fd60

google-oss-prow bot added size/M and removed size/S labels Sep 13, 2023

Merge branch 'main' into hugo

37425b1

markmandel reviewed Sep 13, 2023

View reviewed changes

path change

a7c4fbc

Kalaiselvi84 added 2 commits September 13, 2023 23:11

move 404.html to docsy

bec7836

change in path ref

b8576cc

Merge branch 'main' into hugo

0253ae1

Kalaiselvi84 marked this pull request as ready for review September 13, 2023 23:25

google-oss-prow bot removed the do-not-merge/work-in-progress label Sep 13, 2023

google-oss-prow bot requested a review from roberthbailey September 13, 2023 23:25

Kalaiselvi84 added 2 commits September 14, 2023 21:30

Delete 404.html

dfbc4d1

Merge branch 'main' into hugo

2ca4420

exclude taxonomyterm

ae875e5

fixed warnings

9b1c1be

markmandel approved these changes Sep 14, 2023

View reviewed changes

google-oss-prow bot assigned markmandel Sep 14, 2023

google-oss-prow bot added the lgtm label Sep 14, 2023

google-oss-prow bot added the approved label Sep 14, 2023

markmandel merged commit c8649e2 into googleforgames:main Sep 14, 2023
2 checks passed

Kalaiselvi84 deleted the hugo branch March 15, 2024 01:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Hugo #3369

Upgrade Hugo #3369

Kalaiselvi84 commented Sep 8, 2023 •

edited

Loading

agones-bot commented Sep 8, 2023

markmandel commented Sep 8, 2023

Kalaiselvi84 commented Sep 8, 2023

markmandel commented Sep 8, 2023

Kalaiselvi84 commented Sep 8, 2023

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023 •

edited

Loading

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023

Kalaiselvi84 commented Sep 13, 2023

markmandel commented Sep 13, 2023

Kalaiselvi84 commented Sep 13, 2023

agones-bot commented Sep 13, 2023

markmandel left a comment

markmandel Sep 13, 2023 •

edited

Loading

Kalaiselvi84 Sep 13, 2023

markmandel Sep 13, 2023

Kalaiselvi84 commented Sep 13, 2023

Kalaiselvi84 commented Sep 13, 2023

agones-bot commented Sep 14, 2023

markmandel commented Sep 14, 2023

markmandel commented Sep 14, 2023

Kalaiselvi84 commented Sep 14, 2023

markmandel commented Sep 14, 2023

agones-bot commented Sep 14, 2023

markmandel left a comment

google-oss-prow bot commented Sep 14, 2023

Kalaiselvi84 commented Sep 14, 2023

markmandel commented Sep 14, 2023

	<link rel="stylesheet" href="{{ "/site/prism.css" \| absURL }}"/>
	<link rel="stylesheet" href="{{ "css/prism.css" \| relURL }}"/>

Upgrade Hugo #3369

Upgrade Hugo #3369

Conversation

Kalaiselvi84 commented Sep 8, 2023 • edited Loading

agones-bot commented Sep 8, 2023

markmandel commented Sep 8, 2023

Kalaiselvi84 commented Sep 8, 2023

markmandel commented Sep 8, 2023

Kalaiselvi84 commented Sep 8, 2023

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023 • edited Loading

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023

markmandel commented Sep 12, 2023

Kalaiselvi84 commented Sep 12, 2023

Kalaiselvi84 commented Sep 13, 2023

markmandel commented Sep 13, 2023

Kalaiselvi84 commented Sep 13, 2023

agones-bot commented Sep 13, 2023

markmandel left a comment

Choose a reason for hiding this comment

markmandel Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

Kalaiselvi84 Sep 13, 2023

Choose a reason for hiding this comment

markmandel Sep 13, 2023

Choose a reason for hiding this comment

Kalaiselvi84 commented Sep 13, 2023

Kalaiselvi84 commented Sep 13, 2023

agones-bot commented Sep 14, 2023

markmandel commented Sep 14, 2023

markmandel commented Sep 14, 2023

Kalaiselvi84 commented Sep 14, 2023

markmandel commented Sep 14, 2023

agones-bot commented Sep 14, 2023

markmandel left a comment

Choose a reason for hiding this comment

google-oss-prow bot commented Sep 14, 2023

Kalaiselvi84 commented Sep 14, 2023

markmandel commented Sep 14, 2023

Kalaiselvi84 commented Sep 8, 2023 •

edited

Loading

Kalaiselvi84 commented Sep 12, 2023 •

edited

Loading

markmandel Sep 13, 2023 •

edited

Loading