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 SDK tutorial.md file should indicate how to create Endpoints #53

Open
mayur-raja opened this issue Sep 25, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mayur-raja
Copy link
Member

mayur-raja commented Sep 25, 2023

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 Create the Operator section mentions Endpoint wazi-sandbox but does not describe how to create an Endpoint or how an Endpoint comes into play.

What needs fixing?

Explain how an Endpoint is created (if created automatically as part of installing an Operator see https://www.ibm.com/docs/en/cloud-paks/z-modernization-stack/2023.2?topic=interface-importing-operator-collection) or if created manually. It is possible that we may be able to just link to existing sections on Endpoints in the z/OS Cloud Broker Docs.

Btw, sometimes we say importing and sometimes we say installing an operator. This is confusing. It would be nice if we could use the same terminology please.

Additional context

If we document how to create Endpoints in the tutorial, the README files for all Operators can reference the tutorial and hence avoid the need to describe how to create an endpoint in multiple places. I believe documentation for the IMS Operator already describe the specifics of Endpoints. It would be nice if it just referenced the tutorial. This is what I would like to do in the README file for the MQ Operator.

@mayur-raja mayur-raja added the documentation Improvements or additions to documentation label Sep 25, 2023
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