Description as a Markdown with preview
Design type: Definitions, Empty state, Lists, Navigation, Onboarding, Operators, Quick starts, Samples, Side drawer | Product area: ACM, Cluster as a Service
Author: Shiran Hirshberg
Last edit: August 20, 2023
Description as a Markdown with preview
Background
When creating a new template, administrators have the option to include a description for each template, if they choose to do so. This description serves to highlight the specific situations and methods for effectively using that particular template. This descriptive text becomes a valuable resource for the cluster creator, assisting them in selecting the most appropriate template for their needs.
Our objective is to provide users with comprehensive control over this feature within the cluster template creation wizard. To facilitate this, we've introduced a Markdown option. This empowers users to integrate headings, lists, and links, allowing them to present the content coherently to cater to the cluster creator's requirements.
Design
This is the empty state, users can choose using the preset description (it will help them understand what kind of content will be helpful to have there and they can edit it per their needs), or creating from scratch.
This is how it will look like if they clicked on the “Use preset description”:
This is the preview of how the text looks like:
This is the text formatting instructions:
For the cluster creator persona, he will see this text in the template Overview page:
And when creating a new cluster from a template:
