Skip to content

Commit 07cbb52

Browse files
authored
(docs): update broken links (#6599)
* (docs): update broken links Signed-off-by: Bryce Palmer <[email protected]> * fix cert-manager link Signed-off-by: Bryce Palmer <[email protected]> --------- Signed-off-by: Bryce Palmer <[email protected]>
1 parent ed46ea0 commit 07cbb52

File tree

9 files changed

+34
-35
lines changed

9 files changed

+34
-35
lines changed

website/config.toml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -187,133 +187,133 @@ url_latest_version = "https://sdk.operatorframework.io"
187187

188188
[[params.versions]]
189189
version = "v1.19"
190-
url = "https://v1-19-x.sdk.operatorframework.io"
190+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.19.x/website/content/en/docs"
191191
kube_version = "1.23"
192192
client_go_version = "v0.23.1"
193193

194194
[[params.versions]]
195195
version = "v1.18"
196-
url = "https://v1-18-x.sdk.operatorframework.io"
196+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.18.x/website/content/en/docs"
197197
kube_version = "1.21"
198198
client_go_version = "v0.23.1"
199199

200200
[[params.versions]]
201201
version = "v1.17"
202-
url = "https://v1-17-x.sdk.operatorframework.io"
202+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.17.x/website/content/en/docs"
203203
kube_version = "1.21"
204204
client_go_version = "v0.23.1"
205205

206206
[[params.versions]]
207207
version = "v1.16"
208-
url = "https://v1-16-x.sdk.operatorframework.io"
208+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.16.x/website/content/en/docs"
209209
kube_version = "1.21"
210210
client_go_version = "v0.22.2"
211211

212212
[[params.versions]]
213213
version = "v1.15"
214-
url = "https://v1-15-x.sdk.operatorframework.io"
214+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.15.x/website/content/en/docs"
215215
kube_version = "1.21"
216216
client_go_version = "v0.22.2"
217217

218218
[[params.versions]]
219219
version = "v1.14"
220-
url = "https://v1-14-x.sdk.operatorframework.io"
220+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.14.x/website/content/en/docs"
221221
kube_version = "1.21"
222222
client_go_version = "v0.22.2"
223223

224224
[[params.versions]]
225225
version = "v1.13"
226-
url = "https://v1-13-x.sdk.operatorframework.io"
226+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.13.x/website/content/en/docs"
227227
kube_version = "1.21"
228228
client_go_version = "v0.22.1"
229229

230230
[[params.versions]]
231231
version = "v1.12"
232-
url = "https://v1-12-x.sdk.operatorframework.io"
232+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.12.x/website/content/en/docs"
233233
kube_version = "1.21"
234234
client_go_version = "v0.21.2"
235235

236236
[[params.versions]]
237237
version = "v1.11"
238-
url = "https://v1-11-x.sdk.operatorframework.io"
238+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.11.x/website/content/en/docs"
239239
kube_version = "1.20.2"
240240
client_go_version = "v0.21.2"
241241

242242
[[params.versions]]
243243
version = "v1.10"
244-
url = "https://v1-10-x.sdk.operatorframework.io"
244+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.10.x/website/content/en/docs"
245245
kube_version = "1.20.2"
246246
client_go_version = "v0.21.2"
247247

248248
[[params.versions]]
249249
version = "v1.9"
250-
url = "https://v1-9-x.sdk.operatorframework.io"
250+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.9.x/website/content/en/docs"
251251
kube_version = "1.20.2"
252252
client_go_version = "v0.20.2"
253253

254254
[[params.versions]]
255255
version = "v1.8"
256-
url = "https://v1-8-x.sdk.operatorframework.io"
256+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.8.x/website/content/en/docs"
257257
kube_version = "1.20.2"
258258
client_go_version = "v0.20.2"
259259

260260
[[params.versions]]
261261
version = "v1.7"
262-
url = "https://v1-7-x.sdk.operatorframework.io"
262+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.7.x/website/content/en/docs"
263263
kube_version = "1.19.4"
264264
client_go_version = "v0.20.2"
265265

266266
[[params.versions]]
267267
version = "v1.6"
268-
url = "https://v1-6-x.sdk.operatorframework.io"
268+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.6.x/website/content/en/docs"
269269
kube_version = "1.19.4"
270270
client_go_version = "v0.20.2"
271271

272272
[[params.versions]]
273273
version = "v1.5"
274-
url = "https://v1-5-x.sdk.operatorframework.io"
274+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.5.x/website/content/en/docs"
275275
kube_version = "1.19.4"
276276
client_go_version = "v0.20.2"
277277

278278
[[params.versions]]
279279
version = "v1.4"
280-
url = "https://v1-4-x.sdk.operatorframework.io"
280+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.4.x/website/content/en/docs"
281281
kube_version = "1.19.4"
282282
client_go_version = "v0.20.1"
283283

284284
[[params.versions]]
285285
version = "v1.3"
286-
url = "https://v1-3-x.sdk.operatorframework.io"
286+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.3.x/website/content/en/docs"
287287
kube_version = "1.19.4"
288288
client_go_version = "v0.19.4"
289289

290290
[[params.versions]]
291291
version = "v1.2"
292-
url = "https://v1-2-x.sdk.operatorframework.io"
292+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.2.x/website/content/en/docs"
293293
kube_version = "1.18.8"
294294
client_go_version = "v0.18.8"
295295

296296
[[params.versions]]
297297
version = "v1.1"
298-
url = "https://v1-1-x.sdk.operatorframework.io"
298+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.1.x/website/content/en/docs"
299299
kube_version = "1.18.2"
300300
client_go_version = "v0.18.8"
301301

302302
[[params.versions]]
303303
version = "v1.0"
304-
url = "https://v1-0-x.sdk.operatorframework.io"
304+
url = "https://github.com/operator-framework/operator-sdk/tree/v1.0.x/website/content/en/docs"
305305
kube_version = "1.18.2"
306306
client_go_version = "v0.18.6"
307307

308308
[[params.versions]]
309309
version = "v0.19"
310-
url = "https://v0-19-x.sdk.operatorframework.io"
310+
url = "https://github.com/operator-framework/operator-sdk/tree/v0.19.x/website/content/en/docs"
311311
kube_version = "1.18.2"
312312
client_go_version = "v12.0.0+incompatible"
313313

314314
[[params.versions]]
315315
version = "v0.18"
316-
url = "https://v0-18-x.sdk.operatorframework.io"
316+
url = "https://github.com/operator-framework/operator-sdk/tree/v0.18.x/website/content/en/docs"
317317
kube_version = "1.18.2"
318318
client_go_version = "v12.0.0+incompatible"
319319

website/content/en/docs/building-operators/ansible/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ OLM will manage creation of most if not all resources required to run your opera
368368
[image-reg-config]:/docs/olm-integration/cli-overview#private-bundle-and-catalog-image-registries
369369
[install-guide]:/docs/building-operators/ansible/installation
370370
[layout-doc]:/docs/building-operators/ansible/reference/scaffolding
371-
[legacy-quickstart-doc]:https://v0-19-x.sdk.operatorframework.io/docs/ansible/quickstart/
371+
[legacy-quickstart-doc]:https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/ansible/quickstart.md
372372
[kustomize-docs]:https://kustomize.io/
373373
[migration-guide]:/docs/building-operators/ansible/migration
374374
[tutorial-bundle]:/docs/olm-integration/tutorial-bundle

website/content/en/docs/building-operators/golang/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ For further steps regarding the deployment of the operator, creation of custom r
440440
[multigroup-kubebuilder-doc]: https://book.kubebuilder.io/migration/multi-group.html
441441
[what-are-the-the-differences-between-kubebuilder-and-operator-sdk]: /docs/faqs/#what-are-the-the-differences-between-kubebuilder-and-operator-sdk
442442
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime/releases
443-
[cert-manager-docs]: https://cert-manager.io/docs/installation/upgrading/
443+
[cert-manager-docs]: https://cert-manager.io/docs/installation/upgrade/
444444
[webhook-doc]: https://book.kubebuilder.io/reference/webhook-overview.html
445445
[healthz-ping]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/healthz#CheckHandler
446446
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime/releases

website/content/en/docs/building-operators/golang/references/markers.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ These examples assume `Memcached`, `MemcachedSpec`, and `MemcachedStatus` are th
151151

152152
## Deprecated markers
153153

154-
[Markers][deprecated-markers] supported by `operator-sdk` prior to v1.0.0 are deprecated.
154+
Markers supported by `operator-sdk` prior to v1.0.0 are deprecated.
155155
You can migrate to the new marker system by running the following script:
156156

157157
```console
@@ -166,4 +166,3 @@ $ ./migrate-markers.sh path/to/*_types.go
166166
[csv-x-desc]:https://github.com/openshift/console/blob/master/frontend/packages/operator-lifecycle-manager/src/components/descriptors/reference/reference.md
167167
[csv-spec]:https://github.com/operator-framework/operator-lifecycle-manager/blob/e0eea22/doc/design/building-your-csv.md
168168
[csv-crds]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#your-custom-resource-definitions
169-
[deprecated-markers]:https://v0-19-x.sdk.operatorframework.io/docs/golang/references/markers/

website/content/en/docs/building-operators/golang/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -539,8 +539,8 @@ Next, check out the following:
539539
[kubebuilder_entrypoint_doc]: https://book.kubebuilder.io/cronjob-tutorial/empty-main.html
540540
[kubebuilder_layout_doc]:https://book.kubebuilder.io/cronjob-tutorial/basic-project.html
541541
[kubernetes-extend-api]: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/
542-
[legacy-quickstart-doc]:https://v0-19-x.sdk.operatorframework.io/docs/golang/legacy/quickstart/
543-
[legacy_CLI]:https://v0-19-x.sdk.operatorframework.io/docs/cli
542+
[legacy-quickstart-doc]:https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/golang/legacy/quickstart.md
543+
[legacy_CLI]:https://github.com/operator-framework/operator-sdk/tree/v0.19.x/website/content/en/docs/cli
544544
[manager_go_doc]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/manager#Manager
545545
[markers]: https://book.kubebuilder.io/reference/markers.html
546546
[memcached_controller]: https://github.com/operator-framework/operator-sdk/blob/latest/testdata/go/v3/memcached-operator/controllers/memcached_controller.go

website/content/en/docs/building-operators/helm/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ Next, check out the following:
357357
1. The [advanced features][advanced-features] doc for more use cases and under-the-hood details.
358358

359359

360-
[legacy-quickstart-doc]:https://v0-19-x.sdk.operatorframework.io/docs/helm/quickstart/
360+
[legacy-quickstart-doc]:https://github.com/operator-framework/operator-sdk/tree/v0.19.x/website/content/en/docs/helm/quickstart.md
361361
[migration-guide]:/docs/building-operators/helm/migration
362362
[install-guide]:/docs/building-operators/helm/installation
363363
[image-reg-config]:/docs/olm-integration/cli-overview#private-bundle-and-catalog-image-registries

website/content/en/docs/upgrading-sdk-version/v0.1.0-migration-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ At this point you should be able to build and run your operator to verify that i
308308
[controller-go-doc]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg#hdr-Controller
309309
[request-go-doc]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile#Request
310310
[result-go-doc]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile#Result
311-
[client-api-doc]: https://v0-19-x.sdk.operatorframework.io/docs/golang/references/client/
311+
[client-api-doc]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/golang/references/client.md
312312
[manager-go-doc]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/manager
313-
[register-3rd-party-resources]: https://v0-19-x.sdk.operatorframework.io/docs/golang/legacy/quickstart/#adding-3rd-party-resources-to-your-operator
314-
[user-guide-build-run]: https://v0-19-x.sdk.operatorframework.io/docs/golang/legacy/quickstart/#build-and-run-the-operator
313+
[register-3rd-party-resources]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/golang/legacy/quickstart.md#adding-3rd-party-resources-to-your-operator
314+
[user-guide-build-run]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/golang/legacy/quickstart.md#build-and-run-the-operator

website/content/en/docs/upgrading-sdk-version/v0.19.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ to use `UpgradeError` instead of `UpdateError`.
5252
_See [#3269](https://github.com/operator-framework/operator-sdk/pull/3269) for more details._
5353

5454
[migration-guide]: /docs/building-operators/golang/migration/
55-
[migration-guide-v0.19.0]: https://v0-19-x.sdk.operatorframework.io/docs/golang/project_migration_guide/
55+
[migration-guide-v0.19.0]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/golang/project_migration_guide.md

website/content/en/docs/upgrading-sdk-version/version-upgrade-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1373,12 +1373,12 @@ first `COPY` from `COPY /*.yaml manifests/` to `COPY deploy/olm-catalog/<operato
13731373
[mercurial]: https://www.mercurial-scm.org/downloads
13741374
[migrating-to-modules]: https://github.com/golang/go/wiki/Modules#migrating-to-modules
13751375
[modules-wiki]: https://github.com/golang/go/wiki/Modules#migrating-to-modules
1376-
[print-deps-cli]: https://v0-19-x.sdk.operatorframework.io/docs/cli/operator-sdk_print-deps/
1376+
[print-deps-cli]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/cli/operator-sdk_print-deps.md
13771377
[changelog]: https://github.com/operator-framework/operator-sdk/blob/v1.3.0/CHANGELOG.md
13781378
[release-notes]: https://github.com/operator-framework/operator-sdk/releases
13791379
[v0.1.0-migration-guide]: ../v0.1.0-migration-guide
13801380
[manifest-format]: https://github.com/operator-framework/operator-registry#manifest-format
1381-
[client-doc]: https://v0-19-x.sdk.operatorframework.io/docs/golang/legacy/references/client/
1381+
[client-doc]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/website/content/en/docs/golang/references/client.md
13821382
[api-rules]: https://github.com/kubernetes/kubernetes/tree/36981002246682ed7dc4de54ccc2a96c1a0cbbdb/api/api-rules
13831383
[generating-crd]: https://book.kubebuilder.io/reference/generating-crd.html
13841384
[markers]: https://book.kubebuilder.io/reference/markers.html

0 commit comments

Comments
 (0)