Ideas to improve the documentation

[ljavorsk]

What is the URL of the document?

Operator-sdk Ansible tutorial

Which section(s) is the issue in?

Not a specific section, these are ideas for new sections.

What needs fixing?

Nothing in particular.

Additional context

I've just finished my first Ansible-based operator and throughout the process, I've asked for quite a lot of help from people in the ansible-operator slack channel (a tremendous amount from @asmacdo especially).

So I would like to point out a few things that I had found very useful, and wished I may found them in the docs instead of always asking them in the channel (not that I don't like to chat with those lovely people, I just want to save their time a bit).

1. I wasn't able to find any links or mentions about the slack channels (ansible-operator especially in my case), which helped me with my further more specific questions.

2. Very useful page for the implementation and understanding of how the modules work in ansible -> Kubernetes.Core. I would love to see this doc mentioned there, it helped me so much during the process of making my first operator.

3. More examples. I think that everyone loves examples, either to get some inspiration or just to check out how some other developers create their operators. I found only the Memcached operator mentioned there, but when I asked folks from the Slack channel, they gave me some more operators, where I usually found very similar solutions I wanted to use. For example - how to use when, info module, ...

4. When I was first creating the operator I was using the remote OpenShift cluster for deploying and development. This can take quite some time when you just add one-liner into the code. Then I got excellent ideas from Austin about things like minikube, kind, ansible-playbook which saved me soooo much time. I think these are worth mentioning in the docs.

PS: I hope I didn't miss any of these steps in the docs, so if yes, please just let me know they are already there.

Hopefully, these ideas are helpful, and maybe even integrated.

The last thing I just want to thank so much for is how responsive and helpful people from the ansible-operator Slack channel are, it was a fun ride developing the operator with help of these guys. Keep up the great work.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

[openshift-bot]

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

[openshift-ci[bot]]

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.