Main README is referencing the organization name rather than the Build controllers

[qu1queee]

Idea:

I think that the README needs more ad-hoc references to the "Build" controllers, rather than the github organization, for example the title, it should be:

Shipwright - a framework for building container images on Kubernetes -> Shipwright Build - a framework for building container images on Kubernetes
or
Shipwright - a framework for building container images on Kubernetes -> Shipwright Build controllers - a framework for building container images on Kubernetes

[otaviof]

I think would be better to have a straight forward naming, so in regards to this project, a Kubernetes Operator, I think naming it "Shipwright Build Operator" portraits the primary idea.

Then, we need to explain what this Operator is about, for that I would choose:

Shipwright - a framework for building container images on Kubernetes -> Shipwright Build - a framework for building container images on Kubernetes

To add more on the short descriptions, what do we think of following snippet?

Shipwright Build Operator: A Kubernetes native container-image builder framework

[qu1queee]

@imjasonh maybe of your interest based on your recent contributions ^^

[imjasonh]

Thanks for the ping! Perhaps unsurprisingly, I do indeed have thoughts about this 😄

I think a good README or landing page follows roughly the form:

1. Here's what it is, in a sentence or two ("Framework for building container images on Kubernetes" is great 👍)
2. Here's what it can do for you -- here's how easy your life will be if you try it
3. Here's how to start using it -- a simple mini-tutorial, with links to deeper tutorials
4. Here's how it works, if you're interested -- maybe just a link to architecture.md
5. Here's how to get involved, if you'd like to contribute

Each step draws the reader in a little deeper, and the user can stop at whatever level they want if they don't care about the next level. (FWIW, Tekton's docs also aren't perfect here, but we try -- Shipwright's API is a lot simpler than Tekton's, so I think we can make the docs really smooth)

"How it works" is purposefully low on that list. Users don't care and shouldn't care how it works (until it doesn't 😅 ), but a lot of docs written by engineers want to jump straight there.

I might send some docs PRs to try to achieve this, if this outline sounds good.

[qu1queee]

@imjasonh pretty solid outline, I think this one in combination with #633 would be a great docs improvement for the upcoming release. If you have time please go ahead with this outline, I can collaborate with you if you want, or I can take this item next week, you let me know. Thanks!

[adambkaplan]

/close

Marking this as a duplicate of #655

[openshift-ci-robot]

@adambkaplan: Closing this issue.

In response to this:

/close

Marking this as a duplicate of #655

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.