Skip to content

Consolidate "Getting Started" for Designer using Tabs #578

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

Open
zihanKuang opened this issue May 23, 2025 · 0 comments
Open

Consolidate "Getting Started" for Designer using Tabs #578

zihanKuang opened this issue May 23, 2025 · 0 comments
Labels
framework/hugo help wanted Extra attention is needed kind/enhancement Improvement in current feature language/css language/html language/javascript Javascript related

Comments

@zihanKuang
Copy link
Contributor

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.

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework/hugo help wanted Extra attention is needed kind/enhancement Improvement in current feature language/css language/html language/javascript Javascript related
Projects
None yet
Development

No branches or pull requests

1 participant