Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Maintenance] Remove obsolete docs, restructure for better UX - GT-314 #1447

Merged
merged 1 commit into from
Oct 19, 2023
Merged

[Maintenance] Remove obsolete docs, restructure for better UX - GT-314 #1447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
56 changes: 28 additions & 28 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/api/ArangoDeployment.V1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']

Expand Down
6 changes: 5 additions & 1 deletion docs/api/ArangoMember.V1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Custom Resources API Reference

- [ArangoDeployment.V1](./ArangoDeployment.V1.md)
- [ArangoMember.V1](./ArangoMember.V1.md)

Loading