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

Operator Collection Tutorial indicates that users will need to update the operator-config.yml but this is not always the case #54

Closed
mayur-raja opened this issue Sep 25, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@mayur-raja
Copy link
Member

What is the link to the document from the "main" branch?

https://github.com/IBM/operator-collection-sdk/blob/main/docs/tutorial.md

Which section(s) is the issue in?

The Update operator config section.

What needs fixing?

I do not wish to duplicate doc that is in the tutorial.md file in the MQ Operator README file. So, I would like to be able to reference the tutorial.md file as much as possible. However, the tutorial.md file currently states that users will need to update the operator-config.yml file. But, this is not necessarily true because for the MQ Operator, the operator-config.yml file is provided complete. Users do not need to update it.

I think the tutorial needs to differentiate between steps required to install an existing/provided Operator and between creating a brand new Operator.

At present, the instructions are somewhat misleading.

Additional context

@mayur-raja mayur-raja added the documentation Improvements or additions to documentation label Sep 25, 2023
@mayur-raja
Copy link
Member Author

Apologies, I had misunderstood the purpose of the tutorial. I just discussed it with Latrell and he clarified that I still need to document specifics in the MQ Operator README.file. So, I am closing this issue.

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

No branches or pull requests

1 participant