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.

Sign up for GitHub

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

Jump to bottom

Update documentation #85

Closed
f41gh7 opened this issue Sep 15, 2020 · 3 comments
Closed

Update documentation #85

f41gh7 opened this issue Sep 15, 2020 · 3 comments
Labels
enhancement New feature or request

Comments

@f41gh7
Copy link
Collaborator

f41gh7 commented Sep 15, 2020

Improve readme:

  • add uses cases.
  • problems that operator may solve.
  • difference between helm chart.
  • troubleshooting.
@f41gh7 f41gh7 added the enhancement New feature or request label Sep 15, 2020
@f41gh7 f41gh7 mentioned this issue Sep 20, 2020
Merged
@elmariofredo
Copy link
Contributor

As discussed in #87 it would be nice to have extended CRD documentation. I have found this project we cloud probably use https://github.com/ahmetb/gen-crd-api-reference-docs

@f41gh7
Copy link
Collaborator Author

f41gh7 commented Sep 22, 2020

Yep, thanks. I'll take a look.

@f41gh7
Copy link
Collaborator Author

f41gh7 commented Oct 5, 2020

I've added few examples with -full prefix. But i'm still not sure how to properly generate it from CRD definition. It becomes overloaded and not useful, plus there are a lot of special cases with embedded kubernetes objects.

@f41gh7 f41gh7 closed this as completed Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@elmariofredo @f41gh7