docs icon indicating copy to clipboard operation
docs copied to clipboard

Feat/add dry run docs

Open zihanKuang opened this issue 8 months ago • 5 comments

This PR adds a page for the “Dry Run” functionality in Meshery's design workflows. The guide explains what Dry Run does, how to use it, and how it differs from Validate and Deploy.

What's Included

  • Supporting images (GIF + PNGs) for UI walkthroughs

  • Usage explanation with screenshots

  • Q&A and footnotes for known UI behaviors

  • The section “How It Works” reflects the real execution flow based on these implementations: https://github.com/meshery/meshery/blob/master/ui/machines/validator/designValidator.js https://github.com/meshery/meshery/blob/ec5eea1a098b12afdafe93cf1b821da99a3f6bfc/server/handlers/design_engine_handler.go https://github.com/meshery/meshery/blob/72ad171fa7ae0975d3ffa57b7b27da37e4be70c0/server/models/pattern/patterns/k8s/k8s.go

  • [x] Yes, I signed my commits.

zihanKuang avatar Apr 29 '25 22:04 zihanKuang

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
Latest commit c3c0e89eae847c56e683ac0b5043da0259d1929d
Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/684559cd96ea74000802fa5e
Deploy Preview https://deploy-preview-513--bejewelled-pegasus-b0ce81.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Apr 29 '25 22:04 netlify[bot]

Hi @leecalcote @hortison, thanks a lot for the helpful feedback!

I've updated the PR based on your suggestions:

  • Removed the unnecessary alias.
  • Reworded headings and adjusted the tone for a more natural, user-focused voice.
  • Converted the Best Practices section into a numbered list.

Also, I’ve opened an issue to track the dropdown behavior mentioned in the footnote: #14584

Let me know if there's anything else I can improve.

zihanKuang avatar May 01 '25 07:05 zihanKuang

Thanks for reviewing, @Paladian78

pontusringblom avatar May 04 '25 16:05 pontusringblom

Regarding the difference in behavior on the Actions button - - https://cloud.layer5.io/academy/learning-paths/mastering-meshery/introduction-to-meshery?chapter=deploying-meshery-designs

The single-click action offers away for experienced users to bypass a wizard and simply directly invoke the selected action.

leecalcote avatar May 05 '25 16:05 leecalcote

We'll hold off on further doc updates to this section until issue #14634 is resolved 😎

zihanKuang avatar May 06 '25 18:05 zihanKuang