Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Update Meshery repo README #10770

Open
Yashsharma1911 opened this issue Apr 24, 2024 · 5 comments · May be fixed by #10855
Open

[Docs] Update Meshery repo README #10770

Yashsharma1911 opened this issue Apr 24, 2024 · 5 comments · May be fixed by #10855
Labels
area/docs Documentation update needed framework/jekyll help wanted Extra attention is needed issue/willfix This issue will be worked on language/markdown Issues or pull requests that use Markdown

Comments

@Yashsharma1911
Copy link
Contributor

Current State

In recent months, Meshery has introduced new features and enhanced its UI. However, the current Meshery repository README still displays outdated screenshots and lacks information about the latest features.

Desired State

The Meshery repository should showcase the latest features, include up-to-date screenshots and information.

Implementation

  1. Update the Meshery repository README to serve as a comprehensive user guide.
  2. Replace outdated screenshots and GIFs with those from the latest version of Meshery.
  3. Include additional Meshery features and remove any unnecessary ones from the README.
  4. Take inspiration from any good structured README to restructure existing Meshery repo readme

Contributor Guides and Handbook
@Yashsharma1911 Yashsharma1911 added area/docs Documentation update needed language/markdown Issues or pull requests that use Markdown framework/jekyll issue/willfix This issue will be worked on labels Apr 24, 2024
@Yashsharma1911
Copy link
Contributor Author

Please propose what changes we should make and how we can improve Meshery's existing README

@leecalcote leecalcote added the good first issue Good for newcomers label Apr 25, 2024
@Ashwinip343
Copy link

Hello, I'm interested in working on this issue, but I'm new to contributing, and it would be really helpful if you specify what changes are to be made.

@praduman8435
Copy link

@Yashsharma1911 I would like to contribute to the readme docs . Could you please assign this issue to me?

@praduman8435 praduman8435 linked a pull request May 2, 2024 that will close this issue
Open
1 task
@praduman8435
Copy link

Hey! @leecalcote @Yashsharma1911

I've updated the Meshery README file. Could you please review my pull request #10855 and let me know if any further improvements are needed?

@leecalcote leecalcote added the help wanted Extra attention is needed label May 2, 2024
@praduman8435
Copy link

@Yashsharma1911 , I have updated the PR

@Yashsharma1911 Yashsharma1911 removed the good first issue Good for newcomers label May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs Documentation update needed framework/jekyll help wanted Extra attention is needed issue/willfix This issue will be worked on language/markdown Issues or pull requests that use Markdown
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

improved Readme file praduman8435/meshery
4 participants
@leecalcote @Yashsharma1911 @Ashwinip343 @praduman8435