Skip to content

Commit 38b7a0d

Browse files
nikita-vanyasinnikita-vanyasin
authored
Use relative links for generated docs (#1574)
1 parent 1dc660e commit 38b7a0d

File tree

13 files changed

+24
-23
lines changed

13 files changed

+24
-23
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- (Maintenance) Update Features Description, Supported K8S Versions and K8S Dependency to 1.28.5
77
- (Feature) (ML) Featurization Job Type
88
- (Bugfix) Don't abort plan in case of optional action timeout
9+
- (Documentation) Use relative links for generated docs
910

1011
## [1.2.36](https://github.com/arangodb/kube-arangodb/tree/1.2.36) (2024-01-08)
1112
- (Documentation) Improvements and fixes for rendered documentation (GH pages)

‎docs/api/ArangoBackup.V1.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
5757
CredentialsSecretName is the name of the secret used while accessing repository
5858

5959
Links:
60-
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
60+
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)
6161

6262
This field is **immutable**: can't be changed after backup creation
6363

@@ -144,7 +144,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
144144
CredentialsSecretName is the name of the secret used while accessing repository
145145

146146
Links:
147-
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
147+
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)
148148

149149
This field is **immutable**: can't be changed after backup creation
150150

‎docs/api/ArangoBackupPolicy.V1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
121121
CredentialsSecretName is the name of the secret used while accessing repository
122122

123123
Links:
124-
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
124+
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)
125125

126126
This field is **immutable**: can't be changed after backup creation
127127

‎docs/api/ArangoDeployment.V1.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,7 @@ architecture to the other. The first list item defines the new default
966966
architecture for the deployment that you want to migrate to.
967967

968968
Links:
969-
* [Architecture Change](/docs/how-to/arch_change.md)
969+
* [Architecture Change](../how-to/arch_change.md)
970970

971971
Default Value: `['amd64']`
972972

@@ -1000,7 +1000,7 @@ There are two magic values for the secret name:
10001000
- `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
10011001

10021002
Links:
1003-
* [How to set root user password](/docs/how-to/set_root_user_password.md)
1003+
* [How to set root user password](../how-to/set_root_user_password.md)
10041004

10051005
***
10061006

@@ -3335,7 +3335,7 @@ Enabled if this is set to `true`, the operator runs a sidecar container for
33353335
every Agent, DB-Server, Coordinator and Single server.
33363336

33373337
Links:
3338-
* [Metrics collection](/docs/metrics.md)
3338+
* [Metrics collection](../metrics.md)
33393339

33403340
Default Value: `false`
33413341

@@ -6430,7 +6430,7 @@ Type: `map[string]meta.Duration` <sup>[\[ref\]](https://github.com/arangodb/kube
64306430
Actions keep map of the actions timeouts.
64316431

64326432
Links:
6433-
* [List of supported action names](/docs/generated/actions.md)
6433+
* [List of supported action names](../generated/actions.md)
64346434
* [Definition of meta.Duration](https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go)
64356435

64366436
Example:

‎pkg/apis/backup/v1/backup_spec.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -77,7 +77,7 @@ type ArangoBackupSpecOperation struct {
7777
RepositoryURL string `json:"repositoryURL"`
7878
// CredentialsSecretName is the name of the secret used while accessing repository
7979
// +doc/immutable: can't be changed after backup creation
80-
// +doc/link: Defining a secret for backup upload or download|/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download
80+
// +doc/link: Defining a secret for backup upload or download|../backup-resource.md#defining-a-secret-for-backup-upload-or-download
8181
CredentialsSecretName string `json:"credentialsSecretName,omitempty"`
8282
}
8383

‎pkg/apis/deployment/v1/bootstrap.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -58,7 +58,7 @@ type BootstrapSpec struct {
5858
// - `None` specifies no action. This disables root password randomization. This is the default value. (Thus the root password is empty - not recommended)
5959
// - `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
6060
// +doc/type: map[string]string
61-
// +doc/link: How to set root user password|/docs/how-to/set_root_user_password.md
61+
// +doc/link: How to set root user password|../how-to/set_root_user_password.md
6262
PasswordSecretNames PasswordSecretNameList `json:"passwordSecretNames,omitempty"`
6363
}
6464

‎pkg/apis/deployment/v1/deployment_metrics_spec.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ type MetricsSpec struct {
7777
// Enabled if this is set to `true`, the operator runs a sidecar container for
7878
// every Agent, DB-Server, Coordinator and Single server.
7979
// +doc/default: false
80-
// +doc/link: Metrics collection|/docs/metrics.md
80+
// +doc/link: Metrics collection|../metrics.md
8181
Enabled *bool `json:"enabled,omitempty"`
8282
// deprecated
8383
Image *string `json:"image,omitempty"`

‎pkg/apis/deployment/v1/deployment_spec.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -248,7 +248,7 @@ type DeploymentSpec struct {
248248
// list item for the architecture, except when you want to migrate from one
249249
// architecture to the other. The first list item defines the new default
250250
// architecture for the deployment that you want to migrate to.
251-
// +doc/link: Architecture Change|/docs/how-to/arch_change.md
251+
// +doc/link: Architecture Change|../how-to/arch_change.md
252252
// +doc/type: []string
253253
// +doc/default: ['amd64']
254254
Architecture ArangoDeploymentArchitecture `json:"architecture,omitempty"`

‎pkg/apis/deployment/v1/timeouts.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -37,7 +37,7 @@ type Timeouts struct {
3737

3838
// Actions keep map of the actions timeouts.
3939
// +doc/type: map[string]meta.Duration
40-
// +doc/link: List of supported action names|/docs/generated/actions.md
40+
// +doc/link: List of supported action names|../generated/actions.md
4141
// +doc/link: Definition of meta.Duration|https://github.com/kubernetes/apimachinery/blob/v0.26.6/pkg/apis/meta/v1/duration.go
4242
// +doc/example: actions:
4343
// +doc/example: AddMember: 30m

‎pkg/apis/deployment/v2alpha1/bootstrap.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -58,7 +58,7 @@ type BootstrapSpec struct {
5858
// - `None` specifies no action. This disables root password randomization. This is the default value. (Thus the root password is empty - not recommended)
5959
// - `Auto` specifies automatic name generation, which is `<deploymentname>-root-password`.
6060
// +doc/type: map[string]string
61-
// +doc/link: How to set root user password|/docs/how-to/set_root_user_password.md
61+
// +doc/link: How to set root user password|../how-to/set_root_user_password.md
6262
PasswordSecretNames PasswordSecretNameList `json:"passwordSecretNames,omitempty"`
6363
}
6464

0 commit comments

Comments
 (0)