mirrors/kube-arangodb
1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
Code Activity

Use relative links for generated docs (#1574)

Browse source
This commit is contained in:
Nikita Vaniasin 2024-01-16 09:56:17 +01:00 committed by GitHub
parent 1dc660ec5a
commit 38b7a0de11
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 24 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -6,6 +6,7 @@
- (Maintenance) Update Features Description, Supported K8S Versions and K8S Dependency to 1.28.5
- (Feature) (ML) Featurization Job Type
- (Bugfix) Don't abort plan in case of optional action timeout
- (Documentation) Use relative links for generated docs
## [1.2.36](https://github.com/arangodb/kube-arangodb/tree/1.2.36) (2024-01-08)
- (Documentation) Improvements and fixes for rendered documentation (GH pages)

4
docs/api/ArangoBackup.V1.md
View file

@ -57,7 +57,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
CredentialsSecretName is the name of the secret used while accessing repository
Links:
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)
This field is **immutable**: can't be changed after backup creation
@ -144,7 +144,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
CredentialsSecretName is the name of the secret used while accessing repository
Links:
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)
This field is **immutable**: can't be changed after backup creation

2
docs/api/ArangoBackupPolicy.V1.md
View file

@ -121,7 +121,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
CredentialsSecretName is the name of the secret used while accessing repository
Links:
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)
This field is **immutable**: can't be changed after backup creation

8
docs/api/ArangoDeployment.V1.md
View file

@ -966,7 +966,7 @@ architecture to the other. The first list item defines the new default
architecture for the deployment that you want to migrate to.
Links:
* [Architecture Change](/docs/how-to/arch_change.md)
* [Architecture Change](../how-to/arch_change.md)
Default Value: `['amd64']`
@ -1000,7 +1000,7 @@ There are two magic values for the secret name:
- `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
Links:
* [How to set root user password](/docs/how-to/set_root_user_password.md)
* [How to set root user password](../how-to/set_root_user_password.md)
***
@ -3335,7 +3335,7 @@ Enabled if this is set to `true`, the operator runs a sidecar container for
every Agent, DB-Server, Coordinator and Single server.
Links:
* [Metrics collection](/docs/metrics.md)
* [Metrics collection](../metrics.md)
Default Value: `false`
@ -6430,7 +6430,7 @@ Type: `map[string]meta.Duration` <sup>[\[ref\]](https://github.com/arangodb/kube
Actions keep map of the actions timeouts.
Links:
* [List of supported action names](/docs/generated/actions.md)
* [List of supported action names](../generated/actions.md)
* [Definition of meta.Duration](https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go)
Example:

4
pkg/apis/backup/v1/backup_spec.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -77,7 +77,7 @@ type ArangoBackupSpecOperation struct {
RepositoryURL string `json:"repositoryURL"`
// CredentialsSecretName is the name of the secret used while accessing repository
// +doc/immutable: can't be changed after backup creation
// +doc/link: Defining a secret for backup upload or download|/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download
// +doc/link: Defining a secret for backup upload or download|../backup-resource.md#defining-a-secret-for-backup-upload-or-download
CredentialsSecretName string `json:"credentialsSecretName,omitempty"`
}

4
pkg/apis/deployment/v1/bootstrap.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -58,7 +58,7 @@ type BootstrapSpec struct {
// - `None` specifies no action. This disables root password randomization. This is the default value. (Thus the root password is empty - not recommended)
// - `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
// +doc/type: map[string]string
// +doc/link: How to set root user password|/docs/how-to/set_root_user_password.md
// +doc/link: How to set root user password|../how-to/set_root_user_password.md
PasswordSecretNames PasswordSecretNameList `json:"passwordSecretNames,omitempty"`
}

2
pkg/apis/deployment/v1/deployment_metrics_spec.go
View file

@ -77,7 +77,7 @@ type MetricsSpec struct {
// Enabled if this is set to `true`, the operator runs a sidecar container for
// every Agent, DB-Server, Coordinator and Single server.
// +doc/default: false
// +doc/link: Metrics collection|/docs/metrics.md
// +doc/link: Metrics collection|../metrics.md
Enabled *bool `json:"enabled,omitempty"`
// deprecated
Image *string `json:"image,omitempty"`

4
pkg/apis/deployment/v1/deployment_spec.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -248,7 +248,7 @@ type DeploymentSpec struct {
// list item for the architecture, except when you want to migrate from one
// architecture to the other. The first list item defines the new default
// architecture for the deployment that you want to migrate to.
// +doc/link: Architecture Change|/docs/how-to/arch_change.md
// +doc/link: Architecture Change|../how-to/arch_change.md
// +doc/type: []string
// +doc/default: ['amd64']
Architecture ArangoDeploymentArchitecture `json:"architecture,omitempty"`

4
pkg/apis/deployment/v1/timeouts.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -37,7 +37,7 @@ type Timeouts struct {
// Actions keep map of the actions timeouts.
// +doc/type: map[string]meta.Duration
// +doc/link: List of supported action names|/docs/generated/actions.md
// +doc/link: List of supported action names|../generated/actions.md
// +doc/link: Definition of meta.Duration|https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go
// +doc/example: actions:
// +doc/example: AddMember: 30m

4
pkg/apis/deployment/v2alpha1/bootstrap.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -58,7 +58,7 @@ type BootstrapSpec struct {
// - `None` specifies no action. This disables root password randomization. This is the default value. (Thus the root password is empty - not recommended)
// - `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
// +doc/type: map[string]string
// +doc/link: How to set root user password|/docs/how-to/set_root_user_password.md
// +doc/link: How to set root user password|../how-to/set_root_user_password.md
PasswordSecretNames PasswordSecretNameList `json:"passwordSecretNames,omitempty"`
}

2
pkg/apis/deployment/v2alpha1/deployment_metrics_spec.go
View file

@ -77,7 +77,7 @@ type MetricsSpec struct {
// Enabled if this is set to `true`, the operator runs a sidecar container for
// every Agent, DB-Server, Coordinator and Single server.
// +doc/default: false
// +doc/link: Metrics collection|/docs/metrics.md
// +doc/link: Metrics collection|../metrics.md
Enabled *bool `json:"enabled,omitempty"`
// deprecated
Image *string `json:"image,omitempty"`

4
pkg/apis/deployment/v2alpha1/deployment_spec.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -248,7 +248,7 @@ type DeploymentSpec struct {
// list item for the architecture, except when you want to migrate from one
// architecture to the other. The first list item defines the new default
// architecture for the deployment that you want to migrate to.
// +doc/link: Architecture Change|/docs/how-to/arch_change.md
// +doc/link: Architecture Change|../how-to/arch_change.md
// +doc/type: []string
// +doc/default: ['amd64']
Architecture ArangoDeploymentArchitecture `json:"architecture,omitempty"`

4
pkg/apis/deployment/v2alpha1/timeouts.go
View file

@ -1,7 +1,7 @@
//
// DISCLAIMER
//
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -37,7 +37,7 @@ type Timeouts struct {
// Actions keep map of the actions timeouts.
// +doc/type: map[string]meta.Duration
// +doc/link: List of supported action names|/docs/generated/actions.md
// +doc/link: List of supported action names|../generated/actions.md
// +doc/link: Definition of meta.Duration|https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go
// +doc/example: actions:
// +doc/example: AddMember: 30m