Remove obsolete docs, restructure for better UX (#1447)

Author: nikita-vanyasin

CHANGELOG.md

@@ -3,8 +3,9 @@
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
 - (Maintenance) Update go-driver to v1.6.0, update IsNotFound() checks
 - (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
 
-## [1.2.34](https://github.com/arangodb/kube-arangodb/tree/1.2.34) (2023-10-16
+## [1.2.34](https://github.com/arangodb/kube-arangodb/tree/1.2.34) (2023-10-16)
 - (Bugfix) Fix make manifests-crd-file command
 - (Improvement) Allow tcp:// and ssl:// protocols in endpoints for members
 - (Maintenance) Reorganize package imports / move common code to separate repos

README.md

@@ -2,10 +2,10 @@
 
 - [Tutorial](https://www.arangodb.com/docs/stable/tutorials-kubernetes.html)
 - [Documentation](https://www.arangodb.com/docs/stable/deployment-kubernetes.html)
-- [Design documents](./design/README.md)
-- [Providers](./providers/README.md)
-
-
-# ArangoDB Kubernetes Operator Generated Documentation
-- [ArangoDB Operator Metrics & Alerts](./generated/metrics/README.md)
-- [ArangoDB Actions](./generated/actions.md)
+- [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)
+- Known issues (TBD)
+- [How-to ...](how-to/README.md)

docs/README.md

@@ -597,7 +597,7 @@ Architecture defines the list of supported architectures.
 First element on the list is marked as default architecture.
 
 Links:
-* [Architecture Change](/docs/design/arch_change.md)
+* [Architecture Change](/docs/how-to/arch_change.md)
 
 Default Value: ['amd64']
 

docs/api/ArangoDeployment.V1.md

@@ -4,7 +4,11 @@
 
 ### .spec.deletion_priority: int
 
-[Code Reference](/pkg/apis/deployment/v1/arango_member_spec.go#L44)
+DeletionPriority define Deletion Priority.
+Higher value means higher priority. Default is 0.
+Example: set 1 for Coordinator which should be deleted first and scale down coordinators by one.
+
+[Code Reference](/pkg/apis/deployment/v1/arango_member_spec.go#L47)
 
 ### .spec.deploymentUID: string
 

docs/api/ArangoMember.V1.md

@@ -0,0 +1,5 @@
+# Custom Resources API Reference
+
+ - [ArangoDeployment.V1](./ArangoDeployment.V1.md)
+ - [ArangoMember.V1](./ArangoMember.V1.md)
+