docs: Update and improve stackablectl documentation

[Techassi]

Tracked by #98

Copy Tasks

Beta Give feedback

1. Automatic help text generation for commands
2. Copy over command documentation
3. Copy over index page
4. Copy over demo pages
5. Copy over quick start guide
6. Copy over customization pages
7. Copy over installation and quick start pages

Update Tasks

Beta Give feedback

1. Update command texts
2. Update demo texts
3. Update customization texts
4. Update installation and quick start texts

Repo Tasks

Beta Give feedback

1. docs: Add management and demo docs documentation#449
   +0
   
2. refactor: Use CSS grid instead of flex for boxes wrapper documentation-ui#47
   +0
   
3. Update demos repo

Operator Tasks

Beta Give feedback

1. docs: Update references airflow-operator#327
   +0
   
2. docs: Update references druid-operator#472
   +0
   
3. docs: Update references hbase-operator#397
   +0
   
4. docs: Update references hdfs-operator#393
   +0
   
5. docs: Update references hive-operator#372
   +0
   
6. docs: Update references kafka-operator#623
   +0
   
7. docs: Update references nifi-operator#508
   +0
   
8. docs: Update references opa-operator#476
   +0
   
9. docs: Update references spark-k8s-operator#285
   +0
   
10. docs: Update references superset-operator#406
    +0
    
11. docs: Update references trino-operator#476
    +0
    
12. docs: Update references zookeeper-operator#728
    +0
    

Follow-up Fixes

Beta Give feedback

1. fix(docs): Fix invalid references in 23.7 hdfs-operator#395
   +0
   
2. fix(docs): Update invalid references in 23.4 hdfs-operator#396
   +0
   
3. fix(docs): Update invalid references in 23.1 hdfs-operator#397
   +0
   
4. fix(docs): Update invalid references in 23.7 hive-operator#373
   +0
   
5. fix(docs): Update invalid references in 23.4 hive-operator#374
   +0
   
6. fix(docs): Update invalid references for 23.1 hive-operator#375
   +0
   
7. fix(docs): Update invalid references for 23.1 kafka-operator#624
   +0
   

[Techassi]

This is close to be ready for review. There are some pages still missing and all pages need some slight content adjustments.

[fhennig]

I like the generated stuff. How can we make sure that the generated content gets updated if the code is changed?

[Techassi]

I like the generated stuff. How can we make sure that the generated content gets updated if the code is changed?

This is generated by a pre-commit hook which uses cargo xtask gen-ctl-readme.

[lfrancke]

A few items are left unchecked/unmerged in the tasklist. What's the status there?

[Techassi]

They are still ongoing and we are continuing to use this PR for tracking them. However, this PR cannot be re-opened after it was merged.

[lfrancke]

Okay, but then it shouldn't be in the Done column.
We usually use issues for that and not PRs. It's a bit weird but let's then move it back.

[Techassi]

Agreed, it's a little weird. This PR started small, but spiraled a little out of control. Changes here required more and more changes in other repositories, so that's why I started tracking those tasks here.

[lfrancke]

The other alternative is to create a new issue but I'll leave that to you.

[Techassi]

Yeah we are pretty much done, so it should be fine. But in the future it might be better to track this using an issue.