Adding a page on Flavors and also fixing minors issues with the image page

[natnesi]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello, 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 significantly enhances the user documentation by introducing a dedicated guide on RDC compute flavors, which clarifies the various options and their characteristics. Concurrently, it refines existing instructional content for launching instances and understanding image types, ensuring a more precise and user-friendly experience across the documentation.

Highlights

• New Documentation Page: A new page titled "Understanding RDC Flavors" has been added, providing comprehensive details on compute flavors, their specifications, naming conventions, and available categories.
• Navigation Update: The navigation menu has been updated to include the newly added "information-about-flavors.md" page.
• Minor Text Corrections: Small textual improvements were made to existing documentation pages, specifically in the instance launch guide and the image information page, to enhance clarity and formatting.

🧠 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

• docs/user-guides/launch-and-manage-instances/.pages.yml
  • Added a new navigation entry for the 'information-about-flavors.md' page.
• docs/user-guides/launch-and-manage-instances/information-about-flavors.md
  • Created a new documentation page detailing RDC compute flavors, including public and RDC-specific flavors, naming conventions, and how to request special flavors.
• docs/user-guides/launch-and-manage-instances/with_the_dashboard/launch-an-instance-via-dashboard.md
  • Updated the instruction for navigating to the 'Instances' section in the dashboard for improved clarity.
• docs/user-guides/upload-and-manage-images/information-about-images.md
  • Adjusted the bullet point formatting for consistency and readability in the descriptions of 'Upstream' and 'Kubernetes images'.

Activity

• No human activity has been recorded on 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 adds a new documentation page for 'Flavors' and fixes some minor issues in existing documentation. My review focuses on the new page, where I've suggested some improvements for consistency and formatting, specifically regarding the use of standard hyphens and removing superfluous whitespace. The other changes are good improvements to existing documentation.

[gemini-code-assist]

The word time‑shared uses a non-breaking hyphen (U+2011) instead of a standard hyphen-minus (U+002D). For consistency and to avoid potential issues with search or text processing, it's better to use the standard hyphen.

Suggested change

Compute flavors define the amount of virtual CPU and memory available to an instance. vCPUs are provided as scheduled resources, meaning they are time‑shared across the underlying physical CPUs and performance can vary depending on overall system load. Memory, on the other hand, is allocated to the instance as a fixed amount and is more tightly constrained by the platform to provide predictable availability for running workloads. This design allows efficient use of shared infrastructure while ensuring applications have reliable access to the memory they request.

Compute flavors define the amount of virtual CPU and memory available to an instance. vCPUs are provided as scheduled resources, meaning they are time-shared across the underlying physical CPUs and performance can vary depending on overall system load. Memory, on the other hand, is allocated to the instance as a fixed amount and is more tightly constrained by the platform to provide predictable availability for running workloads. This design allows efficient use of shared infrastructure while ensuring applications have reliable access to the memory they request.

[gemini-code-assist]

The words compute‑heavy, memory‑heavy, and GPU‑enabled use a non-breaking hyphen (U+2011) instead of a standard hyphen-minus (U+002D). For consistency and to avoid potential issues with search or text processing, it's better to use the standard hyphen.

Suggested change

	- compute‑heavy workloads
	- memory‑heavy workloads
	- small flavors for development and testing
	- GPU‑enabled workloads
	- compute-heavy workloads
	- memory-heavy workloads
	- small flavors for development and testing
	- GPU-enabled workloads

[gemini-code-assist]

This extra blank line can be removed. One blank line is sufficient to separate the list from the following paragraph.

[gemini-code-assist]

These extra blank lines at the end of the file can be removed. It's good practice to have at most one newline at the end of a file.

[github-actions]

Test deployment available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/research-developer-cloud/CID-3799

See all deployed demo sites

[lbrick]

So checking all this locally we run into the first issue where it cant load a partial, now i believe this is due to the include not working within markdown as its normally included in HTML

(mkdocs) kanderson@REA-5CG51721XJ:~/scm/nesi/research-developer-cloud$ mkdocs serve INFO - Building documentation... INFO - [macros] - No default module main` found
INFO - [macros] - Config variables: ['extra', 'config', 'environment', 'plugin', 'git', 'analytics', 'macros',
'filters', 'filters_builtin']
INFO - [macros] - Config macros: ['context', 'macros_info', 'now', 'fix_url']
INFO - [macros] - Config filters: ['pretty', 'relative_url']
INFO - Cleaning site directory
WARNING - [git-revision-date-localized-plugin]
'/home/kanderson/scm/nesi/research-developer-cloud/docs/user-guides/upload-and-manage-images/information-about-images.md'
has no git logs, using current timestamp
WARNING - [macros] - ERROR # Macro Rendering Error

       _File_: `user-guides/launch-and-manage-instances/information-about-flavors.md`

       _TemplateNotFound_: 'partials/support_request.html' not found in search path:
       '/home/kanderson/scm/nesi/research-developer-cloud/docs'

       ```
       Traceback (most recent call last):
         File "/home/kanderson/.venv/mkdocs/lib/python3.12/site-packages/mkdocs_macros/plugin.py", line 688, in render
           return md_template.render(**page_variables)
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
         File "/home/kanderson/.venv/mkdocs/lib/python3.12/site-packages/jinja2/environment.py", line 1295, in render
           self.environment.handle_exception()
         File "/home/kanderson/.venv/mkdocs/lib/python3.12/site-packages/jinja2/environment.py", line 942, in handle_exception
           raise rewrite_traceback_stack(source=source)
         File "<template>", line 43, in top-level template code
         File "/home/kanderson/.venv/mkdocs/lib/python3.12/site-packages/jinja2/loaders.py", line 209, in get_source
           raise TemplateNotFound(
       jinja2.exceptions.TemplateNotFound: 'partials/support_request.html' not found in search path:
       '/home/kanderson/scm/nesi/research-developer-cloud/docs'`

However i dont believe we need this as we do have the contact support button at the top of the menu everywhere, so we could just direct them to that

The other thing is the table is all bung on that new page