knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.54k stars 1.23k forks source link

Add a 'Books, courses, and videos' section in the documents #4085

Closed salaboy closed 2 years ago

salaboy commented 3 years ago

There is a free full book from Manning about Knative in Action. This should be added front page of the website so new users are aware that there is a book available and it is free to download.

Describe the change you'd like to see I wanna know and see the book when I first enter the knative.dev website.

Additional context Links in the docs about other books mentioning Knative should be added

julz commented 3 years ago

Looks like the book is not free unless you give your email to VMware so I'm not sure whether linking to the free version is "right" on the community site or not (though it's a great book and a great thing that VMware is sponsoring it!). Maybe this is something steering should weigh in on.

salaboy commented 3 years ago

@julz we might separate this into two things then..

julz commented 3 years ago

Ack, I'm just a little jittery, personally, about links to commercial/vendor stuff directly from the community home page. Looking at Istio and Kubernetes' websites, neither of them seem to link to a book. Rust does, but it's literally a html version included directly on the website that's both free and unsponsored.

salaboy commented 3 years ago

@julz let's make sure that the fact that is sponsored doesn't block people from finding a valuable resource. I would promote youtube videos, no matter which vendor is producing them, in the same way, for the sake of users having as many resources as possible about the project.

julz commented 3 years ago

I would promote YouTube videos, no matter which vendor is producing them

Indeed so would I (and often do fwiw), but not on the front page of the community site, personally. Would we link to IBM Cloud's knative service (for example) from the front page, since it offers a free tier and is a fast way to get started, or eg TriggerMesh's free training course? It feels like a slippery slope I'd personally rather us not slide down, but it's Steering's call, at the end of the day: if they were happy, I'd be happy.

Adding a "knative books and courses" page to the getting started section, similar to the knative offerings page we already have (and maybe even linking to that page from the home page) would be fine with me.

abrennan89 commented 3 years ago

Agree with @julz here, I don't think it's a good idea to promote a vendor-sponsored resource on the main community site.

Adding a "knative books and courses" page

+1 for that, I don't see an issue there. Let's repurpose this issue to track that instead.

salaboy commented 3 years ago

Let's add the topic to the Steering committee agenda so they discuss this. But 100% behind the idea of Books, Courses and probably videos as well.

salaboy commented 3 years ago

Great to see @abrennan89 also joining here!

vaikas commented 3 years ago

I think we should have a section like that for sure. One question is what the vetting process for getting things in there will be. I could for example foresee something like, open a PR, maybe if somebody can vounch for it, they stamp it, if we don't have that, perhaps somebody should be assigned to check it out before adding? Regardless, I added to SC agenda for this weeks meeting. Thanks all!

vaikas commented 3 years ago

Let's do this! @pmorie @vaikas will be on point from SC to make forward progress.

pmorie commented 3 years ago

i'm supportive of making this available for download, great opportunity to help folks learn and spread the project around.

pmorie commented 3 years ago

hrm i wonder if we can avoid the need to hand out one's email

vaikas commented 3 years ago

I think the proposed plan is to:

julz commented 3 years ago

Yeah @pmorie the email capture is the bit that made me a bit uncomfortable with it being on the home page, personally.

@vaikas that plan sounds perfect to me 👌

pmorie commented 3 years ago

@julz if we got the email capture removed how would you feel

julz commented 3 years ago

My main hesitation is the email capture so without that I'd personally be a lot more comfortable with it (we'd still be linking to only one specific vendor's product-branded page from the home page; how much - if at all - we should care about that Id defer entirely to y'all on steering though 😊)

I think @vaikas's approach of having a generic resources page with a clear policy for how stuff gets added, is quite a nice solution without a lot of downsides (it's also easier to add and remove links to a markdown page than to modify the html homepage as and when there are new things we want to reference).

salaboy commented 3 years ago

I am super happy to see this moving forward, happy to help as well. I am 100% agree with @julz and @vaikas proposal

vaikas commented 3 years ago

Started looking at this and realized we already have "Knative books" section here that already lists the book mentioned and the "Knative cookbook": https://knative.dev/docs/getting-started/next-steps/

How do folks feel just adding "Knative courses" and "Knative videos" there? I think we might want to add a note to the "Knative in action" that states that it requires an email registration?

omerbensaadon commented 3 years ago

I think if we're too sensitive about playing "favorites" between vendors we will lose sight of the greater purpose for our collaboration.

We are a community of contributors most of whom happen to work for one of the major contributing vendors. Though we may sometimes have competing outcomes in the short term, in the longterm, we all want the same thing: the Knative spec as a standard for Serverless workloads.

If one vendor has spent time and money creating a free resource which helps people to more easily understand and adopt Knative, thus increasing our "mindshare," we should not shy away from linking to such a thing. Especially not when the form used to capture emails is so easy to abuse.

If, for example, RedHat (or IBM, or TM, etc.) offered such a resource for free I would fully support proliferating that information as widely as possible.

How do folks feel just adding "Knative courses" and "Knative videos" there? I think we might want to add a note to the "Knative in action" that states that it requires an email registration?

@vaikas Very few people get to this point in the site, I would recommend putting it elsewhere!

omerbensaadon commented 3 years ago

FWIW I agree with @vaikas's approach above, not throwing a wrench in here

vaikas commented 3 years ago

@omerbensaadon I'm fine with putting it elsewhere, just when I started adding it, noticed that we already had two books there :)

vaikas commented 3 years ago

We have the 'What's next' when you click 'Getting started', so it's one click from the entry page. Should we just add a 'Knative Resources' section that's at the same level as 'What's next' and move the existing links there?

julz commented 3 years ago

Completely ack those goals @omerbensaadon and I hope you know I share them! I just don't personally think it's a good look (or gives the impression we want to give, as a project, to potential users, or those considering contributing to or building on the project) to prominently and directly link to a single vendor's branded email capture page from the home page no matter how awesome the book, or how awesome the vendor for sponsoring it. Given that was both @abrennan89's and my reaction, I imagine it would be shared by a fair number of website visitors, too.

Being completely honest I don't see a tension between doing what's best to publicise the project and doing what's best to remain vendor neutral here, because I think being/appearing vendor driven and non-neutral would harm us much more than an extra hop to get to the book would help us, and I think we need to be extra cautious of that impression while we remain outside a neutral foundation, but we can agree to disagree here, and as I said I'd defer to steering if they're fine with it.

I don't think anyone has a problem linking to a resources page from the homepage, which seems like a great idea.

salaboy commented 3 years ago

@vaikas at least from my personal experience that section is too deep and not easy to find