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] Updating the docs for mesheryctl exp command #11204 #11225

Merged
merged 9 commits into from
Jul 1, 2024
Merged

[Docs] Updating the docs for mesheryctl exp command #11204 #11225

merged 9 commits into from
Jul 1, 2024

Conversation

dusdjhyeon
Copy link
Member

@dusdjhyeon dusdjhyeon commented Jun 21, 2024 •
edited
Loading

Notes for Reviewers

This PR fixes #11204
This PR fixes #11238
/references/mesheryctl

image

@github-actions github-actions bot added area/docs Documentation update needed component/mesheryctl CLI for Meshery labels Jun 21, 2024
@dusdjhyeon dusdjhyeon force-pushed the dusdjhyeon/docs/exp-relationship branch from 01d82bb to 1ed6286 Compare June 21, 2024 00:41
@l5io
Copy link
Collaborator

l5io commented Jun 21, 2024

🚀 Preview for commit 1ed6286 at: https://6674ccc4edf85bf69ead5ba9--meshery-docs-preview.netlify.app

@dusdjhyeon
feat: add docs url
c45f59c 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@dusdjhyeon
docs: add mesheryctl exp table
91ba68e 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@dusdjhyeon
fix: delete duplicate
2f4cf63 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@dusdjhyeon dusdjhyeon force-pushed the dusdjhyeon/docs/exp-relationship branch from f4fa471 to 2f4cf63 Compare June 21, 2024 01:07
@l5io
Copy link
Collaborator

l5io commented Jun 21, 2024

🚀 Preview for commit 2f4cf63 at: https://6674d30fff107bf2733e505a--meshery-docs-preview.netlify.app

leecalcote
leecalcote reviewed Jun 21, 2024
View reviewed changes
docs/pages/reference/mesheryctl-commands.md Outdated
<th>Subcommand</th>
<th>Flag</th>
<th>Subcommand 1</th>
<th>Subcommand 2</th>
Copy link
Member

Choose a reason for hiding this comment

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

@alphaX86 what do you think?

Copy link
Member

Choose a reason for hiding this comment

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

IMO, I think we can just remove the exp from table (we can highlight from the heading before table itself) so we can just put it as Command and Subcommand. // @dusdjhyeon

@leecalcote leecalcote requested a review from alphaX86 June 21, 2024 04:35
@leecalcote
Copy link
Member

@singh1203 will you review?

singh1203
singh1203 reviewed Jun 21, 2024
View reviewed changes
Copy link
Contributor

@singh1203 singh1203 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Also, make sure to have other heading consistent

@dusdjhyeon
Copy link
Member Author

Also, make sure to have other heading consistent

You mean the part about subcommand1 and subcommand2?
If so, what should I do with those when flag replaces subcommand2...

alphaX86
alphaX86 reviewed Jun 21, 2024
View reviewed changes
Copy link
Member

@alphaX86 alphaX86 left a comment

Choose a reason for hiding this comment

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

Changes look good but I need further opinion on table format //@singh1203

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 21, 2024 •
edited
Loading

@l5io
Copy link
Collaborator

l5io commented Jun 21, 2024

🚀 Preview for commit f1ef258 at: https://66756d68a79a9674ff798ef8--meshery-docs-preview.netlify.app

@dusdjhyeon
feat: change exp table structure
516ab02 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@github-actions github-actions bot added area/ci Continuous Integration component/ui User Interface area/lifecycle Lifecycle management (install, uninstall, configure) related component/server area/models Models, Components, Relationships related changes labels Jun 22, 2024
@dusdjhyeon dusdjhyeon marked this pull request as draft June 22, 2024 12:02
@dusdjhyeon dusdjhyeon force-pushed the dusdjhyeon/docs/exp-relationship branch from 95b92c5 to 516ab02 Compare June 22, 2024 12:11
@l5io
Copy link
Collaborator

l5io commented Jun 22, 2024

🚀 Preview for commit 516ab02 at: https://6676bff4a58cfaa7520137e1--meshery-docs-preview.netlify.app

@dusdjhyeon
refactor: delete duplicate
8b70daa 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jun 22, 2024

🚀 Preview for commit 8b70daa at: https://6676c1ca235f9b8dd5a5c3e4--meshery-docs-preview.netlify.app

@dusdjhyeon dusdjhyeon marked this pull request as ready for review June 22, 2024 12:27
singh1203
singh1203 approved these changes Jun 22, 2024
View reviewed changes
Copy link
Contributor

@singh1203 singh1203 left a comment

Choose a reason for hiding this comment

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

LGTM.

@dusdjhyeon dusdjhyeon mentioned this pull request Jun 23, 2024
Closed
@dusdjhyeon
refactor: format func
930e4fe 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jun 24, 2024

🚀 Preview for commit 930e4fe at: https://6678f2093bf94c1e7e4ac533--meshery-docs-preview.netlify.app

@dusdjhyeon
fix: change exp relationship generate docs url
31e48e7 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jun 24, 2024

🚀 Preview for commit 31e48e7 at: https://6678f555faf0e246b90f779b--meshery-docs-preview.netlify.app

@dusdjhyeon
feat: add cmd sub error func
e885092 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jun 24, 2024

🚀 Preview for commit e885092 at: https://6678fce2a58cfa565f0137a1--meshery-docs-preview.netlify.app

alphaX86
alphaX86 requested changes Jun 24, 2024
View reviewed changes
mesheryctl/pkg/utils/error.go Outdated Show resolved Hide resolved
mesheryctl/pkg/utils/error.go Outdated Show resolved Hide resolved
mesheryctl/pkg/utils/error.go Outdated Show resolved Hide resolved
mesheryctl/pkg/utils/error.go Show resolved Hide resolved
@dusdjhyeon
refactor: remove unused function
553a69c 
Signed-off-by: dusdjhyeon <dusdj0813@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jun 25, 2024

🚀 Preview for commit 553a69c at: https://667a11ee39fd8c6415fa47f0--meshery-docs-preview.netlify.app

@vishalvivekm
Copy link
Member

@dusdjhyeon
Let's discuss this in Meshery Dev meeting on Wednesday. Adding this as an agenda item....
Meeting minutes: https://docs.google.com/document/d/1Dg4Uz9rGTuGHmYZwIt47z1j5x3LmnpxD1M1SgypAkQ0/edit?pli=1#
Meeting link: https://meet.layer5.io/meshery

@leecalcote leecalcote merged commit e5c8912 into meshery:master Jul 1, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@singh1203 singh1203 singh1203 approved these changes

@leecalcote leecalcote leecalcote approved these changes

@alphaX86 alphaX86 Awaiting requested review from alphaX86

@aabidsofi19 aabidsofi19 Awaiting requested review from aabidsofi19

Assignees
No one assigned
Labels
area/ci Continuous Integration area/docs Documentation update needed area/lifecycle Lifecycle management (install, uninstall, configure) related area/models Models, Components, Relationships related changes component/mesheryctl CLI for Meshery component/server component/ui User Interface
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[mesheryctl] Formatting duplicate code as a function [Docs] Updating the docs for mesheryctl exp command
7 participants
@dusdjhyeon @l5io @leecalcote @vishalvivekm @alphaX86 @aabidsofi19 @singh1203