Skip to content

docs: Update and improve stackablectl documentation#101

Merged
Techassi merged 64 commits into
mainfrom
docs/stackablectl
Sep 21, 2023
Merged

docs: Update and improve stackablectl documentation#101
Techassi merged 64 commits into
mainfrom
docs/stackablectl

Conversation

@Techassi
Copy link
Copy Markdown
Member

@Techassi Techassi commented Aug 18, 2023 •
edited
Loading

Tracked by #98

## Copy Tasks
- [X] Automatic help text generation for commands
- [X] Copy over command documentation
- [X] Copy over index page
- [x] Copy over demo pages
- [x] Copy over quick start guide
- [x] Copy over customization pages
- [x] Copy over installation and quick start pages

## Update Tasks
- [x] Update command texts
- [x] Update demo texts
- [x] Update customization texts
- [x] Update installation and quick start texts

## Repo Tasks
- [ ] https://github.com/stackabletech/documentation/pull/449
- [ ] https://github.com/stackabletech/documentation-ui/pull/47
- [x] Update `demos` repo

## Operator Tasks
- [ ] https://github.com/stackabletech/airflow-operator/pull/327
- [ ] https://github.com/stackabletech/druid-operator/pull/472
- [ ] https://github.com/stackabletech/hbase-operator/pull/397
- [ ] https://github.com/stackabletech/hdfs-operator/pull/393
- [ ] https://github.com/stackabletech/hive-operator/pull/372
- [ ] https://github.com/stackabletech/kafka-operator/pull/623
- [ ] https://github.com/stackabletech/nifi-operator/pull/508
- [ ] https://github.com/stackabletech/opa-operator/pull/476
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/285
- [ ] https://github.com/stackabletech/superset-operator/pull/406
- [ ] https://github.com/stackabletech/trino-operator/pull/476
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/728

## Follow-up Fixes
- [ ] https://github.com/stackabletech/hdfs-operator/pull/395
- [ ] https://github.com/stackabletech/hdfs-operator/pull/396
- [ ] https://github.com/stackabletech/hdfs-operator/pull/397
- [ ] https://github.com/stackabletech/hive-operator/pull/373
- [ ] https://github.com/stackabletech/hive-operator/pull/374
- [ ] https://github.com/stackabletech/hive-operator/pull/375
- [ ] https://github.com/stackabletech/kafka-operator/pull/624

@Techassi Techassi self-assigned this Aug 18, 2023
@Techassi Techassi mentioned this pull request Aug 18, 2023
Closed
sbernauer
sbernauer reviewed Aug 25, 2023
View reviewed changes
Comment thread Cargo.toml Outdated
@Techassi
Copy link
Copy Markdown
Member Author

Techassi commented Aug 29, 2023

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

This was referenced Sep 19, 2023
Merged
Merged
fhennig
fhennig reviewed Sep 20, 2023
View reviewed changes
Comment thread docs/modules/stackablectl/pages/commands/cache.adoc
fhennig
fhennig reviewed Sep 20, 2023
View reviewed changes
Comment thread docs/modules/stackablectl/pages/commands/completions.adoc
fhennig
fhennig reviewed Sep 20, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@fhennig fhennig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Techassi
Copy link
Copy Markdown
Member Author

Techassi commented Sep 21, 2023

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.

@Techassi Techassi enabled auto-merge September 21, 2023 08:58
@Techassi Techassi added this pull request to the merge queue Sep 21, 2023
Merged via the queue into main with commit 62800fd Sep 21, 2023
@Techassi Techassi deleted the docs/stackablectl branch September 21, 2023 09:08
This was referenced Sep 21, 2023
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@lfrancke
Copy link
Copy Markdown
Member

lfrancke commented Sep 22, 2023

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

@Techassi
Copy link
Copy Markdown
Member Author

Techassi commented Sep 22, 2023

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
Copy link
Copy Markdown
Member

lfrancke commented Sep 22, 2023

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
Copy link
Copy Markdown
Member Author

Techassi commented Sep 22, 2023

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
Copy link
Copy Markdown
Member

lfrancke commented Sep 22, 2023

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

@Techassi Techassi mentioned this pull request Sep 22, 2023
Merged
@Techassi
Copy link
Copy Markdown
Member Author

Techassi commented Sep 22, 2023 •
edited
Loading

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.

@Techassi Techassi mentioned this pull request Sep 22, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sbernauer sbernauer sbernauer left review comments

+1 more reviewer

@fhennig fhennig fhennig approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Techassi Techassi

@sbernauer sbernauer

Labels

None yet

Projects

Stackable Engineering
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Techassi @lfrancke @fhennig @sbernauer