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

[Fix Docs] Tutorial: Exploring Kubernetes CronJobs with Meshery Playground #10107

Merged
merged 24 commits into from Apr 19, 2024

Conversation

sandramsc
Copy link
Member

This PR fixes #9833

Signed commits

  • Yes, I signed my commits.

… - deploying a web app content without step 7 (deployment step)

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@github-actions github-actions bot added the area/docs Documentation update needed label Jan 26, 2024
Copy link

github-actions bot commented Jan 26, 2024

@l5io
Copy link
Collaborator

l5io commented Jan 26, 2024

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jan 27, 2024

…ocess - section completed

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jan 27, 2024

@l5io
Copy link
Collaborator

l5io commented Feb 4, 2024

@l5io
Copy link
Collaborator

l5io commented Feb 9, 2024

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Feb 10, 2024

@leecalcote
Copy link
Member

Signal when ready for review.

@l5io
Copy link
Collaborator

l5io commented Feb 24, 2024

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@sandramsc
Copy link
Member Author

sandramsc commented Feb 28, 2024

Signal when ready for review.

@leecalcote
Inquiring with @sangramrath to see if public access is available for the tool used to create the annotations placed on these screenshots , so as to maintain a level of consistency (updating screenshots, then taking PR out of draft stage).

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@sangramrath
Copy link
Contributor

Hello @sandramsc I use a tool called Flameshot. https://flameshot.org/

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@sandramsc sandramsc marked this pull request as ready for review February 29, 2024 23:52
@sangramrath
Copy link
Contributor

sangramrath commented Mar 1, 2024

I haven't ran the steps myself yet, but here are my initial thoughts:

  • Step 4 (of Deploying a web application): we should provide a link to the URL or to download the design file (so users can upload)
  • Probably we should use unique names when importing designs (add name or initials to the design). When searching, this makes for easy identification which is yours, else there would be many designs with same name. (there's a way to identify using info but that's longer process)
  • Major heading 3: after step 8, it's step 1, should be 9 I guess?
  • I am assuming the steps bash mesheryctl pattern apply -f backup-cronjob.yaml and bash kubectl edit cronjob backup-cronjob are alternate CLI instructions, if yes we should mention them.
  • A view from the visualize screen showing the cronjobs would be good at the end.
  • May be we can crop the screenshots to only reflect the canvas area? where ever possible

Good job @sandramsc, sorry if it's a lot of comments :), do change only what's really necessary and of priority

@sandramsc
Copy link
Member Author

sandramsc commented Mar 1, 2024

I haven't ran the steps myself yet, but here are my initial thoughts:

* Step 4 (of Deploying a web application): we should provide a link to the URL or to download the design file (so users can upload)

* Probably we should use unique names when importing designs (add name or initials to the design). When searching, this makes for easy identification which is yours, else there would be many designs with same name. (there's a way to identify using info but that's longer process)

* Major heading 3: after step 8, it's step 1, should be 9 I guess?

* I am assuming the steps _bash mesheryctl pattern apply -f backup-cronjob.yaml_ and _bash kubectl edit cronjob backup-cronjob_ are alternate CLI instructions, if yes we should mention them.

* A view from the visualize screen showing the cronjobs would be good at the end.

* May be we can crop the screenshots to only reflect the canvas area? where ever possible

Good job @sandramsc, sorry if it's a lot of comments :), do change only what's really necessary and of priority

Hi @sangramrath thanks for the feedback. Are you able to make inline comments, as it might be better to associate each point of feedback with the section referenced, also perhaps we can have a chat about these on next weeks website call.

Also take note that the preview for the latest changes have not been generated, as you have probably already noticed.

@sangramrath
Copy link
Contributor

@sandramsc looks like I jumped the gun. Lee asked to check it out and I checked the last preview and left my comments. I will wait for the latest preview and leave inline comments.
I assume the website call is Monday (looking at the history) around 6 PM my time, I am unable to promise but I will try.

@l5io
Copy link
Collaborator

l5io commented Mar 4, 2024

…from feedback

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@sandramsc
Copy link
Member Author

Closed unintentionally while trying to merge updates from upstream - reopening.

@sandramsc sandramsc reopened this Mar 12, 2024
…l feedback

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
…netes-cronjobs.md

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Mar 12, 2024

@iArchitSharma
Copy link
Contributor

@sandramsc is this ready for review?

Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
Signed-off-by: Sandra Ashipala <sandraashipala@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Mar 25, 2024

@leecalcote
Copy link
Member

@iArchitSharma, yes, I believe this is ready for review.

@l5io
Copy link
Collaborator

l5io commented Apr 3, 2024

Signed-off-by: Archit Sharma <74408634+iArchitSharma@users.noreply.github.com>
Copy link
Contributor

@iArchitSharma iArchitSharma left a comment

Choose a reason for hiding this comment

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

LGTM Thanks @sandramsc

@l5io
Copy link
Collaborator

l5io commented Apr 19, 2024

@iArchitSharma iArchitSharma merged commit 8adc5f5 into meshery:master Apr 19, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Tutorial: Exploring Kubernetes CronJobs with Meshery Playground
6 participants