From c822423b146425e53c1e4f110efa514f6dd52241 Mon Sep 17 00:00:00 2001 From: Thomas Woerner <twoerner@redhat.com> Date: Wed, 5 Jun 2019 15:48:43 +0200 Subject: [PATCH] Move role documentation into the specific role locations as README.md This will result in a better role documentation on galaxy. --- README.md | 25 ++++++++++++------------ CLIENT.md => roles/ipaclient/README.md | 0 REPLICA.md => roles/ipareplica/README.md | 0 SERVER.md => roles/ipaserver/README.md | 0 4 files changed, 13 insertions(+), 12 deletions(-) rename CLIENT.md => roles/ipaclient/README.md (100%) rename REPLICA.md => roles/ipareplica/README.md (100%) rename SERVER.md => roles/ipaserver/README.md (100%) diff --git a/README.md b/README.md index 9004805b..81dc3f11 100644 --- a/README.md +++ b/README.md @@ -236,16 +236,17 @@ All these settings will be available in the ```[ipaserver]```, ```[ipareplicas]` Playbooks ========= -The playbooks needed to deploy or undeploy server, replicas and clients are part of the repository. There are also playbooks to deploy and undeploy clusters. With them it is only needed to add an inventory file: +The playbooks needed to deploy or undeploy server, replicas and clients are part of the repository and placed in the playbooks folder. There are also playbooks to deploy and undeploy clusters. With them it is only needed to add an inventory file: ``` -install-client.yml -install-cluster.yml -install-replica.yml -install-server.yml -uninstall-client.yml -uninstall-cluster.yml -uninstall-replica.yml -uninstall-server.yml +playbooks\ + install-client.yml + install-cluster.yml + install-replica.yml + install-server.yml + uninstall-client.yml + uninstall-cluster.yml + uninstall-replica.yml + uninstall-server.yml ``` How to deploy a master server @@ -303,6 +304,6 @@ This will deploy the server, replicas and clients defined in the inventory file. Roles ===== -* [Server](SERVER.md) -* [Replica](REPLICA.md) -* [Client](CLIENT.md) +* [Server](roles/ipaserver/README.md) +* [Replica](roles/ipareplica/README.md) +* [Client](roles/ipaclient/README.md) diff --git a/CLIENT.md b/roles/ipaclient/README.md similarity index 100% rename from CLIENT.md rename to roles/ipaclient/README.md diff --git a/REPLICA.md b/roles/ipareplica/README.md similarity index 100% rename from REPLICA.md rename to roles/ipareplica/README.md diff --git a/SERVER.md b/roles/ipaserver/README.md similarity index 100% rename from SERVER.md rename to roles/ipaserver/README.md -- GitLab