Skip to content

Docs: Consolidate "Importing Designs" Guide and Adjust Tab Styling #644

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

Merged
merged 4 commits into from
Jul 11, 2025

Conversation

zihanKuang
Copy link
Contributor

@zihanKuang zihanKuang commented Jul 10, 2025

Notes for Reviewers

This PR fixes #578

Documentation Updates (/docs)

  • Consolidated guides into a page for importing designs, now located at getting-started/importing-designs.md. An alias has been added.
  • Structured content into a tabbed interface, with a tab for each infrastructure type (Kubernetes Manifests, Helm Charts, Docker Compose, etc.).
  • Clarified supported packaging formats and import requirements for each type.
  • Added GIFs to demonstrate import methods (Kanvas UI, Cloud UI, and Drag & Drop).
  • Included a FAQ section.
  • Added cross-references to documentation for exporting designs, plans, and GitHub integration.

Styling Fix (/assets/scss)

  • Reduced the gap property for the .tab-body class from 3rem to 1rem.
  • Reasoning: The 3rem value created vertical spacing between paragraphs within tabs, affecting readability. I have confirmed that this change corrects the layout on the "Importing Designs" page and does not cause issues on pages that use the tab component.

Unsure About Location

Should this file remain in the "Getting Started with Designs" section, or does it need to be moved to the "Exploring Designer" section?

Signed-off-by: Zihan Kuang <[email protected]>
Signed-off-by: Zihan Kuang <[email protected]>
Copy link

netlify bot commented Jul 10, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit c98b04b
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/68711b575e9c7b00084ecc19
😎 Deploy Preview https://deploy-preview-644--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.

@zihanKuang zihanKuang requested a review from leecalcote July 10, 2025 09:32
@leecalcote leecalcote merged commit 0dbce54 into layer5io:master Jul 11, 2025
6 checks passed
@leecalcote
Copy link
Member

Good work. 🙂

Please follow up on the Kustomize .zip/.tar question and blog post.

@leecalcote
Copy link
Member

Please move drag and drop to first place and consider hiding the other import options in tab panes.

@zihanKuang zihanKuang deleted the import-design branch July 12, 2025 10:11
@zihanKuang
Copy link
Contributor Author

Hi @leecalcote,

I've published the blog post here: https://discuss.layer5.io/t/unleash-visual-power-import-your-configs/7144
I've also fixed the issues in the docs:

You can check the webpage here: https://docs.layer5.io/kanvas/getting-started/import-designs/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consolidate "Getting Started" for Designer using Tabs
2 participants