Skip to content

Commit

Permalink
docs: add docs structure and PR template (#39)
Browse files Browse the repository at this point in the history
Release-As: v1.0.0-alpha.9
  • Loading branch information
vquiby authored Mar 27, 2023
1 parent dcee7bb commit 7dc0991
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 31 deletions.
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -332,7 +332,7 @@ object({
|[[input_target_revision]] <<input_target_revision,target_revision>>
|Override of target revision of the application chart.
|`string`
|`"v1.0.0-alpha.7"`
|`"v1.0.0-alpha.8"`
|no

|===
Expand Down
29 changes: 0 additions & 29 deletions README.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "argocd"
title: "Argo CD Module"
version: true
start_page: README.adoc
nav:
- "modules/ROOT/nav.adoc"
5 changes: 5 additions & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -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_]
1 change: 1 addition & 0 deletions docs/modules/ROOT/pages/README.adoc
1 change: 1 addition & 0 deletions docs/modules/ROOT/pages/bootstrap/README.adoc

0 comments on commit 7dc0991

Please sign in to comment.