Create design from scratch and added docker target in makefile #97
Conversation
Signed-off-by: vaibhavpnimkar <[email protected]>
Signed-off-by: vaibhavpnimkar <[email protected]>
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hey @vaibhavpnimkar Let's discuss this on website call tomorrow at 6:30 PM IST / 7 AM Central time. Please add this as an agenda item in the meeting minutes. |
Signed-off-by: vaibhavpnimkar <[email protected]>
… create-design-from-scratch
There was a problem hiding this comment.
Thank you for this but this deviates from the idea of documentation. Reason being that it tells users what they need to do rather than the underline system behavior for each of their actions.
Would you please consider updating this?
Ideally, you need to answer questions like what happens when a user create a new design, what's the visibility of the design, what's the meaning of that visibility (lightly), does naming/renaming a design creates a new design copy or updates the original name, how users would be seeing different versions of the desired Meshery Model components, what happens internally when user merge a design, does user loose one of their design in the process, how does it affect the visibility of the merged design, etc....
There was a problem hiding this comment.
okay noted !!!
There was a problem hiding this comment.
should i consider adding images for each action ?
There was a problem hiding this comment.
Yes, if in doing so, you are describing the underlying system behavior. No, if you are simply giving the user a step-by-step series of instructions about how to click through the UI. If we have to provide them the step-by-step series of instructions on how to click through the UI, then we have failed our UX test, and I need to make UX changes.
There was a problem hiding this comment.
okay i almost got it @leecalcote will update soon !!
|
|
||
| ## Step 3: Browsing Available Components | ||
|
|
||
| Explore the extensive toolbox in the Designer mode, offering a diverse array of components such as Kubernetes clusters, service mesh options, and cloud-native application elements. Each component is designed to seamlessly integrate into your infrastructure. |
There was a problem hiding this comment.
Please don't highlight service meshes as these are just a kind of infrastructure that can be managed. Highlighting them sends a wrong message to users.
There was a problem hiding this comment.
Just some additional context... @vaibhavpnimkar what you have written about service meshes is seemingly harmless and is appropriate to include. It is only because Meshery is soooo well-known for service meshes that we have to over-rotate on the other infrastructure it manages (or under mention the fact that it does service mesh - because it is already prominently and historically represented).
Thank you for tackling this page. 👍
|
|
||
| ## Step 8: Merging Designs | ||
|
|
||
| For enhanced collaboration and scalability, drag and drop existing designs into your canvas. This feature enables you to merge multiple designs seamlessly, creating a unified and comprehensive view of your infrastructure. |
There was a problem hiding this comment.
Please don't use abstract speech
Dockerfile
Outdated
| ############### | ||
| # Build Stage # | ||
| ############### | ||
| FROM jakejarvis/hugo-extended:latest as builder |
There was a problem hiding this comment.
Thanks for this.
Is this a verified publisher for Hugo sites?
There was a problem hiding this comment.
Would you please consider using anyone of these Dockerfiles as examples?
https://github.com/google/docsy/blob/main/Dockerfile
https://github.com/google/docsy-example/blob/main/Dockerfile
There was a problem hiding this comment.
okay will update jakejarvis/hugo-extended with docsy-example
Signed-off-by: vaibhavpnimkar <[email protected]>
|
@leecalcote @theBeginner86 updated jakejarvis/hugo-extended with docsy-example and also updated getting started docs |
|
Hey @vaibhavpnimkar Let's discuss this on website call tomorrow at 6:30 PM IST / 7 AM Central time. Please add this as an agenda item in the meeting minutes. |
|
Tagging @theBeginner86 for another review. |
Signed-off-by: Pranav Singh <[email protected]>
|
@vaibhavpnimkar thanks for contributing here. You've done some good work. |
Notes for Reviewers
This PR fixes #57 and #77
Signed commits