Docs: moved introduction from readme to docs folder (#1477)

Co-authored-by: Sandra McCann <samccann@redhat.com>
This commit is contained in:
Desmond Obisi
2023-07-25 22:05:47 +01:00
committed by GitHub
parent c9ab99385a
commit 7f4dfbc0a1
2 changed files with 6 additions and 5 deletions

View File

@@ -12,9 +12,11 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w
<!-- Regenerate this table of contents using https://github.com/ekalinin/github-markdown-toc -->
<!-- gh-md-toc --insert README.md -->
<!--ts-->
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
<!--te-->
## 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.