Upgrade Docsy #3382

Kalaiselvi84 · 2023-09-15T16:59:24Z

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:

Closes #

Special notes for your reviewer:

google-oss-prow · 2023-09-15T16:59:33Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Kalaiselvi84
Once this PR has been reviewed and has the lgtm label, please assign roberthbailey for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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-15T17:10:43Z

@markmandel
I've tried three ways to upgrade Docsy,

Copied latest version of Docsy to site/themes, but I encountered a rendering issue - https://gist.github.com/Kalaiselvi84/86cbb64e00aa4bf3657817a09bf9867b
Error received when followed the migrating to Hugo modules approach - https://gist.github.com/Kalaiselvi84/69383165776fc8d7cd450cbc770f6853
Successfully updated Docsy using Hugo modules, and now the site-server, site-static, hugo server, and hugo-test targets are passing.

Could you please share your thoughts?

markmandel · 2023-09-15T17:47:22Z

Let's see what the preview looks like!

site/go.mod

agones-bot · 2023-09-15T18:21:54Z

Build Succeeded 👏

Build Id: 6d614fcf-28b4-4661-9233-d128a53475d6

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://f56d6c9-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3382/head:pr_3382 && git checkout pr_3382
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-f56d6c9-amd64

markmandel · 2023-09-15T18:44:43Z

Copied latest version of Docsy to site/themes, but I encountered a rendering issue - https://gist.github.com/Kalaiselvi84/86cbb64e00aa4bf3657817a09bf9867b

With this approach - did you attempt to resolve the issues within the .md files? If so, where did you end up?

Kalaiselvi84 · 2023-09-15T22:10:00Z

Followed all the Migrate to hugo modules instructions except this command hugo mod init github.com/me-at-github/my-existing-site. To resolve the below error, deleted the vendor folder from the site directory

go: can't compute 'all' using the vendor directory
	(Use -mod=mod or -mod=readonly to bypass.)
Error: failed to load modules: failed to list modules: failed to execute 'go [list -m -json all]': failed to execute binary "go" with args [list -m -json all]: go: can't compute 'all' using the vendor directory
	(Use -mod=mod or -mod=readonly to bypass.)
 *errors.errorString

All the targets passed successfully, after resolving the error. However, the Agones site's front page doesn't appear as expected,
https://screenshot.googleplex.com/3bQFi6d4JsugDgX

markmandel

Seems like some CSS changes in our custom landing page.

How's you CSS? 😃

markmandel · 2023-09-15T22:29:15Z

site/go.mod

@@ -3,3 +3,5 @@ module github.com/agones/agones/site
 go 1.20


Apache header please.

markmandel · 2023-09-15T22:29:43Z

site/hugo.toml

@@ -17,7 +17,7 @@ title = "Agones"
 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"]


Should we delete the layouts/docsy folder as well?

markmandel · 2023-09-15T22:30:02Z

.github/ISSUE_TEMPLATE/kubernetes_update.md

@@ -30,7 +30,7 @@ List of items to do for upgrading to {version_1} {version_2} {version_3}
 - [ ] Regenerate Kubernetes resource includes (e.g. ObjectMeta, PodTemplateSpec)
    - [ ] Start a cluster with `make gcloud-test-cluster` (this cluster will use Kubernetes {version_2}), uninstall agones using `helm uninstall agones -n agones-system`, and then run  `make gen-embedded-openapi` and `make gen-install`
 - [ ] Update documentation for creating clusters and k8s API references to align with the above clusters versions and the k8s API version
-    - [ ] `site/config.toml`
+    - [ ] `site/hugo.toml`


Is this value in the hugo.toml? Looks like it's still in config.toml?

Kalaiselvi84 · 2023-09-15T22:58:31Z

Seems like some CSS changes in our custom landing page.

How's you CSS? 😃

Please let me know the required changes. Will do it🙂

markmandel · 2023-09-15T23:34:08Z

Sounds good - will check out the preview and see what the differences are!

agones-bot · 2023-09-15T23:55:08Z

Build Failed 😱

Build Id: 1b9c72e8-0a15-4871-b9e3-eb4c20aa6e89

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

agones-bot · 2023-09-16T00:17:45Z

Build Failed 😱

Build Id: 937c2611-38d2-4d6e-b66c-d5af5fd1c66c

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

markmandel · 2023-09-18T18:22:08Z

