Skip to content

Commit a033f85

Browse files
authored
Update links from manual and doc to docs and reference (#53)
1 parent 7960b8b commit a033f85

9 files changed

Lines changed: 24 additions & 24 deletions

File tree

charts/ff-common/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Otherwise, they can be found at `/usr/local/tomcat/logs`
179179

180180
The Frank!Framework will start with different settings enabled, depending on what DTAP stage is configured.
181181

182-
For more information about DTAP stages read: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html
182+
For more information about DTAP stages read: https://docs.frankframework.org/docs/manual/deployment/dtap/
183183

184184
## Notable changes
185185

charts/ff-common/templates/_configmap.env.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
ConfigMap for generating default environment variables for the app
33
*/}}
44
{{- define "ff-common.configmap.env.tpl" -}}
5-
{{- $dtapStage := .Values.frank.dtap.stage | required "The DTAP stage is a required value. Ref: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html" -}}
5+
{{- $dtapStage := .Values.frank.dtap.stage | required "The DTAP stage is a required value. Ref: https://docs.frankframework.org/docs/manual/deployment/dtap/" -}}
66
apiVersion: v1
77
kind: ConfigMap
88
metadata:

charts/ff-test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ See the documentation for the Frank!Framework chart for more information.
7878

7979
The Frank!Framework will start with different settings enabled, depending on what DTAP stage is configured.
8080

81-
For more information about DTAP stages read: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html
81+
For more information about DTAP stages read: https://docs.frankframework.org/docs/manual/deployment/dtap/
8282

8383
## Notable changes
8484

