(Documentation) Move documentation from ArangoDB site into this repo (#1450)

- remove duplicated docs
- update old docs with new info
- rework docs index page
- file names not changed to make sure redirects from old site will work as expected

Co-authored-by: jwierzbo <jakub.wierzbowski@arangodb.com>

Author: nikita-vanyasin

CHANGELOG.md

@@ -5,6 +5,7 @@
 - (Improvement) Print assigned node name to log and condition message when pod is scheduled
 - (Maintenance) Remove obsolete docs, restructure for better UX, generate index files
 - (Feature) Add `spec.upgrade.debugLog` option to configure upgrade container logging
+- (Documentation) Move documentation from ArangoDB into this repo, update and improve structure
 
 ## [1.2.34](https://github.com/arangodb/kube-arangodb/tree/1.2.34) (2023-10-16)
 - (Bugfix) Fix make manifests-crd-file command

README.md

@@ -6,13 +6,13 @@ ArangoDB Kubernetes Operator helps to run ArangoDB deployments
 on Kubernetes clusters.
 
 To get started, follow the Installation instructions below and/or
-read the [tutorial](https://www.arangodb.com/docs/stable/deployment-kubernetes-usage.html).
+read the [tutorial](docs/using-the-operator.md).  
 
 ## State
 
 The ArangoDB Kubernetes Operator is Production ready.
 
-[Documentation](https://www.arangodb.com/docs/stable/deployment-kubernetes.html)
+[Documentation](docs/README.md)
 
 ### Limits
 

docs/README.md

@@ -1,11 +1,57 @@
 # ArangoDB Kubernetes Operator
 
-- [Tutorial](https://www.arangodb.com/docs/stable/tutorials-kubernetes.html)
-- [Documentation](https://www.arangodb.com/docs/stable/deployment-kubernetes.html)
-- [Architecture](./design/README.md)
-- [Features description and usage](./features/README.md)
-- [Custom Resources API Reference](./api/README.md)
-- [Operator Metrics & Alerts](./generated/metrics/README.md)
-- [Operator Actions](./generated/actions.md)
+- [Intro](#intro)
+- [Using the ArangoDB Kubernetes Operator](using-the-operator.md)
+- [Architecture overview](design/README.md)
+- [Features description and usage](features/README.md)
+- [Custom Resources API Reference](api/README.md)
+- [Operator Metrics & Alerts](generated/metrics/README.md)
+- [Operator Actions](generated/actions.md)
+- [Authentication](authentication.md)
+- Custom resources overview:
+  - [ArangoDeployment](deployment-resource-reference.md)
+  - [ArangoDeploymentReplication](deployment-replication-resource-reference.md)
+  - [ArangoLocalStorage](storage-resource.md)
+  - [Backup](backup-resource.md)
+  - [BackupPolicy](backuppolicy-resource.md)
+- [Configuration and secrets](configuration-and-secrets.md)
+- [Configuring your driver for ArangoDB access](driver-configuration.md)
+- [Using Helm](helm.md)
+- [Collecting metrics](metrics.md)
+- [Services & Load balancer](services-and-load-balancer.md)
+- [Storage configuration](storage.md)
+- [Secure connections (TLS)](tls.md)
+- [Upgrading ArangoDB version](upgrading.md)
+- [Scaling your ArangoDB deployment](scaling.md)
+- [Draining the Kubernetes nodes](draining-nodes.md)
 - Known issues (TBD)
+- [Troubleshooting](troubleshooting.md)
 - [How-to ...](how-to/README.md)
+
+## Intro
+
+The ArangoDB Kubernetes Operator (`kube-arangodb`) is a set of operators
+that you deploy in your Kubernetes cluster to:
+
+- Manage deployments of the ArangoDB database
+- Manage backups
+- Provide `PersistentVolumes` on local storage of your nodes for optimal storage performance.
+- Configure ArangoDB Datacenter-to-Datacenter Replication
+
+Each of these uses involves a different custom resource.
+
+- Use an [`ArangoDeployment` resource](deployment-resource-reference.md) to
+  create an ArangoDB database deployment.
+- Use an [`ArangoBackup`](backup-resource.md) and `ArangoBackupPolicy` resources to
+  create ArangoDB backups.
+- Use an [`ArangoLocalStorage` resource](storage-resource.md) to
+  provide local `PersistentVolumes` for optimal I/O performance.
+- Use an [`ArangoDeploymentReplication` resource](deployment-replication-resource-reference.md) to
+  configure ArangoDB Datacenter-to-Datacenter Replication.
+
+Continue with [Using the ArangoDB Kubernetes Operator](using-the-operator.md)
+to learn how to install the ArangoDB Kubernetes operator and create
+your first deployment.
+
+For more information about the production readiness state, please refer to the
+[ArangoDB Kubernetes Operator repository](https://github.com/arangodb/kube-arangodb#production-readiness-state).

docs/authentication.md

@@ -0,0 +1,18 @@
+# Authentication
+
+The ArangoDB Kubernetes Operator will by default create ArangoDB deployments
+that require authentication to access the database.
+
+It uses a single JWT secret (stored in a Kubernetes secret)
+to provide *super-user* access between all servers of the deployment
+as well as access from the ArangoDB Operator to the deployment.
+
+To disable authentication, set `spec.auth.jwtSecretName` to `None`.
+
+Initially the deployment is accessible through the web user-interface and
+APIs, using the user `root` with an empty password.
+Make sure to change this password immediately after starting the deployment!
+
+## See also
+
+- [Secure connections (TLS)](tls.md)