That's a weird one:

	helm upgrade --install --atomic --wait --namespace=agones-system \
	--create-namespace \
	--set agones.image.tag=1.35.0-dev-8c189bb,agones.image.registry="us-docker.pkg.dev/agones-images/ci" \
	--set agones.image.controller.pullPolicy="Always",agones.image.controller.pullSecret= \
	--set agones.image.extensions.pullPolicy="Always",agones.image.allocator.pullPolicy="Always" \
	--set agones.image.ping.pullPolicy="Always",agones.image.sdk.alwaysPull=true \
	--set agones.ping.http.serviceType="LoadBalancer",agones.ping.udp.serviceType="LoadBalancer" \
	--set agones.allocator.service.serviceType="LoadBalancer" \
	--set agones.controller.logLevel="debug" \
	--set agones.crds.cleanupOnDelete=true \
	--set agones.featureGates="PlayerAllocationFilter=true&PlayerTracking=true&ResetMetricsOnDelete=false&PodHostname=false&SplitControllerAndExtensions=false&FleetAllocationOverflow=true&CountsAndLists=true&Example=true" \
	--set agones.allocator.service.loadBalancerIP=34.139.170.120 \
	--set agones.metrics.serviceMonitor.enabled=false \
	 \
	agones /go/src/agones.dev/agones/install/helm/agones/
Release "agones" does not exist. Installing it now.
Error: release agones failed, and has been uninstalled due to atomic being set: services "agones-allocator" not found

Not seen that before as a flake. Happened on generic-1.27

agones-bot · 2023-09-25T21:29:33Z

Build Succeeded 👏

Build Id: ae51576a-9b9b-4504-b9ae-d6c38098840d

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://309d7b9-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3382/head:pr_3382 && git checkout pr_3382
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-309d7b9-amd64

markmandel · 2023-09-28T20:22:39Z

This is getting really close!

Kalaiselvi84 · 2023-09-28T21:57:37Z

The current change looks good in the smaller screen. However, if we increase the gap between the tools, the bigger screen will look good, but the smaller screen will look messy. Share your thoughts please..

Kalaiselvi84 · 2023-09-29T17:08:34Z

Are we planning to keep the docsy folder to avoid the issue in the release process?

markmandel · 2023-09-29T17:47:31Z

Are we planning to keep the docsy folder to avoid the issue in the release process?

I'm not convinced that was the issue specifically.

I'd still like to keep the docsy folder as it allows us to make patches to docsy without having to first get them pushed upstream.

This reverts commit 8c189bb.

agones-bot · 2023-09-29T20:00:03Z

Build Succeeded 👏

Build Id: 4594ea63-ed8f-4a4f-841e-b89063dd1d16

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://c28c58b-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3382/head:pr_3382 && git checkout pr_3382
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-c28c58b-amd64

markmandel · 2023-09-29T20:54:09Z

Are we planning to keep the docsy folder to avoid the issue in the release process?

Sorry I should have asked a clarifying question: In this PR we using the theme site/themes/docsy - I just saw it go back in, so I'm assuming that we aren't? And we're integrating it another way?

It looks like we migrated to using Hugo modules? If that's the case, then yeah - delete the docsy folder if we're not using it anymore. Sorry, I should have asked that first.

Kalaiselvi84 · 2023-09-29T21:17:56Z

It looks like we migrated to using Hugo modules? If that's the case, then yeah - delete the docsy folder if we're not using it anymore.

Yes, migrated to Hugo modules: https://www.docsy.dev/docs/updating/convert-site-to-module/. However, the site-static target requires the agones/site/themes/docsy/assets/vendor/Font-Awesome/scss folder. Is it good to keep the docsy folder?

markmandel · 2023-09-29T21:47:54Z

However, the site-static target requires the agones/site/themes/docsy/assets/vendor/Font-Awesome/scss folder

Why does it need it? Seems like it shouldn't be required anymore?

Kalaiselvi84 · 2023-09-29T21:56:24Z

Why does it need it? Seems like it shouldn't be required anymore?

Will delete it. This is not necessary as we are initially cleaning up the working directory in build script?

markmandel · 2023-09-29T22:00:21Z

Will delete it. This is not necessary as we are initially cleaning up the working directory in build script?

Well if we're not using that folder for anything for generating the website, then we don't need the folder 👍🏻

The build script doesn't affect any of this - the updated version uses whatever is latest from main as the code to run. So if the tool runs on Ci and local, it will work there.

Kalaiselvi84 · 2023-10-03T16:45:00Z

I've attempted various alignment methods for the Agones title, description, and asciinema-player on the landing page. While the alignment appears satisfactory on a laptop screen, it doesn't translate as well to larger screens.

