Skip to content

Commit

Permalink
docs: Rclone and Velero modules documentation (#1082)
Browse files Browse the repository at this point in the history
* docs: add documentation for Velero and Rclone modules

* chore: ignore antora build directory

* chore: Update .gitignore

Co-authored-by: Gonçalo Heleno <[email protected]>

---------

Co-authored-by: Gonçalo Heleno <[email protected]>
  • Loading branch information
tyrossel and lentidas authored Sep 12, 2023
1 parent df3bac5 commit 1027c34
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 10 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ examples/*/.terraform.lock.hcl
node_modules
package-lock.json
public
docs_test

### Antora
build/
docs_test

### VS Code

Expand Down
23 changes: 15 additions & 8 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ antora:
- require: "@antora/lunr-extension"
index_latest_only: true
urls:
latest_version_segment: latest # Define each component's latest version as the latest in the URL
latest_version_segment: latest # Define each component's latest version as the latest in the URL
content:
sources:

Expand Down Expand Up @@ -46,13 +46,6 @@ content:
- "v@({1..9})*({0..9}).+({0..9}).*"
# Exclude versions without proper folder structure or with generation errors
- "!v1.0.0-alpha.*"
- url: https://github.com/camptocamp/devops-stack-module-backup.git
start_path: docs
branches: []
tags:
- "v@({1..9})*({0..9}).+({0..9}).*"
# Exclude versions without proper folder structure or with generation errors
- "!v1.0.0-alpha.*"
- url: https://github.com/camptocamp/devops-stack-module-cert-manager.git
start_path: docs
branches: []
Expand Down Expand Up @@ -159,6 +152,13 @@ content:
- "v@({1..9})*({0..9}).+({0..9}).*"
# Exclude versions without proper folder structure or with generation errors
- "!v1.0.0-alpha.*"
- url: https://github.com/camptocamp/devops-stack-module-rclone.git
start_path: docs
branches: []
tags:
- "v@({1..9})*({0..9}).+({0..9}).*"
# Exclude versions without proper folder structure or with generation errors
- "!v1.0.0-alpha.*"
- url: https://github.com/camptocamp/devops-stack-module-thanos.git
start_path: docs
branches: []
Expand All @@ -173,6 +173,13 @@ content:
- "v@({1..9})*({0..9}).+({0..9}).*"
# Exclude versions without proper folder structure or with generation errors
- "!v1.0.0-alpha.*"
- url: https://github.com/camptocamp/devops-stack-module-velero.git
start_path: docs
branches: []
tags:
- "v@({1..9})*({0..9}).+({0..9}).*"
# Exclude versions without proper folder structure or with generation errors
- "!v1.0.0-alpha.*"
ui:
bundle:
url: https://github.com/camptocamp/devops-stack-antora-ui/releases/download/main-latest/ui-bundle.zip
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
* xref:argocd:ROOT:README.adoc[Argo CD]
* xref:azure-workload-identity:ROOT:README.adoc[Azure Workload Identity]
* xref:oidc-aws-cognito:ROOT:README.adoc[AWS Cognito OIDC]
* xref:backup:ROOT:README.adoc[Backup]
* xref:cert-manager:ROOT:README.adoc[cert-manager]
* xref:dex:ROOT:README.adoc[Dex]
* xref:ebs-csi-driver:ROOT:README.adoc[EBS CSI Driver]
Expand All @@ -45,5 +44,7 @@
* xref:longhorn:ROOT:README.adoc[Longhorn]
* xref:metallb:ROOT:README.adoc[MetalLB]
* xref:minio:ROOT:README.adoc[MinIO]
* xref:rclone:ROOT:README.adoc[Rclone]
* xref:thanos:ROOT:README.adoc[Thanos]
* xref:traefik:ROOT:README.adoc[Traefik]
* xref:velero:ROOT:README.adoc[Velero]

0 comments on commit 1027c34

Please sign in to comment.