Feature Request
Is your feature request related to a problem? Please describe.
The existing documentation may cause confusion for new users with respect to building and running the example memcached operator. Namely, "quay.io/example/v0.0.1" is used in several places without much explanation. Extracting an environment variable to represent this value could improve usability; specifically by implying that a user should replace "example" with his or her quay.io username. Additionally, the user guide is focused on the quay.io docker registry, which is perfectly acceptable. However, when I ran through the example, I did not realize that the repository must be made public in order for K8S to successfully pull the image. This might be personal naivete, but I believe the documentation could benefit from explicitly mentioning that the repository should be made public.
Describe the solution you'd like
One solution might involve the following steps:
- Have the documentation extract an environment variable to represent the Docker Image, so that it is consistent throughout and less prone to copy/paste error.
- Mention that the quay.io docker repository needs to be made public prior to running the subsequent deployment.
Feature Request
Is your feature request related to a problem? Please describe.
The existing documentation may cause confusion for new users with respect to building and running the example memcached operator. Namely, "quay.io/example/v0.0.1" is used in several places without much explanation. Extracting an environment variable to represent this value could improve usability; specifically by implying that a user should replace "example" with his or her quay.io username. Additionally, the user guide is focused on the quay.io docker registry, which is perfectly acceptable. However, when I ran through the example, I did not realize that the repository must be made public in order for K8S to successfully pull the image. This might be personal naivete, but I believe the documentation could benefit from explicitly mentioning that the repository should be made public.
Describe the solution you'd like
One solution might involve the following steps: