From 80a776372fe99c0552db415189b012e3a8ce4d18 Mon Sep 17 00:00:00 2001 From: Rob Szumski Date: Fri, 27 Apr 2018 14:25:21 -0700 Subject: [PATCH 1/2] readme: use ref style links --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04d94dcd073..df23093e21b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,10 @@ See the [design docs][design_docs] for planned work on upcoming milestones. ## Overview -This project is a component of the [Operator Framework](https://github.com/operator-framework), an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post](https://coreos.com/blog/introducing-operator-framework). +This project is a component of the [Operator Framework][of-home], an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post][of-blog]. + +[of-home]: https://github.com/operator-framework +[of-blog]: https://coreos.com/blog/introducing-operator-framework [Operators][operator_link] make it easy to manage complex stateful applications on top of Kubernetes. However writing an operator today can be difficult because of challenges such as using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication. @@ -78,4 +81,4 @@ To explore any operator samples built using the operator-sdk, see the [operator- [operator_link]: https://coreos.com/operators/ [design_docs]: ./doc/design [guide]: ./doc/user-guide.md -[samples]: https://github.com/operator-framework/operator-sdk-samples \ No newline at end of file +[samples]: https://github.com/operator-framework/operator-sdk-samples From 4e47622eb26277e8b1d0b0dafbe2530a7ad2a73f Mon Sep 17 00:00:00 2001 From: Rob Szumski Date: Fri, 27 Apr 2018 14:28:42 -0700 Subject: [PATCH 2/2] readme: move refs to bottom --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index df23093e21b..2b26a0dcb6b 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,6 @@ See the [design docs][design_docs] for planned work on upcoming milestones. This project is a component of the [Operator Framework][of-home], an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post][of-blog]. -[of-home]: https://github.com/operator-framework -[of-blog]: https://coreos.com/blog/introducing-operator-framework - [Operators][operator_link] make it easy to manage complex stateful applications on top of Kubernetes. However writing an operator today can be difficult because of challenges such as using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication. The Operator SDK is a framework designed to make writing operators easier by providing: @@ -82,3 +79,5 @@ To explore any operator samples built using the operator-sdk, see the [operator- [design_docs]: ./doc/design [guide]: ./doc/user-guide.md [samples]: https://github.com/operator-framework/operator-sdk-samples +[of-home]: https://github.com/operator-framework +[of-blog]: https://coreos.com/blog/introducing-operator-framework