carvel-dev / carvel-dev/carvel

Create "What is Carvel?" page

Open
#684 7 comments 0 reactions 0 assignees View on GitHub
carvel accepted documentation enhancement priority/important-longterm
Dominant language
HTML
Stars
408
Forks
148
PR merge metrics
No merged PRs in 30d

Description

Based on a lot of feedback in the community, there should be a page that talks about what Carvel is, why it was created, and why users should use it.

For this issue, we need to
* Create the content for the page. See the hackmd for a draft of the content: https://hackmd.io/@B-b-yJ1nR0ysBlj8hrLlEw/rypbmEPJp
* Figure out where this page should live on the site. We should put some or all of this content on the home page, carvel.dev. Because of how the site is configured, the home page is currently the only place that talks about all the projects together.
* Make sure there are links to this page in the project docs to allow readers to be able to find this content as they discover Carvel

Contributor guide

Open the contributing guide

Research direction

Start with the linked HackMD draft, then inspect the site home page and project documentation to decide where the shared Carvel explanation belongs. Create the page content, place it appropriately on carvel.dev, and add discoverable links from the project docs; done means the content explains what Carvel is, why it exists, and why users should use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.