charts/frank-console/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ environmentVariables:
8282
8383
To fine tune memory refer to the [Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html#BABDJJFI).
8484
85-
Refer to the [Frank!Framework Manual](https://frank-manual.readthedocs.io/) for more information.
85+
Refer to the [Frank!Framework Docs](https://docs.frankframework.org/) for more information.
8686
8787
| Name | Description | Value |
8888
| --------------------------------------------- | ----------------------------------------------------------------------------------------------------- | --------------------------- |

charts/frank-console/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ image:
6868
##
6969
## To fine tune memory refer to the [Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html#BABDJJFI).
7070
##
71-
## Refer to the [Frank!Framework Manual](https://frank-manual.readthedocs.io/) for more information.
71+
## Refer to the [Frank!Framework Docs](https://docs.frankframework.org/) for more information.
7272
## @descriptionEnd
7373

7474

charts/frank2example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ See the documentation for the Frank!Framework chart for more information.
5252

5353
The Frank!Framework will start with different settings enabled, depending on what DTAP stage is configured.
5454

55-
For more information about DTAP stages read: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html
55+
For more information about DTAP stages read: https://docs.frankframework.org/docs/manual/deployment/dtap/
5656

5757
## Notable changes
5858

charts/frankframework/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ helm delete my-frankframework
7979

8080
The Frank!Framework will start with different settings enabled, depending on what DTAP stage is configured. Like if the Ladybug should be disabled, or if authentication should be enabled.
8181

82-
For more information about DTAP stages read: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html
82+
For more information about DTAP stages read: https://docs.frankframework.org/docs/manual/deployment/dtap/
8383

8484
### Version tag
8585

@@ -98,15 +98,15 @@ But it can be overridden with the `application.security.console.authentication.t
9898
If the separate console is enabled, the console will **not** use the same authentication as the Frank!Framework.
9999
And always needs to be configured.
100100

101-
Read more about configuring the authentication in the [Frank!Framework Manual](https://frank-manual.readthedocs.io/en/latest/deploying/security.html).
101+
Read more about configuring the authentication in the [Frank!Framework Docs](https://docs.frankframework.org/docs/manual/deployment/authorization/#security-overview).
102102

103103
### Credentials and AuthAlias
104104

105105
To configure credentials or "AuthAliases" for the Frank!Framework, it is recommended to use Kubernetes Secrets.
106106
The Frank!Framework will automatically pick up the secrets and make them available as AuthAliases.
107107

108-
Read more about the Kubernetes Credential Provider [in the FF! Doc](https://frankdoc.frankframework.org/#/credential-providers/KubernetesCredentialFactory).
109-
For more information about credentials, see the [documentation](https://frank-manual.readthedocs.io/en/latest/deploying/credentials.html).
108+
Read more about the Kubernetes Credential Provider [in the FF! Reference](https://reference.frankframework.org/#/credential-providers/KubernetesCredentialFactory).
109+
For more information about credentials, see the [documentation](https://docs.frankframework.org/docs/manual/deployment/credentials/).
110110

111111
### Ladybug Database
112112

@@ -171,7 +171,7 @@ You can also configure the name of the instance. And what configurations to load
171171
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
172172
| `application.dtap.stage` | (Required) Set the `DTAP` stage. Options: `LOC`, `DEV`, `TST`, `ACC`, `PRD` | `""` |
173173
| `application.dtap.stage` | The DTAP stage is used to enable and disable features in the Frank!Framework. | |
174-
| `application.dtap.stage` | ref: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html | |
174+
| `application.dtap.stage` | ref: https://docs.frankframework.org/docs/manual/deployment/dtap/ | |
175175
| `application.dtap.side` | Set the `DTAP` side of where the instance is running, and for sideSpecific properties | `""` |
176176
| `application.instance.name` | Set the name of the Frank! instance (default is the `fullname`) | `""` |
177177
| `application.instance.name` | Keep in mind that the name is used for the default datasource. | |
@@ -206,14 +206,14 @@ It is possible to add environment variables with the `.Values.environmentVariabl
206206
To configure credentials or "AuthAliases" for the Frank!Framework, it is recommended to use Kubernetes Secrets.
207207
The Frank!Framework will automatically pick up the secrets and make them available as AuthAliases.
208208

209-
Read more about it [in the FF! Doc](https://frankdoc.frankframework.org/#/credential-providers/KubernetesCredentialFactory).
210-
For more information about credentials, see the [documentation](https://frank-manual.readthedocs.io/en/latest/deploying/credentials.html).
209+
Read more about it [in the FF! Reference](https://reference.frankframework.org/#/credential-providers/KubernetesCredentialFactory).
210+
For more information about credentials, see the [documentation](https://docs.frankframework.org/docs/manual/deployment/credentials/).
211211

212-
To disable or configure authentication for the console, please read the [Frank!Framework Manual](https://frank-manual.readthedocs.io/en/latest/advancedDevelopment/authorization/consoleAndLadybug.html).
212+
To disable or configure authentication for the console, please read the [Frank!Framework Docs](https://docs.frankframework.org/docs/manual/deployment/authorization/).
213213

214214
To fine tune memory refer to the [Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html#BABDJJFI).
215215

216-
Refer to the [Frank!Framework Manual](https://frank-manual.readthedocs.io/) for more information.
216+
Refer to the [Frank!Framework Docs](https://docs.frankframework.org/) for more information.
217217

218218
| Name | Description | Value |
219219
| ----------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------- |
@@ -231,7 +231,7 @@ The Frank!Framework chart allows you to generate configmaps and secrets from val
231231
This is useful if you want to add local users or resources to the Frank!Framework.
232232

233233
⚠️ **While it can be useful to generate secrets from the `values.yaml`, this is not considered safe and only intended for testing purposes. Production environments should use the `extraVolumes` to mount secrets.**
234-
ℹ️ **Credentials and AuthAliases that are needed by the Frank!Framework are picked up automatically from Kubernetes Secrets. Read more about it [in the FF! Doc](https://frankdoc.frankframework.org/#/credential-providers/KubernetesCredentialFactory)**
234+
ℹ️ **Credentials and AuthAliases that are needed by the Frank!Framework are picked up automatically from Kubernetes Secrets. Read more about it [in the FF! Reference](https://reference.frankframework.org/#/credential-providers/KubernetesCredentialFactory)**
235235

236236
Be sure to set a subPath and a mountPath if you want to avoid conflicts and use multiple secrets.
237237
With one secret, the subPath and mountPath are not needed. And it would be possible to implement items, like this:
@@ -462,7 +462,7 @@ Also added `.Values.envFrom` to allow for the mounting of environment variables
462462

463463
Removed `.Values.application.security.http.authentication: "false"`. This is a more secure default.
464464
The `dtap.stage` will determine if authentication is enabled or not. It is possible to override this with environment variables.
465-
Read mote in the [Frank!Framework Manual](https://frank-manual.readthedocs.io/en/latest/deploying/security.html).
465+
Read mote in the [Frank!Framework Docs](https://docs.frankframework.org/docs/manual/deployment/authorization/#security-overview).
466466

467467
### 0.4.0
468468

charts/frankframework/templates/configmap.env.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{{/*
22
ConfigMap for generating default environment variables for the app
33
*/}}
4-
{{- $dtapStage := .Values.application.dtap.stage | required "The DTAP stage is a required value. Ref: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html" -}}
4+
{{- $dtapStage := .Values.application.dtap.stage | required "The DTAP stage is a required value. Ref: https://docs.frankframework.org/docs/manual/deployment/dtap/" -}}
55
apiVersion: v1
66
kind: ConfigMap
77
metadata:

charts/frankframework/values.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ image:
6666
application:
6767
## @param application.dtap.stage (Required) Set the `DTAP` stage. Options: `LOC`, `DEV`, `TST`, `ACC`, `PRD`
6868
## @extra application.dtap.stage The DTAP stage is used to enable and disable features in the Frank!Framework.
69-
## @extra application.dtap.stage ref: https://frank-manual.readthedocs.io/en/latest/deploying/dtapAndProperties.html
69+
## @extra application.dtap.stage ref: https://docs.frankframework.org/docs/manual/deployment/dtap/
7070
## @param application.dtap.side Set the `DTAP` side of where the instance is running, and for sideSpecific properties
7171
##
7272
dtap:
@@ -118,14 +118,14 @@ ports: []
118118
## To configure credentials or "AuthAliases" for the Frank!Framework, it is recommended to use Kubernetes Secrets.
119119
## The Frank!Framework will automatically pick up the secrets and make them available as AuthAliases.
120120
##
121-
## Read more about it [in the FF! Doc](https://frankdoc.frankframework.org/#/credential-providers/KubernetesCredentialFactory).
122-
## For more information about credentials, see the [documentation](https://frank-manual.readthedocs.io/en/latest/deploying/credentials.html).
121+
## Read more about it [in the FF! Reference](https://reference.frankframework.org/#/credential-providers/KubernetesCredentialFactory).
122+
## For more information about credentials, see the [documentation](https://docs.frankframework.org/docs/manual/deployment/credentials/).
123123
##
124-
## To disable or configure authentication for the console, please read the [Frank!Framework Manual](https://frank-manual.readthedocs.io/en/latest/advancedDevelopment/authorization/consoleAndLadybug.html).
124+
## To disable or configure authentication for the console, please read the [Frank!Framework Docs](https://docs.frankframework.org/docs/manual/deployment/authorization/).
125125
##
126126
## To fine tune memory refer to the [Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html#BABDJJFI).
127127
##
128-
## Refer to the [Frank!Framework Manual](https://frank-manual.readthedocs.io/) for more information.
128+
## Refer to the [Frank!Framework Docs](https://docs.frankframework.org/) for more information.
129129
## @descriptionEnd
130130

131131
## @param environmentVariables [object] Set environment variables for the Frank!Framework
@@ -156,7 +156,7 @@ envFrom: [ ]
156156
## This is useful if you want to add local users or resources to the Frank!Framework.
157157
##
158158
## ⚠️ **While it can be useful to generate secrets from the `values.yaml`, this is not considered safe and only intended for testing purposes. Production environments should use the `extraVolumes` to mount secrets.**
159-
## ℹ️ **Credentials and AuthAliases that are needed by the Frank!Framework are picked up automatically from Kubernetes Secrets. Read more about it [in the FF! Doc](https://frankdoc.frankframework.org/#/credential-providers/KubernetesCredentialFactory)**
159+
## ℹ️ **Credentials and AuthAliases that are needed by the Frank!Framework are picked up automatically from Kubernetes Secrets. Read more about it [in the FF! Reference](https://reference.frankframework.org/#/credential-providers/KubernetesCredentialFactory)**
160160
##
161161
## Be sure to set a subPath and a mountPath if you want to avoid conflicts and use multiple secrets.
162162
## With one secret, the subPath and mountPath are not needed. And it would be possible to implement items, like this:

0 commit comments

Comments
 (0)