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

Create "What is Carvel?" page #684

Open a-mccarthy opened 9 months ago

a-mccarthy commented 9 months ago

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

a-mccarthy commented 9 months ago

This issue is also related to https://github.com/carvel-dev/carvel/issues/223, which has a lot of feedback on the What is Carvel content and updating the home page. To me, I think there are 2 work steams here,

  1. Create and publish a what is carvel page (this issue)
  2. Update the content and possibly the layout of the home page (https://github.com/carvel-dev/carvel/issues/223) to reflect what we have put together in the What is Carvel page.

I'd recommend focusing on getting the information together and correct, and then publish it. This can easily become a project that snowballs into something very large and long running. After we publish, we can always iterate on the content. Interested in hearing everyone's thought on this :)

I also took a very quick pass at creating a rough draft for this content. I used a basic question/answer format in the hopes that it would be easy to get information together. Once we have more content, we can work on improving the page formatting. Hackmd link: https://hackmd.io/@B-b-yJ1nR0ysBlj8hrLlEw/rypbmEPJp

github-actions[bot] commented 8 months 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.

microwavables commented 5 months ago

Reopened and adding comment so hopefully github actions doesn't close it

a-mccarthy commented 2 months ago

Related to the project outlined on https://github.com/carvel-dev/carvel/issues/744.

Some more context on what is needed for this page:

We should add clear messaging on what Carvel is and what problems it solves. Aside from the brief note on the home page, there is no content that describes WHAT Carvel is, WHY It was created, WHEN to use It, or HOW the tools were created and selected to be part of It.

This page should focus on the why more than the how.

It's not possible to discuss each tool and its value individually. So focus on the top 1-3 values.

We should consider elaborating on what composable means. Many people may know what we mean by this, but it feels like it's slipping into “jargon/overused” territory. This content might be better suited for a different page, but its something to consider adding.

The end result should be a page that someone new to Carvel can read and learn why Carvel exists and how it can help as an integrated suite.

Some nice to haves for this page include a user journey and talk about how Carvel can be used and an image to show how all tools are integrated.

microwavables commented 2 months ago

@a-mccarthy One thing I wanted to clarify is that this isn't a separate page on what is Carvel but is what we want to be part of the landing page. Is there a way to update this issue to reflect that this is for the carvel.dev landing page and not a separate 'what is Carvel' page?

a-mccarthy commented 2 months ago

@microwavables yes, I updated the issue description. I think we will have to see how this content turns out in terms of length. It might be that we should have a piece or summary of this content on the home page and then a link to a place where we go into more details of all this content. Depends on how much we are looking to add. But yes, i agree this should be added to the home page, and also be open to the possibly add it to a new page if we need to.

MeenuyD commented 2 months ago

Instead of solely focusing on “why Carvel was created”, it would indeed be beneficial to highlight “why one should use Carvel” and there we can add its key features. It is only the idea @microwavables @a-mccarthy can also reject this idea also. However, if you decide to include the reason behind Carvel's creation (why Carvel was created), the content I provided is suitable ? Here's how it can be: “Carvel came because Dmitriy Kalinin and Nima Kaviani weren't happy with the tools available for deploying Kubernetes workloads. These tools were clunky, full of errors, and a troubleshooting headache. So, they decided to change the game. Carvel offers you a smarter approach by taking the everyday app settings and turning them into a versatile library accessible to all your applications. It's like having a magic wand for smoother, hassle-free Kubernetes deployments.” is this correct?