sameersbn / sameersbn/docker-gitlab
Docs not clear
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 8.1k
- Forks
- 2.1k
- Avg merge
- 17h 47m
- Merged PRs (30d)
- 7
Description
https://github.com/sameersbn/docker-gitlab/blob/master/docs/container_registry.md is not realy clear to me.
Sometimes registry-auth.crt/key is used, then there is registry.crt/key.
Then there is REGISTRY_AUTH_TOKEN_ROOTCERTBUNDLE=/certs/registry.crt and on another point there is REGISTRY_AUTH_TOKEN_ROOTCERTBUNDLE=/certs/registry-auth.crt.
I'm confused and do not really understand how to setup that stuff. Furthermore, I didn't understand the difference between GITLAB_REGISTRY_CERT_PATH and SSL_REGISTRY_CERT_PATH.
It would be nice to have this clarified in the docs.
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
Start with docs/container_registry.md and compare every use of registry-auth.crt, registry.crt, REGISTRY_AUTH_TOKEN_ROOTCERTBUNDLE, GITLAB_REGISTRY_CERT_PATH, and SSL_REGISTRY_CERT_PATH. Clarify the certificate naming and path differences in the setup instructions, and consider the documentation complete when the examples are consistent and the two certificate-path variables are explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100