Skip to content

doc path update for kubernetes#791

Merged
CodeWithCJ merged 1 commit intomainfrom
pr-785
Feb 28, 2026
Merged

doc path update for kubernetes#791
CodeWithCJ merged 1 commit intomainfrom
pr-785

Conversation

@CodeWithCJ
Copy link
Owner

Description

Provide a brief summary of your changes.

Related Issue

PR type [ ] Issue [ ] New Feature [ ] Documentation
Linked Issue: #

Checklist

Please check all that apply:

  • Alignment: I have raised a GitHub issue and it was reviewed/approved by maintainers (required for new features).
  • Tests: I have included automated tests for my changes.
  • Screenshots: I have attached "Before" vs "After" screenshots below (required for UI changes).
  • Quality: I have run npm run lint and npm run format (especially for Frontend).
  • Translations: I have only updated the English (en) translation file (if applicable).
  • Architecture: My code follows the existing architecture standards.
  • Database Security: I have updated rls_policies.sql for any new user-specific tables.
  • Integrity: I certify this is my own work, free of malicious code(phishing, malware, etc.)
  • License: I agree to the License terms.

Screenshots (if applicable)

Before

[Insert screenshot/GIF here]

After

[Insert screenshot/GIF here]

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the clarity and accuracy of the Kubernetes installation documentation. It introduces a warning to manage expectations regarding community-contributed Kubernetes and Helm chart support, and corrects a critical link to the Helm chart's README, directing users to the official source on GitHub. These changes aim to improve the user experience by providing transparent information and reliable navigation within the documentation.

Highlights

  • Documentation Update: Added a prominent warning alert to the Kubernetes installation documentation, clarifying that Kubernetes and Helm chart support are community-provided and not officially supported by SparkyFitness maintainers.
  • Link Correction: Updated the link to the Helm chart README in the Kubernetes installation guide to point directly to the GitHub repository, ensuring users access the most current and correct information.
Changelog
  • docs/content/1.install/5.kubernetes.md
    • Added a warning alert regarding the community contribution status of Kubernetes and Helm chart support.
    • Updated the Helm chart README link to point to the GitHub repository.
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Kubernetes installation documentation by adding a warning about the community-supported nature of this feature and fixing a broken link to the Helm chart's README. My review includes a suggestion to further improve the documentation by integrating the README's content directly into the documentation site for a more seamless user experience.

```

For all configuration options (external database, ingress, OIDC, email, etc.) see the [Helm chart README](helm/README.md).
For all configuration options (external database, ingress, OIDC, email, etc.) see the [Helm chart README](https://github.com/CodeWithCJ/SparkyFitness/blob/main/helm/README.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While this change correctly fixes the broken link, it now directs users to a raw file on GitHub. This can create a disjointed experience by taking them away from the documentation site.

For better usability and to keep the documentation self-contained, I recommend integrating the Helm chart's README content directly into the documentation. You could create a new page (e.g., docs/content/1.install/6.helm-chart-configuration.md), copy the content from helm/README.md into it, and then link to that new page from here. This would provide a more integrated and seamless experience for users.

@CodeWithCJ CodeWithCJ merged commit 2721047 into main Feb 28, 2026
2 checks passed
@CodeWithCJ CodeWithCJ deleted the pr-785 branch March 1, 2026 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant