catalog instructions updates #2154
Conversation
Signed-off-by: vishalvivekm <[email protected]>
Signed-off-by: vishalvivekm <[email protected]>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @vishalvivekm, 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!
Summary of Changes
This pull request updates the catalog instructions, specifically within the _includes/catalog-help-modal.html file. The changes introduce more detailed guidance on how to create, import, and publish designs using Meshery Playground and Kanvas. It also updates the styling in _sass/elements.scss to remove the left margin from the <dd> tag.
Highlights
- Catalog Instructions: Detailed instructions added for creating designs from scratch and from templates within Meshery's Kanvas extension.
- Importing Designs: Instructions added for importing designs from local filesystems or remote URLs, supporting Docker Compose, Helm Charts, Meshery Designs, and Kubernetes Manifests.
- Publishing Designs: Instructions added for publishing designs to the Catalog, including the review process and requirements.
- Model Creation/Import: Instructions added for creating models from scratch using CRDs or importing existing models using create widgets.
- Styling Update: Updated the styling in
_sass/elements.scssto remove the left margin from the<dd>tag.
Changelog
- _includes/catalog-help-modal.html
- Replaced the original Meshery UI section with detailed instructions on creating, importing, and publishing designs.
- Added sections for creating designs from scratch and from templates, including relevant images.
- Added a section for importing designs from various sources.
- Added a section for publishing designs to the Catalog.
- Added a section for creating or importing models.
- Removed the video tag.
- _sass/elements.scss
- Added
dl, dd, dtto the list of elements that share the same color and font family. - Removed the left margin from the
<dd>tag.
- Added
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 is currently in preview and 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 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.
A design's journey,
From scratch to the catalog,
Shared for all to use.
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. ↩
✅ Deploy Preview for mesheryio-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Code Review
The pull request updates the catalog instructions, providing more detailed guidance on creating, importing, and publishing designs within Meshery's Kanvas extension. The changes also include some styling updates to improve readability. Overall, the changes seem beneficial for users seeking to understand and utilize the catalog features.
Merge Readiness
The changes in this pull request enhance the user guidance for Meshery's catalog features. Given the review settings, I have focused on identifying medium, high, and critical severity issues. I did not find any issues that meet those criteria. Therefore, I believe this pull request is in good shape to be merged, and I am providing a COMMENT review status. However, I am unable to directly approve the pull request, and other reviewers should also examine the code before merging.
Signed-off-by: Vivek Vishal <[email protected]>
|
is it ready, yet @vishalvivekm ? |
|
@FaheemOnHub is this update duplicative or does it have new info that can be assimilated? |
Only initial 2 sections are same , this one contains bit more info & also the cli info . |
Description
This PR fixes #
Notes for Reviewers
Signed commits