openshift / openshift/openshift-docs
[enterprise-4.10] redundant documentation in file registry/securing-exposing-registry.adoc
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 883
- Forks
- 2k
- Avg merge
- 21h 5m
- Merged PRs (30d)
- 737
Description
Which section(s) is the issue in?
Exposing the registry
What needs fixing?
This page has two sections. "Exposing a default registry manually". which is basically "patch the image registry operator config to enable the defaultRoute attribute".
But these instructions are also found on the main "Image registry operator operator in OCP" page at https://docs.openshift.com/container-platform/4.10/registry/configuring-registry-operator.html#registry-operator-default-crd_configuring-registry-operator
I think they should only be in the documentation in one place.
As for the next section, "Exposing a secure registry manually". This repeats the same instruction about enabling the default registry route. Then it tells you to patch the image registry operator config to create a new public-routes route (the name is a bit odd using the plural). And this new route is then configured to use a custom TLS server certificate. The result is that you end up with two routes exposing the registry, where only one is needed.
The naming of the sections is a bit odd as it implies that there are two kinds of registries, a "default registry" and a "secure registry".
I think this page ended up suffering from a bit of copy & paste and needs a little bit of cleanup. How about these as sections:
- Exposing the registry with a default hostname
- Exposing the registry with a custom hostname
- Exposing the registry with a custom TLS server certificate
... and removing the redundant instruction to use the defaultRoute attribute when using a custom hostname/certificate?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review registry/securing-exposing-registry.adoc alongside the linked configuring-registry-operator.html page. Compare the defaultRoute and custom route instructions, then reorganize the material around default hostname, custom hostname, and custom TLS certificate use cases. Done means redundant instructions are removed and the resulting guidance no longer implies separate default and secure registries.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100