chore: fixing docs due to upgrade in Hugo

[Darien-Lin]

Description
After updating the Hugo version, the build of the webpage started failing because of breaking changes from hugo. This required docsy updates and well as resolution of the build.sh (for workarounds) and content updates.

Picture depicted above shows that the local hugo serve shows that the page is rendered correctly.

[gemini-code-assist]

Summary of Changes

Hello @Darien-Lin, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves critical build failures in the documentation system that arose after a Hugo version upgrade. It involved updating the Docsy theme, refactoring its integration to leverage Hugo modules, and introducing specific adjustments to the build process and shortcode usage to ensure compatibility with the newer Hugo environment. Additionally, a minor content correction was made to fix a broken URL.

Highlights

• Hugo Version Upgrade Compatibility: Addressed breaking changes introduced by an upgrade in Hugo, which caused the documentation build to fail.
• Docsy Theme Update: Updated the Docsy theme to version v0.14.1 and adjusted its integration to use Hugo modules.
• Shortcode Handling Fixes: Implemented workarounds in the build script and updated shortcode rendering syntax to comply with Hugo's stricter shortcode requirements.
• Documentation Content Correction: Fixed a broken link within the installation documentation.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• deploy/docs-v2/build.sh
  • Introduced workaround for Hugo's stricter shortcode handling by creating a symlink to the shortcodes directory.
• deploy/webhook-v2/Dockerfile
  • Upgraded Docsy theme to version v0.14.1.
  • Added npm package installation and npm install command to resolve Docsy theme dependencies.
• docs-v2/config.toml
  • Refactored theme import to use Hugo modules instead of the direct theme parameter.
  • Added contentDir configuration for the English language section.
• docs-v2/content/en/docs/install/_index.md
  • Fixed an incorrect URL for the Cloud Code Visual Studio Code installation guide.
• docs-v2/layouts/shortcodes/maturity-table.html
  • Modified shortcode rendering to use partial instead of template for compatibility with newer Hugo versions.

Activity

• No specific activity (comments, reviews, progress) has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively addresses build failures caused by the Hugo upgrade. The changes to update the Docsy theme, adjust Hugo configuration, and fix shortcode handling are all necessary steps. I've provided a few suggestions to further improve the changes:

• In build.sh, I've suggested using a symlink instead of copying files to align with the comment and improve efficiency.
• In the Dockerfile, I've pointed out that the base image is end-of-life and should be updated for security reasons. I also suggested combining RUN layers to optimize the Docker image.
• In config.toml, I've noted a redundant configuration entry that can be removed for better maintainability.
  These are minor points in an otherwise solid PR that fixes the documentation build.

[gemini-code-assist]

The alpine:3.10 base image used in this stage (defined on line 16) has reached its end of life (EOL) and is no longer receiving security updates. It is highly recommended to upgrade to a more recent, supported version of Alpine (e.g., alpine:3.18 or later) to ensure the security of the build environment. This applies to the other stages in this Dockerfile that also use alpine:3.10.

[gemini-code-assist]

The comment on line 26 mentions creating a symlink, but the script uses cp -r to copy the directory, which creates a duplicate. This is less efficient and inconsistent with the comment. Using a symlink is a better approach here as it avoids duplication and aligns with the stated intent.

Additionally, the mkdir -p layouts/partials/shortcodes is not correct for creating a symlink named shortcodes. You only need to ensure the parent directory layouts/partials exists.

Suggested change

	# to prevent changing existing structure, we will copy over the files before hugo invocation.
	mkdir -p layouts/partials/shortcodes
	mkdir -p layouts/partials
	ln -s ../shortcodes layouts/partials/shortcodes

[gemini-code-assist]

To reduce the number of layers in the Docker image and improve build efficiency, it's a good practice to combine consecutive RUN commands. The npm install can be chained with the preceding git operations.

RUN git clone "${DOCSY_URL}" . && \
    git checkout "${DOCSY_VERSION}" && \
    git submodule update --init --recursive --force && \
    npm install && \
    rm -rf .git

[gemini-code-assist]

This contentDir setting is redundant as it's already defined at the top level of the configuration file (on line 17) with the same value. You can remove this line to avoid duplication.