feat: Introduce repository management documentation, add OtterScale 0… - #50
Conversation
Summary of ChangesHello @KUASWoodyLIN, 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 significantly expands and refines the platform's documentation, primarily by introducing a dedicated section for repository management. It aims to provide users with clear, detailed instructions for handling container images and Helm charts within the registry. Additionally, the update includes an announcement banner for the OtterScale 0.6.0 release and enhances the existing application store configuration guide for improved user experience. Highlights
🧠 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. Using Gemini Code AssistThe 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
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 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
|
….6.0 release banner, and enhance application store configuration details.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces new documentation for repository management, adds a release banner for OtterScale 0.6.0, and enhances the application store documentation. The changes are mostly good, but I've found a few issues in the new repositories.mdx documentation file. There are a couple of broken links that need to be fixed. Also, a command example uses an insecure flag without a proper warning, which could lead users to insecure practices. I've left specific comments with suggestions to address these points.
| docker push <registry_url>/<repository>:<tag> | ||
| ``` | ||
|
|
||
| 3. After uploading, navigate to the [Applications Store](/service/applications/04-store/) to update the Helm chart configuration to use your custom image: |
There was a problem hiding this comment.
The link to the Applications Store appears to be incorrect. Starlight automatically removes number prefixes like 04- from filenames when generating page URLs. Therefore, the file service/applications/04-store.mdx will likely be available at /service/applications/store, not /service/applications/04-store/. Please update the link to ensure it works correctly.
3. After uploading, navigate to the [Applications Store](/service/applications/store) to update the Helm chart configuration to use your custom image:
| helm push <chart_package> oci://<registry_url>/<namespace> --plain-http | ||
| ``` | ||
|
|
||
| 3. After uploading, navigate to the [Applications Store](/service/applications/04-store/) to deploy the Helm chart. |
There was a problem hiding this comment.
The link to the Applications Store appears to be incorrect. Starlight automatically removes number prefixes like 04- from filenames when generating page URLs. Therefore, the file service/applications/04-store.mdx will likely be available at /service/applications/store, not /service/applications/04-store/. Please update the link to ensure it works correctly.
3. After uploading, navigate to the [Applications Store](/service/applications/store) to deploy the Helm chart.
| 2. Upload the downloaded chart: | ||
|
|
||
| ```bash | ||
| helm push <chart_package> oci://<registry_url>/<namespace> --plain-http |
There was a problem hiding this comment.
The use of the --plain-http flag in the helm push command allows for insecure connections to the registry. This poses a security risk in production environments as credentials and chart data are transmitted unencrypted. It is highly recommended to add a warning about the security implications of this flag. Consider using an <Aside> component to alert users.
For example:
<Aside type="caution" title="Security Warning">
The `--plain-http` flag allows insecure connections and should only be used for local development. For production, always use a secure registry with TLS enabled.
</Aside>There was a problem hiding this comment.
Pull request overview
This PR introduces comprehensive repository management documentation, adds a release banner for OtterScale 0.6.0, enhances the application store configuration details with examples, and updates the security card icon for better visual representation.
- Adds new documentation page for managing container images and Helm charts in the private registry
- Enhances the application store installation documentation with detailed YAML configuration examples
- Adds a prominent banner announcing the OtterScale 0.6.0 release
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/service/repositories.mdx | New documentation page explaining repository management, upload instructions for Docker images and Helm charts, and manifest management operations |
| src/content/docs/service/applications/04-store.mdx | Enhanced configuration documentation with detailed YAML example showing common parameters like replicas, resources, and service settings |
| src/content/docs/index.mdx | Added banner announcing OtterScale 0.6.0 release with link to release notes |
| src/content/docs/introduction.mdx | Updated security card icon from "approve-check" to "seti:lock" for better visual consistency |
| astro.config.mjs | Added navigation entry for the new Repositories page with English and Traditional Chinese translations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| You can upload Docker images and Helm charts to the repository via your local terminal. | ||
|
|
||
| <Aside type="tip" title="Registry URL"> | ||
| To obtain the `<registry_url>`, click the **Commands** button on this page or check the **Applications Services** page. |
There was a problem hiding this comment.
The reference to "Applications Services" page is ambiguous. Based on the documentation structure, it's unclear which specific page is being referenced. If this refers to the Services page under Applications (service/applications/02-services.mdx), that page is about Kubernetes Services and doesn't appear to contain registry URL information. Consider clarifying this reference or verifying the correct page name where users can find the registry URL.
| To obtain the `<registry_url>`, click the **Commands** button on this page or check the **Applications Services** page. | |
| To obtain the `<registry_url>`, click the **Commands** button on this page or refer to your platform documentation for the registry URL. |
| template: splash # Remove or comment out this line to display the site sidebar on this page. | ||
| banner: | ||
| content: | | ||
| <strong>🚀 OtterScale has shipped!</strong> — <a href="/whats-new/otterscale-0.6.0/">See what's new in OtterScale 0.6.0</a> |
There was a problem hiding this comment.
The banner links to "/whats-new/otterscale-0.6.0/" but this page doesn't appear to exist in the repository. This will result in a broken link. Either create the corresponding page at src/content/docs/whats-new/otterscale-0.6.0.mdx or update the link to point to an existing page.
| <strong>🚀 OtterScale has shipped!</strong> — <a href="/whats-new/otterscale-0.6.0/">See what's new in OtterScale 0.6.0</a> | |
| <strong>🚀 OtterScale has shipped!</strong> — <a href="/introduction/">See what's new in OtterScale 0.6.0</a> |
| helm push <chart_package> oci://<registry_url>/<namespace> --plain-http | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The helm push example uses the --plain-http flag, which forces Helm to upload charts over unencrypted HTTP even when a TLS-capable registry is available. This exposes chart contents to interception and tampering on the network, enabling an attacker to inject malicious code into deployments. Update the documentation to use secure HTTPS by default (removing --plain-http and/or clearly scoping its use only to explicitly non-sensitive, internal test setups).
| helm push <chart_package> oci://<registry_url>/<namespace> --plain-http | |
| ``` | |
| helm push <chart_package> oci://<registry_url>/<namespace> | |
| ``` | |
| If your registry is configured without TLS for local, non-sensitive testing only, you may add the `--plain-http` flag. Do not use `--plain-http` for production or Internet-exposed registries. |
….6.0 release banner, and enhance application store configuration details.