-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs structure and PR template (#39)
Release-As: v1.0.0-alpha.9
- Loading branch information
Showing
7 changed files
with
35 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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_] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../../README.adoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../../../../bootstrap/README.adoc |