Skip to content

Conversation

Paladian78
Copy link
Member

Description

This PR is intended to create a blog post for creating relationships in meshery.

  • It contains instructions on how to test/debug relationships
  • It includes general troubleshooting in different case scenarios

Notes for Reviewers

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Yogendar Singh <singhyogendar78@gmail.com>
Copy link

welcome bot commented Jun 16, 2025

Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, please review the Newcomers' Guide and sure to join the community Slack.
Be sure to double-check that you have signed your commits. Here are instructions for making signing an implicit activity while peforming a commit.

Copy link

netlify bot commented Jun 16, 2025

Deploy Preview for mesheryio-preview ready!

Name Link
🔨 Latest commit 5dc04c1
🔍 Latest deploy log https://app.netlify.com/projects/mesheryio-preview/deploys/685064c3d751530008f7411d
😎 Deploy Preview https://deploy-preview-2245--mesheryio-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

Summary of Changes

Hello @Paladian78, 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 introduces a new blog post aimed at educating users and contributors on how relationships work in Meshery. It covers the different types of relationships, methods for creating them via CLI and UI, steps for testing and debugging, and common troubleshooting scenarios.

Highlights

  • New Blog Post: Adds a new blog post titled "Creating Relationships in Meshery" to the collections directory.
  • Content: Relationship Types: The blog post explains the different types of relationships supported in Meshery: Hierarchical, Edge, and Sibling.
  • Content: Creation Methods: Details are provided on how to create relationships using both the mesheryctl registry generate command and the Meshery UI.
  • Content: Testing and Debugging: Includes a section with multiple steps and tips for testing and debugging relationships within the Meshery UI.
  • Content: Troubleshooting: Offers specific advice for troubleshooting common issues with Parent-Child and Edge relationships, as well as general debugging tips.
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.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini 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 introduces a new blog post about creating relationships in Meshery. The review suggests improvements to clarity, correctness, and formatting, including command examples, link functionality, image accessibility, and grammar.

You can create relationships in Meshery using the `mesheryctl registry generate command`, which takes a spreadsheet as input and generates your models and relationships automatically. To get started, either create a copy of the Meshery integration spreadsheet and add your own entries, or download three separate CSV files named Models, Components, and Relationships with strict naming conventions. This method is ideal if you prefer working from the command line and want to manage your relationships programmatically.

```bash
mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet-cred "[spreadsheet-credential-file]"
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The command example has a missing closing double quote for --spreadsheet-id and uses square brackets for the credential file placeholder. Consider updating for clarity.

Suggested change
mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet-cred "[spreadsheet-credential-file]"
mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred "<path-to-your-spreadsheet-credential-file>"


Get started with the [Contributor's Guide](https://docs.meshery.io/project/contributing/contributing-relationships)

Refer to [User Guide](#)
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The User Guide link (#) is a placeholder. Update it with the correct URL for the relevant User Guide section on relationships.

Suggested change
Refer to [User Guide](#)
Refer to [User Guide](REPLACE_WITH_ACTUAL_USER_GUIDE_LINK_ON_RELATIONSHIPS)

mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet-cred "[spreadsheet-credential-file]"
```
```bash
mesheryctl registry generate --directory &lt;path-to-directory&gt;
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The leading spaces in this command example might be confusing for users copying the command. Clarify that these spaces are for formatting only.

Suggested change
mesheryctl registry generate --directory &lt;path-to-directory&gt;
mesheryctl registry generate --directory <path-to-directory>


Meshery’s UI offers a user-friendly way to create relationships as well. You can upload your CSV files directly through the interface in the kanvas or from the registry, or if you have OCI artifact files for your models, you can upload those too. This approach is great for users who prefer a visual workflow or want to quickly import and manage relationships without using CLI commands.

<img src="/assets/images/posts/2025-06-16-creating-relationships-in-meshery/registry-import.png" style="padding:.5rem;">
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Consider adding a descriptive alt attribute to the <img> tag for accessibility. Using Markdown syntax for images could also improve maintainability.

Suggested change
<img src="/assets/images/posts/2025-06-16-creating-relationships-in-meshery/registry-import.png" style="padding:.5rem;">
![Meshery Registry UI showing model import options](/assets/images/posts/2025-06-16-creating-relationships-in-meshery/registry-import.png)


<img src="/assets/images/posts/2025-06-16-creating-relationships-in-meshery/registry-import.png" style="padding:.5rem;">

<img src="/assets/images/posts/2025-06-16-creating-relationships-in-meshery/kanvas-import.png" style="padding:.5rem;">
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Add a descriptive alt attribute to this <img> tag for accessibility. Consider using Markdown image syntax for better maintainability.

Suggested change
<img src="/assets/images/posts/2025-06-16-creating-relationships-in-meshery/kanvas-import.png" style="padding:.5rem;">
![Meshery Kanvas UI showing component import options](/assets/images/posts/2025-06-16-creating-relationships-in-meshery/kanvas-import.png)


## Contribute and Collaborate with Meshery

Meshery thrives because of its active, welcoming community, and everyone is encouraged to get involved. Check out our existing models, pick one that interests you, and showcase your skills by creating new relationships, every contribution helps Meshery grow and evolve. Whether you’re just exploring or ready to dive in, your participation makes a real difference, so jump in and let’s build something great together
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The sentence contains a comma splice. Consider replacing the comma with a period or semicolon.

Suggested change
Meshery thrives because of its active, welcoming community, and everyone is encouraged to get involved. Check out our existing models, pick one that interests you, and showcase your skills by creating new relationships, every contribution helps Meshery grow and evolve. Whether you’re just exploring or ready to dive in, your participation makes a real difference, so jump in and let’s build something great together
Meshery thrives because of its active, welcoming community, and everyone is encouraged to get involved. Check out our existing models, pick one that interests you, and showcase your skills by creating new relationships. Every contribution helps Meshery grow and evolve. Whether you’re just exploring or ready to dive in, your participation makes a real difference, so jump in and let’s build something great together

Paladian78 and others added 6 commits June 16, 2025 14:52
Signed-off-by: Yogendar Singh <singhyogendar78@gmail.com>
…s-in-meshery.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Paladian78 <singhyogendar78@gmail.com>
…s-in-meshery.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Paladian78 <singhyogendar78@gmail.com>
…s-in-meshery.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Paladian78 <singhyogendar78@gmail.com>
…s-in-meshery.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Paladian78 <singhyogendar78@gmail.com>

<img alt="Kanvas Import Option" src="/assets/images/posts/2025-06-16-creating-relationships-in-meshery/kanvas-import.png" style="padding:.5rem;" width="100%">

## How to test/debug relationships
Copy link
Contributor

@ritesh-karankal ritesh-karankal Aug 27, 2025

Choose a reason for hiding this comment

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

Really helpful blog! Images in the test/debug section might make the steps even easier to understand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants