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.

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

Create logic for screenshot capture in mesheryctl ref #5778

Merged
merged 6 commits into from Jul 21, 2022

Conversation

alphaX86
Copy link
Member

@alphaX86 alphaX86 commented Jul 8, 2022

Signed-off-by: Aadhitya A aadhitya864@gmail.com

Description

This PR fixes #5776

Notes for Reviewers
Needs some links to test

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Aadhitya A <aadhitya864@gmail.com>
@github-actions github-actions bot added the component/mesheryctl CLI for Meshery label Jul 8, 2022
@l5io
Copy link
Collaborator

l5io commented Jul 8, 2022

@codecov-commenter
Copy link

codecov-commenter commented Jul 8, 2022

Codecov Report

Merging #5778 (681e29f) into master (25ff1d7) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master   #5778      +/-   ##
=========================================
- Coverage    6.01%   5.97%   -0.05%     
=========================================
  Files         107     107              
  Lines        9851    9924      +73     
=========================================
  Hits          593     593              
- Misses       9101    9174      +73     
  Partials      157     157              
Flag Coverage Δ
gointegrationtests 5.97% <ø> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mesheryctl/internal/cli/root/app/list.go 1.51% <ø> (ø)
mesheryctl/internal/cli/root/app/onboard.go 1.13% <ø> (ø)
mesheryctl/internal/cli/root/app/view.go 2.59% <ø> (ø)
mesheryctl/internal/cli/root/pattern/apply.go 1.29% <ø> (ø)
mesheryctl/internal/cli/root/pattern/list.go 1.51% <ø> (ø)
mesheryctl/internal/cli/root/pattern/view.go 3.27% <ø> (ø)
mesheryctl/internal/cli/root/perf/apply.go 4.70% <ø> (ø)
mesheryctl/internal/cli/root/perf/result.go 1.51% <ø> (ø)
mesheryctl/internal/cli/root/system/check.go 24.05% <ø> (ø)
mesheryctl/internal/cli/root/system/context.go 7.81% <ø> (ø)
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e961524...681e29f. Read the comment docs.

if picLine != "" {
buf.WriteString("## Screenshots\n\n")
buf.WriteString(picLine)
buf.WriteString("\n\n")
Copy link
Member

Choose a reason for hiding this comment

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

Looks like an opportunity to capture a caption.

Example: "Display the list of all available applications."

https://twitter.com/mesheryio/status/1542556666733899776

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, another line to be added then in the logic 🙂

Copy link
Member

Choose a reason for hiding this comment

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

👨‍🎤

@leecalcote leecalcote added this to the v0.6.0 milestone Jul 9, 2022
alphaX86 and others added 3 commits July 10, 2022 22:56
Signed-off-by: Aadhitya A <aadhitya864@gmail.com>
Signed-off-by: Aadhitya A <aadhitya864@gmail.com>
leecalcote
leecalcote previously approved these changes Jul 13, 2022
Copy link
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.

Looking good. Thank you for today's example and demo, @alphaX86

Signed-off-by: Aadhitya A <aadhitya864@gmail.com>
@github-actions github-actions bot added the area/docs Documentation update needed label Jul 14, 2022
@alphaX86
Copy link
Member Author

I have added the pictures which @debo19 gave today... Almost added them in the code and in assets folder now

@alphaX86 alphaX86 requested a review from leecalcote July 14, 2022 17:26
@l5io
Copy link
Collaborator

l5io commented Jul 14, 2022

@leecalcote
Copy link
Member

As I try to hunt down an example of what the screenshot looks like in the deployment preview, I notice that this command doesn't have a screenshot (but a tweet was previously sent, if memory serves correctly) - https://62d052146a2f0d009dc4bb43--meshery-docs-preview.netlify.app/reference/mesheryctl/app/onboard

@leecalcote
Copy link
Member

leecalcote commented Jul 19, 2022

app list
app onboard
app view

I see that you have each of these and more, but don't see them on the docs page.

Please note that all of the screenshots should be pngs, not jpegs.

Signed-off-by: Aadhitya A <aadhitya864@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jul 20, 2022

@leecalcote
Copy link
Member

I don't seem to see the screenshots in the deployment preview...

Copy link
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.

Maybe the screenshots will show up after merge.

@leecalcote leecalcote merged commit c90e0b7 into meshery:master Jul 21, 2022
@alphaX86 alphaX86 deleted the screenshot-add branch July 22, 2022 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed component/mesheryctl CLI for Meshery
Projects
Development

Successfully merging this pull request may close these issues.

[Docs] Create screenshot column in mesheryctl reference section
4 participants