Skip to content
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

Create "What is Carvel?" page #684

Open
a-mccarthy opened this issue Sep 19, 2023 · 7 comments
Open

Create "What is Carvel?" page #684

a-mccarthy opened this issue Sep 19, 2023 · 7 comments
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed documentation This issue indicates a change to the docs should be considered enhancement This issue is a feature request priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@a-mccarthy
Copy link
Contributor

a-mccarthy commented Sep 19, 2023

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
@a-mccarthy
Copy link
Contributor Author

This issue is also related to #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 (Clear messaging on Carvel's website/homepage #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
Copy link

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.

@github-actions github-actions bot added the stale This issue has had no activity for a while and will be closed soon label Oct 30, 2023
@github-actions github-actions bot closed this as completed Nov 5, 2023
@github-project-automation github-project-automation bot moved this to Closed in Carvel Nov 5, 2023
@microwavables microwavables reopened this Jan 8, 2024
@github-project-automation github-project-automation bot moved this from Closed to In Progress in Carvel Jan 8, 2024
@microwavables
Copy link
Contributor

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

@github-actions github-actions bot removed the stale This issue has had no activity for a while and will be closed soon label Jan 9, 2024
@renuy renuy added enhancement This issue is a feature request documentation This issue indicates a change to the docs should be considered carvel accepted This issue should be considered for future work and that the triage process has been completed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed carvel-triage labels Jan 9, 2024
@renuy renuy moved this from In Progress to Unprioritized in Carvel Jan 9, 2024
@a-mccarthy
Copy link
Contributor Author

Related to the project outlined on #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
Copy link
Contributor

@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
Copy link
Contributor Author

@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
Copy link

MeenuyD commented May 4, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed documentation This issue indicates a change to the docs should be considered enhancement This issue is a feature request priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
Status: Unprioritized
Development

No branches or pull requests

4 participants