docs: add ./docs/cndi/README.md

[johnstonmatt]

Context

As someone interested in Platform Engineering when I want to find solutions for deployment I would like to read about CNDI so I can determine if the tool is a good fit for my work.

What does this PR do?

• This PR adds ./docs/cndi/README.md to provide information about the free and open source tool.

How can someone see this change?

Quality assurance steps

• I have performed a self-review of the code before asking others to review, providing comments to help clarify ambiguity or reduce complexity

[kevinevans1]

@Schiiss @david-hurley please can you review ?

[david-hurley]

Minor changes I would like to see. Great job, this is really well written.

• Move Why CNDI to first section - sell it upfront
• I found comparison to other tools a bit vague - for example, mentioned that Crossplane is “a framework to build platforms” and “CNDI is batteries included” but this doesn’t tell me much about why it’s better than Crossplane, is it just that it’s more “out of the box”. Might consider dropping this section and instead focus on selling what CNDI does well, which you have.
• I like the custom templates section but I never trust links, maybe link to CNDI main template repo and just note that these exist so we avoid broken link hell later 😄
• Great diagram, like the detailed explanation
• Could probably combine overview, comparison to other tools, maybe templates to one section

[johnstonmatt]

@david-hurley thanks for the feedback! I think it all flows more nicely now that I've made those changes to the structure, but of course I'm happy to make more changes in a second pass now that the content has shifted if you have more thoughts.

Could you clarify your comment for me:

I like the custom templates section but I never trust links...

These are all first-party Templates so the links each point to https://cndi.dev/templates/foo, are you still worried about this given the links are owned by the CNDI team?

If you'd still rather avoid hyperlinks anyway I'm happy to make the change, but just wanted to call out that they are owned by the CNDI team in this case and are unlikely to change

[david-hurley]

@david-hurley thanks for the feedback! I think it all flows more nicely now that I've made those changes to the structure, but of course I'm happy to make more changes in a second pass now that the content has shifted if you have more thoughts.

Could you clarify your comment for me:

I like the custom templates section but I never trust links...

These are all first-party Templates so the links each point to https://cndi.dev/templates/foo, are you still worried about this given the links are owned by the CNDI team?

If you'd still rather avoid hyperlinks anyway I'm happy to make the change, but just wanted to call out that they are owned by the CNDI team in this case and are unlikely to change

Thanks! Looks great.

I guess, if in the future a template was removed, for example airflow then https://cndi.dev/templates/airflow would break. Whereas if instead of linking to specific template we just provided https://cndi.dev/templates it is very unlikely it would ever break. Like you say, maybe it's not a worry?

I am fine to keep them!

[johnstonmatt]

Okay, let's keep them in case they help with discoverability and ease of use - and I'll commit to not breaking the web :)