For reference, here are the different alignment methods I've tried with @media: https://gist.github.com/Kalaiselvi84/3bde60bf8158b9100508095c8f0c3ab7

Based on the latest preview available at https://c28c58b-dot-preview-dot-agones-images.appspot.com/, the alignment seems acceptable on both screens.

Should we proceed with this current configuration? WDYT?

agones-bot · 2023-10-03T17:21:41Z

Build Succeeded 👏

Build Id: e86f756c-9e64-40d1-aa95-a34100dc2fd9

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://f1699b2-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3382/head:pr_3382 && git checkout pr_3382
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.36.0-dev-f1699b2-amd64

markmandel · 2023-10-03T20:28:32Z

Should we proceed with this current configuration? WDYT?

I think I might need to download this and see what playing around with the CSS rules will do 😃

A couple of things of note if you have some good ideas on (and so I don't forget), and are probably the biggest issues I see:

In the header

The "AGONES" should be bold. This is what the current website looks like:

Should be a case of setting the font weight appropriately.

Front page

That big gap between the console and the "Host, Run and Scale dedicated game servers on Kubernetes"

There are some other layout differences, but nothing I think we need to be huge blockers on.

Only other thought - the Community Page (preview) seems to have the wide layout. We could check the source code there to see how they are doing that (if we want to go wide that is).

Kalaiselvi84 · 2023-10-05T01:11:06Z

I believe I might be overlooking a detail. I attempted to use the command hugo mod init github.com/me-at-github/my-existing-site. Specifically, I tried variations such as hugo mod init github.com/googleforgames/agones/tree/main/site and hugo mod init github.com/kalaiselvi84/agones/tree/main/site. Reference-https://www.docsy.dev/docs/updating/convert-site-to-module/

However, I received the following error:

go: /usr/local/google/home/kalaiselvim/Desktop/agones/site/go.mod already exists
Error: failed to init modules: failed to execute 'go [mod init github.com/kalaiselvi84/agones/tree/main/site]': failed to execute binary "go" with args [mod init github.com/kalaiselvi84/agones/tree/main/site]: go: /usr/local/google/home/kalaiselvim/Desktop/agones/site/go.mod already exists
 *errors.errorString

I've ignored this error because the error message indicates that go.mod already exists. I am unsure if this could be a problem?

markmandel · 2023-10-05T22:01:10Z

I believe I might be overlooking a detail. I attempted to use the command hugo mod init github.com/me-at-github/my-existing-site. Specifically, I tried variations such as hugo mod init github.com/googleforgames/agones/tree/main/site and hugo mod init github.com/kalaiselvi84/agones/tree/main/site. Reference-https://www.docsy.dev/docs/updating/convert-site-to-module/

Curious - why? 😃

Kalaiselvi84 · 2023-10-06T16:28:32Z

I believe I might be overlooking a detail. I attempted to use the command hugo mod init github.com/me-at-github/my-existing-site. Specifically, I tried variations such as hugo mod init github.com/googleforgames/agones/tree/main/site and hugo mod init github.com/kalaiselvi84/agones/tree/main/site. Reference-https://www.docsy.dev/docs/updating/convert-site-to-module/

Curious - why? 😃

I've corrected the error and included the appropriate go.mod and go.sum files in the latest PR. Apologies for the oversight..

markmandel · 2023-10-06T20:23:15Z

Filed Kalaiselvi84#325 against your branch, that I believe fixes all the issues.

PTAL and let me know if you see anything missing!

Kalaiselvi84 · 2023-10-12T01:09:07Z

Closing this PR, since the task has been completed in another PR: #3417

Upgrade Docsy

f56d6c9

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

google-oss-prow bot requested a review from cyriltovena September 15, 2023 16:59

google-oss-prow bot added the size/XS label Sep 15, 2023

google-oss-prow bot requested a review from EricFortin September 15, 2023 16:59

Kalaiselvi84 requested review from markmandel and removed request for cyriltovena and EricFortin September 15, 2023 16:59

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

markmandel reviewed Sep 15, 2023

View reviewed changes

site/go.mod Show resolved Hide resolved

followed migrate to hugo modules instructions

3c1b6d2

google-oss-prow bot added size/S and removed size/XS labels Sep 15, 2023

markmandel reviewed Sep 15, 2023

View reviewed changes

Kalaiselvi84 added 3 commits September 15, 2023 22:30

Merge branch 'main' into docsy

1a7852f

year changed in apache copyright

b7a54f4

delete site/themes/docsy

8c189bb

google-oss-prow bot added size/XXL and removed size/S labels Sep 15, 2023

Revert "delete site/themes/docsy"

c28c58b

This reverts commit 8c189bb.

google-oss-prow bot added size/M and removed size/XXL labels Sep 29, 2023

Merge branch 'main' into docsy

b00129c

Kalaiselvi84 added 2 commits October 3, 2023 16:16

Merge branch 'main' into docsy

b1576a0

delete site/themes/docsy

f1699b2

google-oss-prow bot added size/XXL and removed size/M labels Oct 3, 2023

Kalaiselvi84 mentioned this pull request Oct 9, 2023

Various Fixes Kalaiselvi84/agones#325

Closed

Kalaiselvi84 closed this Oct 12, 2023

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Docsy #3382

Upgrade Docsy #3382

Kalaiselvi84 commented Sep 15, 2023

google-oss-prow bot commented Sep 15, 2023

Kalaiselvi84 commented Sep 15, 2023

markmandel commented Sep 15, 2023

agones-bot commented Sep 15, 2023

markmandel commented Sep 15, 2023

Kalaiselvi84 commented Sep 15, 2023 •

edited

Loading

markmandel left a comment

markmandel Sep 15, 2023

markmandel Sep 15, 2023

markmandel Sep 15, 2023

Kalaiselvi84 commented Sep 15, 2023

markmandel commented Sep 15, 2023

agones-bot commented Sep 15, 2023

agones-bot commented Sep 16, 2023

markmandel commented Sep 18, 2023

agones-bot commented Sep 25, 2023

markmandel commented Sep 28, 2023

Kalaiselvi84 commented Sep 28, 2023

Kalaiselvi84 commented Sep 29, 2023

markmandel commented Sep 29, 2023

agones-bot commented Sep 29, 2023

markmandel commented Sep 29, 2023

Kalaiselvi84 commented Sep 29, 2023

markmandel commented Sep 29, 2023

Kalaiselvi84 commented Sep 29, 2023

markmandel commented Sep 29, 2023

Kalaiselvi84 commented Oct 3, 2023

agones-bot commented Oct 3, 2023

markmandel commented Oct 3, 2023

Kalaiselvi84 commented Oct 5, 2023 •

edited

Loading

markmandel commented Oct 5, 2023

Kalaiselvi84 commented Oct 6, 2023

markmandel commented Oct 6, 2023

Kalaiselvi84 commented Oct 12, 2023

Upgrade Docsy #3382

Upgrade Docsy #3382

Conversation

Kalaiselvi84 commented Sep 15, 2023

google-oss-prow bot commented Sep 15, 2023

Kalaiselvi84 commented Sep 15, 2023

markmandel commented Sep 15, 2023

agones-bot commented Sep 15, 2023

markmandel commented Sep 15, 2023

Kalaiselvi84 commented Sep 15, 2023 • edited Loading

markmandel left a comment

Choose a reason for hiding this comment

markmandel Sep 15, 2023

Choose a reason for hiding this comment

markmandel Sep 15, 2023

Choose a reason for hiding this comment

markmandel Sep 15, 2023

Choose a reason for hiding this comment

Kalaiselvi84 commented Sep 15, 2023

markmandel commented Sep 15, 2023

agones-bot commented Sep 15, 2023

agones-bot commented Sep 16, 2023

markmandel commented Sep 18, 2023

agones-bot commented Sep 25, 2023

markmandel commented Sep 28, 2023

Kalaiselvi84 commented Sep 28, 2023

Kalaiselvi84 commented Sep 29, 2023

markmandel commented Sep 29, 2023

agones-bot commented Sep 29, 2023

markmandel commented Sep 29, 2023

Kalaiselvi84 commented Sep 29, 2023

markmandel commented Sep 29, 2023

Kalaiselvi84 commented Sep 29, 2023

markmandel commented Sep 29, 2023

Kalaiselvi84 commented Oct 3, 2023

agones-bot commented Oct 3, 2023

markmandel commented Oct 3, 2023

In the header

Front page

Kalaiselvi84 commented Oct 5, 2023 • edited Loading

markmandel commented Oct 5, 2023

Kalaiselvi84 commented Oct 6, 2023

markmandel commented Oct 6, 2023

Kalaiselvi84 commented Oct 12, 2023

Kalaiselvi84 commented Sep 15, 2023 •

edited

Loading

Kalaiselvi84 commented Oct 5, 2023 •

edited

Loading