search

k8snetworkplumbingwg / sriov-network-operator

Operator for provisioning and configuring SR-IOV CNI plugin and device plugin
Apache License 2.0
85 stars 114 forks source link

Documentation gaps and the quick start #697

Open ns-rlewkowicz opened 6 months ago

ns-rlewkowicz commented 6 months ago

@SchSeba This is an awesome product and easy to use. I think I made it way harder on myself than it needed to be. I might just be a goofy man.

TLDR: The quick start should lead with helm, and I'd be happy to write something up if we want it.

The quickstart starts with this make system. I've been doing this for 15 years now, recently been working with a ton of C++ so make has been my life. I'm no stranger to custom engineering and esoteric build systems. So I just took it at face value and started hacking away.

Maybe it seems like common sense, theres pages of docs hundreds of lines of code. I might be a goof, I feel like it's easy to miss. There's a helm chart! And it works very nicely.

I was wasting TONS of time hacking around the make system and building custom images. And it's all just right there... modified some values and it worked great

SchSeba commented 6 months ago

+1 from my side. do you have some bandwidth to open a PR with the doc changes and we can review it? also, we always welcome people to the community meeting if you have topics or issues to talk!

https://docs.google.com/document/u/1/d/1sJQMHbxZdeYJPgAWK1aSt6yzZ4K_8es7woVIrwinVwI/edit