Skip to content

CRD docs: polish epic #500

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

Closed
30 tasks done
fhennig opened this issue Dec 6, 2023 · 1 comment
Closed
30 tasks done

CRD docs: polish epic #500

fhennig opened this issue Dec 6, 2023 · 1 comment
Assignees
Labels

Comments

@fhennig
Copy link
Contributor

fhennig commented Dec 6, 2023

The initial work to get generated docs up and running was done: #328

Now we need to fill the docs with content.

And then we need to update the CRD docs for all operators, similar to the druid PR:

Operators

Preview Give feedback
  1. 5 of 8
  2. 3 of 12
  3. 9 of 12
  4. 0 of 12
  5. 2 of 12
  6. 0 of 12
  7. 0 of 12
  8. 10 of 12
    changelog/crd-change release-note/action-required
  9. 0 of 12
  10. 0 of 12
  11. 0 of 12
  12. 0 of 13
  13. 0 of 13
  14. 0 of 13

There is a style guide here: https://docs.stackable.tech/home/nightly/contributor/style-guide#_crd_documentation

Also, all the CRD docs should be linked under "Reference" in our regular docs.

also this: stackabletech/crddocs#7

also this: #510

@adwk67
Copy link
Member

adwk67 commented Dec 12, 2023

stackablectl now uses -c kind instead of -k to create a kind cluster inline, and the cluster is a single node one. The getting started guides still refer to -k in some places.

@lfrancke lfrancke moved this from Ideas Backlog to In Progress in Stackable End-to-End Coordination Dec 13, 2023
@lfrancke lfrancke added the epic label Dec 13, 2023
@fhennig fhennig moved this from Development: In Progress to Development: Done in Stackable Engineering Jan 2, 2024
@fhennig fhennig closed this as completed Jan 2, 2024
@lfrancke lfrancke moved this from In Progress to Done in Stackable End-to-End Coordination Jan 3, 2024
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

No branches or pull requests

3 participants