Skip to content

Commit f28c698

Browse files
(Documentation) Update ArangoDeployment CR auto-generated docs (#1451)
1 parent fe66d98 commit f28c698

37 files changed

+1935
-1564
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- (Maintenance) Remove obsolete docs, restructure for better UX, generate index files
77
- (Feature) Add `spec.upgrade.debugLog` option to configure upgrade container logging
88
- (Documentation) Move documentation from ArangoDB into this repo, update and improve structure
9+
- (Documentation) Update ArangoDeployment CR auto-generated docs
910

1011
## [1.2.34](https://github.com/arangodb/kube-arangodb/tree/1.2.34) (2023-10-16)
1112
- (Bugfix) Fix make manifests-crd-file command

docs/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,15 @@ that you deploy in your Kubernetes cluster to:
4040

4141
Each of these uses involves a different custom resource.
4242

43-
- Use an [`ArangoDeployment` resource](deployment-resource-reference.md) to
44-
create an ArangoDB database deployment.
45-
- Use an [`ArangoBackup`](backup-resource.md) and `ArangoBackupPolicy` resources to
46-
create ArangoDB backups.
47-
- Use an [`ArangoLocalStorage` resource](storage-resource.md) to
48-
provide local `PersistentVolumes` for optimal I/O performance.
49-
- Use an [`ArangoDeploymentReplication` resource](deployment-replication-resource-reference.md) to
50-
configure ArangoDB Datacenter-to-Datacenter Replication.
43+
- Use an [ArangoDeployment resource](deployment-resource-reference.md) to create an ArangoDB database deployment.
44+
- Use an [ArangoMember resource](api/ArangoMember.V1.md) to observe and adjust individual deployment members.
45+
- Use an [ArangoBackup](backup-resource.md) and [ArangoBackupPolicy](backuppolicy-resource.md) resources to create ArangoDB backups.
46+
- Use an [ArangoLocalStorage resource](storage-resource.md) to provide local `PersistentVolumes` for optimal I/O performance.
47+
- Use an [ArangoDeploymentReplication resource](deployment-replication-resource-reference.md) to configure ArangoDB Datacenter-to-Datacenter Replication.
5148

5249
Continue with [Using the ArangoDB Kubernetes Operator](using-the-operator.md)
5350
to learn how to install the ArangoDB Kubernetes operator and create
5451
your first deployment.
5552

5653
For more information about the production readiness state, please refer to the
57-
[ArangoDB Kubernetes Operator repository](https://github.com/arangodb/kube-arangodb#production-readiness-state).
54+
[main README file](https://github.com/arangodb/kube-arangodb#production-readiness-state).

0 commit comments

Comments
 (0)