Skip to content

Consolidate "Getting Started" for Designer using Tabs #578

Open
@zihanKuang

Description

@zihanKuang

Description:

The current "Getting Started" section (https://docs.layer5.io/kanvas/getting-started/starting-helm/) for the Designer has an open question regarding the best approach to document the different ways to create a design. Currently, there are separate pages for starting from scratch and from a Helm Chart.

As we are adding more ways to import designs (e.g., Kustomize manifest, Kubernetes manifest, Docker Compose, Meshery design, Import from Catalog, Import from GitHub, drag and drop), having a single page per starting point might become cumbersome and lead to long documentation.

  1. When I import from a k8s manifest, helm chart or other type, a new design file is created. After making edits to my design, I can export my design in the same format from which I imported. Can I also download a copy of my original, unaltered file?
  2. When I import from a k8s manifest, helm chart or other type, and choose to merge this file into an existing design, can I download my original file(s

Proposal:

Consolidate the documentation for different "Getting Started" methods onto a single page using tabs (and potentially tab panes). This would allow users to easily switch between instructions for different import mechanisms while keeping all related information in one place.

Related PR:

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions