Skip to content

Commit a38633d

Browse files
lisaShawn Hurley
authored andcommitted
docs: Make first ref to quay.io link to https://quay.io (#1220)
* docs: Make first ref to quay.io link to https://quay.io In the off chance that someone hasn't has only heard of a single container registry (eg Docker Hub), provide a hyperlink to quay.io on its first mention. Plus, having the link provides for a little less typing for people to get to the site. * docs: Adjust quay.io link style Addresses PR feedback (#1220) to change link style to `[anchor text][link ref]` with a `[link ref]: https://quay.io` at the end of the document.
1 parent a6fd772 commit a38633d

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

doc/ansible/user-guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ powered by Ansible using tools and libraries provided by the Operator SDK.
1616
- Access to a Kubernetes v.1.9.0+ cluster.
1717

1818
**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the
19-
local Kubernetes cluster and quay.io for the public registry.
19+
local Kubernetes cluster and [quay.io][quay_link] for the public registry.
2020

2121
## Install the Operator SDK CLI
2222

@@ -431,3 +431,4 @@ $ kubectl delete -f deploy/crds/cache_v1alpha1_memcached_cr.yaml
431431
[ansible_tool]:https://docs.ansible.com/ansible/latest/index.html
432432
[ansible_runner_tool]:https://ansible-runner.readthedocs.io/en/latest/install.html
433433
[ansible_runner_http_plugin]:https://github.com/ansible/ansible-runner-http
434+
[quay_link]:https://quay.io

doc/helm/user-guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ powered by Helm using tools and libraries provided by the Operator SDK.
1313
- Access to a Kubernetes v.1.11.3+ cluster.
1414

1515
**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the
16-
local Kubernetes cluster and quay.io for the public registry.
16+
local Kubernetes cluster and [quay.io][quay_link] for the public registry.
1717

1818
## Install the Operator SDK CLI
1919

@@ -362,3 +362,4 @@ kubectl delete -f deploy/crds/example_v1alpha1_nginx_crd.yaml
362362
[minikube_tool]:https://github.com/kubernetes/minikube#installation
363363
[helm_charts]:https://helm.sh/docs/developing_charts/
364364
[helm_values]:https://helm.sh/docs/using_helm/#customizing-the-chart-before-installing
365+
[quay_link]:https://quay.io

doc/user-guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Guide][helm_user_guide]. The rest of this document will show how to program an o
1414
- [kubectl][kubectl_tool] version v1.11.3+.
1515
- Access to a Kubernetes v1.11.3+ cluster.
1616

17-
**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the local Kubernetes cluster and quay.io for the public registry.
17+
**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the local Kubernetes cluster and [quay.io][quay_link] for the public registry.
1818

1919
## Install the Operator SDK CLI
2020

@@ -499,3 +499,4 @@ When the operator is not running in a cluster, the Manager will return an error
499499
[request-go-doc]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/reconcile#Request
500500
[result_go_doc]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/reconcile#Result
501501
[metrics_doc]: ./user/metrics/README.md
502+
[quay_link]: https://quay.io

0 commit comments

Comments
 (0)