Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update and improve stackablectl documentation #101

Merged
merged 64 commits into from
Sep 21, 2023
Merged

Conversation

Techassi
Copy link
Member

@Techassi Techassi commented Aug 18, 2023

Tracked by #98

Copy Tasks

Preview Give feedback

Update Tasks

Preview Give feedback

Repo Tasks

Preview Give feedback
  1. Techassi sbernauer
  2. Techassi

Cargo.toml Outdated Show resolved Hide resolved
@Techassi
Copy link
Member Author

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

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

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

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

@Techassi
Copy link
Member Author

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
Member

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
Member Author

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
Member

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

@Techassi
Copy link
Member Author

Techassi commented Sep 22, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants