search

carvel-dev / carvel

Carvel provides a set of reliable, single-purpose, composable tools that aid in your application building, configuration, and deployment to Kubernetes. This repo contains information regarding the Carvel open-source community.
https://carvel.dev/
Apache License 2.0
369 stars 109 forks source link

Improve getting started experience #756

Open a-mccarthy opened 2 months ago

a-mccarthy commented 2 months ago

This is a sub-issue for https://github.com/carvel-dev/carvel/issues/744

Right now its hard to get started using the Carvel tools. We should create a better experience for getting started using the carvel tools individually and together. There isn’t a clearly labeled “START HERE IF YOU ARE NEW” section for users to know how to get started after they install a tool.

We should consider creating a “Getting Started Guide” for each tool.

Within the getting started guide, we should also add a “What’s next?” section to help readers know some related content after installing or getting started guide

We should also consider updating our basic install guides for each of the tools. Overall the install section of each tool is very bare minimum. Look at Velero, as an example, of how there is much more to installing and using it as outlined.

github-actions[bot] commented 1 month ago

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.