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

Urgent: Operator Documentation Needs Work #63

Open
mrhillsman opened this issue Aug 11, 2020 · 0 comments
Open

Urgent: Operator Documentation Needs Work #63

mrhillsman opened this issue Aug 11, 2020 · 0 comments

Comments

@mrhillsman
Copy link

Hi, I work on the Red Hat Operator Enablement team and upon review of the operator we found the documentation to be lacking required information for successful use and experience of the end-user:

01

An example of an operator taking advantage of various parts of the CSV which needs to be updated for the changes can be seen here:

02
03

I have highlighted certain parts of the Couchbase operator which utilizes the CSVs ability to accept Markdown for the metadata; hyperlinks, (un)ordered lists, etc.

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

No branches or pull requests

1 participant