Skip to content

docs: add extension in readme#58

Open
suzy-g38 wants to merge 9 commits into
meshery:masterfrom
suzy-g38:extension-docs
Open

docs: add extension in readme#58
suzy-g38 wants to merge 9 commits into
meshery:masterfrom
suzy-g38:extension-docs

Conversation

@suzy-g38
Copy link
Copy Markdown
Member

Notes for Reviewers

This PR contains information for

  1. Introduction to meshery extensions
  2. Top 6 extensions of meshery with stars(this is chosen based on count of stars)
  3. Links to other docs for extensions

This PR fixes #57

Signed commits

  • Yes, I signed my commits.

Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
Copy link
Copy Markdown
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 comprehensive 'Extensions Section' to the profile/README.md, detailing the organizational structure of Meshery and highlighting several community-driven extensions. A structural HTML issue was identified where an extra closing div tag prematurely terminates the root container, which would disrupt the document's layout and leave orphaned tags later in the file.

Comment thread profile/README.md Outdated
Comment on lines +229 to +230
</div>
</div>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The additional </div> tag on line 230 prematurely closes the root container <div> that begins on line 1. This disrupts the document structure, causing the subsequent 'Community and Contributing' and 'Footer' sections to be rendered outside the main container, and leaves an orphaned closing </div> tag at the end of the file (line 262).

Suggested change
</div>
</div>
</div>

Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
@bhavyamittal06
Copy link
Copy Markdown

@suzy-g38 pretty good add-ons .

Copy link
Copy Markdown

@banana-three-join banana-three-join left a comment

Choose a reason for hiding this comment

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

Top extensions uses H3 headers but it's children use H2 headers and the stars number for the top projects is harded coded when img.shield.io can be used instead, but other than that, it looks good!

@suzy-g38
Copy link
Copy Markdown
Member Author

Top extensions uses H3 headers but it's children use H2 headers and the stars number for the top projects is harded coded when img.shield.io can be used instead, but other than that, it looks good!

will make the changes shortly

Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
@suzy-g38
Copy link
Copy Markdown
Member Author

@chellej @banana-three-join I have fixed the issues, can you check

Copy link
Copy Markdown

@banana-three-join banana-three-join left a comment

Choose a reason for hiding this comment

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

Looks ready to merge!

@matrixkavi
Copy link
Copy Markdown
Contributor

@suzy-g38 - Small review comment: You need to correct the logo url so that it is shown properly:
image

There is no meshery-extensions-logo.svg in the assets folder because of which the image is not rendered properly.

@suzy-g38
Copy link
Copy Markdown
Member Author

@suzy-g38 - Small review comment: You need to correct the logo url so that it is shown properly: image

There is no meshery-extensions-logo.svg in the assets folder because of which the image is not rendered properly.

Sure

Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
Signed-off-by: suzy-g38 <sulagnaghosh52.github@gmail.com>
@suzy-g38
Copy link
Copy Markdown
Member Author

@matrixkavi I have made the changes, can you look into it?

Copy link
Copy Markdown
Contributor

@matrixkavi matrixkavi left a comment

Choose a reason for hiding this comment

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

LGTM

@suzy-g38
Copy link
Copy Markdown
Member Author

suzy-g38 commented May 3, 2026

@banana-three-join @matrixkavi can you merge this pr then?

@matrixkavi
Copy link
Copy Markdown
Contributor

@suzy-g38 Sorry I don't have enough rights to merge. 😖

Copy link
Copy Markdown
Member

@leecalcote leecalcote left a comment

Choose a reason for hiding this comment

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

@sangramrath, assuming that you might get a moment tomorrow to have a look at this (here is what the current changes look like - https://github.com/suzy-g38/.github/blob/e2d44ad565f2493b08903babbc8ff1275a5da37f/profile/README.md)
, I will offer a couple of thoughts that we might want to consider:

  1. I'll suggest that where we should ensure that this readme foremost convey's a description of Meshery Extensions, not Meshery.
  2. @suzy-g38, I'll suggest that we either list all extensions or none at all. The static set of six most popular is will get outdated and is doesn't offer an equal representation.

@suzy-g38
Copy link
Copy Markdown
Member Author

@sangramrath should I go with adding all the extensions, I found there are total 20 extensions or none of them? as initially in the description it mentioned top 5, so based on that I added them. But now each of the case has their own good and bad. Can you suggest me?

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.

[Docs] Enhance Meshery GitHub Org overview with "Extensions" section

5 participants