feat: add a quick-start doc article

[almaslennikov]

• Add a new quick start section with (almost) ready-to-use deployment examples
• Add keywords to use case definitions for ease of future automated parsing by LLMs
• Store examples as separate files and build them to allow automated deployments

TBD:

• Test the examples
• Allow to change other parameters in deployment examples (e.g. pci addresses or interface names)

[rollandf]

Great work!

[thuffmlx]

This is great.
I would add at least 1-3 more 2ndary RDMA network definitions.
Most configurations have 4-8 NICS and consequently 4-8 parallel secondary RDMA networks. Would help clarify the list of networks in the annotations, and the corresponding list of resource requests. I've encountered customers that tried to dump all of the NICs in to the same secondary network as a pool.

[almaslennikov]

This is great. I would add at least 1-3 more 2ndary RDMA network definitions. Most configurations have 4-8 NICS and consequently 4-8 parallel secondary RDMA networks. Would help clarify the list of networks in the annotations, and the corresponding list of resource requests. I've encountered customers that tried to dump all of the NICs in to the same secondary network as a pool.

Hey @thuffmlx, please take a look at the new version. I've added more RDMA network definitions to IPoIB RDMA shared use case

[rollandf]

Great job!
Thanks

[github-actions]

Documentation preview

https://mellanox.github.io/network-operator-docs/review/pr-225

[adrianchiris]

just a suggestions but you could use something more "standard"

like using envsubst instead of needing to generate sed cmd for each var in vars.rst.

that means

1. have var.env file created from release.yaml
2. generate vars.rsh from 1
3. generate examples using vars from 1

example: in templates you will put something like: repository: $NVIDIA_IPAM_REPO

[rollandf]

Good idea.
let's fix this in a follow up

[rollandf]

Issue created:
#238