docs: update all version references from v1.0.0 to v1.1.0 and tested it #214
Conversation
Signed-off-by: AkarshSahlot <[email protected]>
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Welcome @AkarshSahlot! It looks like this is your first PR to kmesh-net/website 🎉 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @AkarshSahlot, 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 focuses on a significant update to the Kmesh documentation. My primary goal is to transition the documentation from version 1.0 to 1.1, ensuring that users can still access the stable previous version while providing up-to-date content for the latest release. This involves leveraging Docusaurus's versioning features to maintain a clear and organized documentation structure.
Highlights
- Documentation Archiving: The existing Kmesh documentation for version 1.0 has been archived under
versioned_docs/version-1.0/using Docusaurus's built-in versioning capabilities. - Current Documentation Update: The content within the unversioned
docs/folder has been updated to reflect the changes for version 1.1, making it the latest active documentation. - Version Reference Updates: All instances of
v1.0.0references throughout the documentation have been systematically replaced withv1.1.0to align with the new version. - Functionality Verification: The documentation site was verified to build and run locally, and the version selector was confirmed to correctly switch between the archived v1.0 and the latest v1.1 documentation.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request updates documentation version references from v1.0.0 to v1.1.0 across several documentation files. The changes are largely a find-and-replace operation to reflect the new version. While most updates are correct, I've identified a minor inconsistency in an example within the versioning guide. My feedback addresses this to ensure the documentation is accurate and clear for users.
| - **Next**: Latest unreleased changes | ||
| - **2.0**: Documentation for version 2.0 | ||
| - **1.0 (Legacy)**: Documentation for version 1.0 | ||
| - **1.1.0 (Legacy)**: Documentation for version 1.0 |
There was a problem hiding this comment.
The documentation for version 1.1.0 (Legacy) incorrectly states it is for version 1.0. It should be updated to refer to version 1.1.0 for consistency.
| - **1.1.0 (Legacy)**: Documentation for version 1.0 | |
| - **1.1.0 (Legacy)**: Documentation for version 1.1.0 |
|
|
||
| - **Current Version**: This is the latest, actively maintained version of your documentation, stored in the `docs/` folder. It typically represents the "Next" version or the most recent unreleased changes. | ||
| - **Versioned Docs**: These are snapshots of your documentation at specific points in time, usually tied to software releases. They are stored in folders named `versioned_docs/version-<version>/`, such as `versioned_docs/version-1.0/` for version 1.0. | ||
| - **Versioned Docs**: These are snapshots of your documentation at specific points in time, usually tied to software releases. They are stored in folders named `versioned_docs/version-<version>/`, such as `versioned_docs/version-1.1.0/` for version 1.1.0. |
There was a problem hiding this comment.
@LiZhenCheng9527 @AkarshSahlot What's the influence, i am not familiar with this part
Title:
docs: archive v1.0 docs and update documentation for v1.1
Description:
This PR addresses issue #187 by archiving the previous Kmesh documentation for version 1.0 and updating the current documentation to version 1.1.
Changes made:
versioned_docs/version-1.0/using Docusaurus versioning.docs/folder content to reflect changes for version 1.1, including replacing allv1.0.0references withv1.1.0.Why:
Testing:
npm run docusaurus docs:version 1.0.npm run startand confirmed both doc versions load.Please review and merge to keep documentation aligned with the latest software release.
Fixes #187