From 7f4dfbc0a1527dbd1935f5f6fd298134862ce0b3 Mon Sep 17 00:00:00 2001 From: Desmond Obisi <51109125+DesmondSanctity@users.noreply.github.com> Date: Tue, 25 Jul 2023 22:05:47 +0100 Subject: [PATCH] Docs: moved introduction from readme to docs folder (#1477) Co-authored-by: Sandra McCann --- README.md | 8 +++----- docs/introduction/introduction.md | 3 +++ 2 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 docs/introduction/introduction.md diff --git a/README.md b/README.md index 07372571..577a67c0 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,11 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w + +NOTE: we are in the process of moving this readme into official docs in the /docs folder. Please go there to find additional sections during this interim move phase. + * [AWX Operator](#awx-operator) * [Table of Contents](#table-of-contents) - * [Purpose](#purpose) * [Usage](#usage) * [Creating a minikube cluster for testing](#creating-a-minikube-cluster-for-testing) * [Basic Install](#basic-install) @@ -70,10 +72,6 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w -## Purpose - -This operator is meant to provide a more Kubernetes-native installation method for AWX via an AWX Custom Resource Definition (CRD). - ## Usage This Kubernetes Operator is meant to be deployed in your Kubernetes cluster(s) and can manage one or more AWX instances in any namespace. diff --git a/docs/introduction/introduction.md b/docs/introduction/introduction.md new file mode 100644 index 00000000..29b620cf --- /dev/null +++ b/docs/introduction/introduction.md @@ -0,0 +1,3 @@ +## Purpose + +This operator is meant to provide a more Kubernetes-native installation method for AWX via an AWX Custom Resource Definition (CRD).