From 7dc0991af84cc3386943535859aed6a9f66d5f68 Mon Sep 17 00:00:00 2001 From: vquiby <86775146+vquiby@users.noreply.github.com> Date: Mon, 27 Mar 2023 10:54:40 +0200 Subject: [PATCH] docs: add docs structure and PR template (#39) Release-As: v1.0.0-alpha.9 --- .github/pull_request_template.md | 19 ++++++++++++ README.adoc | 4 +-- README.md | 29 ------------------- docs/antora.yml | 7 +++++ docs/modules/ROOT/nav.adoc | 5 ++++ docs/modules/ROOT/pages/README.adoc | 1 + docs/modules/ROOT/pages/bootstrap/README.adoc | 1 + 7 files changed, 35 insertions(+), 31 deletions(-) create mode 100644 .github/pull_request_template.md delete mode 100644 README.md create mode 100644 docs/antora.yml create mode 100644 docs/modules/ROOT/nav.adoc create mode 120000 docs/modules/ROOT/pages/README.adoc create mode 120000 docs/modules/ROOT/pages/bootstrap/README.adoc diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..4a0eb57 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +## Description of the changes + +_In this section, explain **what and why** not how._ + +_In most cases, you can leave out details about how a change has been made. Code is generally self-explanatory in this regard (and if the code is so complex that it needs to be explained in prose, that’s what source comments are for). Just focus on making clear the reasons why you made the change in the first place, the way things worked before the change (and what was wrong with that), the way they work now, and why you decided to solve it the way you did._ + +## Breaking change + +- [ ] No +- [ ] Yes (in the Helm chart(s)): _indicate the chart, version & release note link_ +- [ ] Yes (in the module itself): _give an explanation of the breaking change_ + +## Tests executed on which distribution(s) + +- [ ] KinD +- [ ] AKS (Azure) +- [ ] EKS (AWS) +- [ ] Scaleway +- [ ] SKS (Exoscale) \ No newline at end of file diff --git a/README.adoc b/README.adoc index 57ed5bf..c65ae50 100644 --- a/README.adoc +++ b/README.adoc @@ -169,7 +169,7 @@ Description: Override of target revision of the application chart. Type: `string` -Default: `"v1.0.0-alpha.7"` +Default: `"v1.0.0-alpha.8"` === Outputs @@ -332,7 +332,7 @@ object({ |[[input_target_revision]] <> |Override of target revision of the application chart. |`string` -|`"v1.0.0-alpha.7"` +|`"v1.0.0-alpha.8"` |no |=== diff --git a/README.md b/README.md deleted file mode 100644 index cab1122..0000000 --- a/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# devops-stack-module-argocd - -A [DevOps Stack](https://devops-stack.io) module to finalize [ArgoCD](https://argoproj.github.io/cd/). - -While the `argocd-helm` module deploys a bootstrap ArgoCD, this module allows to finalize its installation and should be called at the end of all DevOps Stack modules. - -## Usage - -```hcl -module "argocd" { - source = "git::https://github.com/camptocamp/devops-stack-module-argocd.git/" - - base_domain = "example.com" - cluster_name = "my-cluster" - cluster_issuer = "letsencrypt-prod" - admin_enabled = "true" - namespace = local.argocd_namespace - accounts_pipeline_tokens = module.argocd_bootstrap[0].argocd_accounts_pipeline_tokens - server_secretkey = module.argocd_bootstrap[0].argocd_server_secretkey - - -dependency_ids = { - prometheus = module.prometheus-stack[0].id - cert-manager = module.cert-manager[0].id - } -} -``` - -Once module is applied and argocd Application synched, service becomes available at `argocd.apps.my-cluster.example.com` diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 0000000..621d9df --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,7 @@ +--- +name: "argocd" +title: "Argo CD Module" +version: true +start_page: README.adoc +nav: + - "modules/ROOT/nav.adoc" diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..f3a5893 --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1,5 @@ +* xref:ROOT:README.adoc[Home] +* Module Variants +** xref:ROOT:bootstrap/README.adoc[Bootstrap] +* https://github.com/camptocamp/devops-stack-module-argocd[Repository,window=_blank] +* xref:ROOT:ROOT:index.adoc[_Return to DevOps Stack docs_] diff --git a/docs/modules/ROOT/pages/README.adoc b/docs/modules/ROOT/pages/README.adoc new file mode 120000 index 0000000..2cfd4f7 --- /dev/null +++ b/docs/modules/ROOT/pages/README.adoc @@ -0,0 +1 @@ +../../../../README.adoc \ No newline at end of file diff --git a/docs/modules/ROOT/pages/bootstrap/README.adoc b/docs/modules/ROOT/pages/bootstrap/README.adoc new file mode 120000 index 0000000..0cab0ff --- /dev/null +++ b/docs/modules/ROOT/pages/bootstrap/README.adoc @@ -0,0 +1 @@ +../../../../../bootstrap/README.adoc \ No newline at end of file