Skip to content

Commit 60bfe2e

Browse files
authored
reorganze scorecard documentation (#5007)
Signed-off-by: austin <[email protected]>
1 parent 9fa13f3 commit 60bfe2e

File tree

16 files changed

+26
-33
lines changed

16 files changed

+26
-33
lines changed

website/content/en/build/_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ <h2 class="of-heading of-heading--xl">PUBLISH YOUR OPERATOR</h2>
8080
<h2 class="of-heading of-heading--xl">LEVEL UP YOUR OPERATOR</h2>
8181
<p class="of-section--largetext__content">Learn about operator maturity and the requirements to approach full auto
8282
pilot.</p>
83-
<a href="/docs/advanced-topics/operator-capabilities/operator-capabilities" class="of-button of-button--tertiary">Learn More
83+
<a href="/docs/overview/operator-capabilities" class="of-button of-button--tertiary">Learn More
8484
<svg class="of-button__icon" enable-background="new 0 0 22 22" version="1.1" viewBox="0 0 22 22"
8585
xml:space="preserve" xmlns="http://www.w3.org/2000/svg">
8686
<path

website/content/en/docs/advanced-topics/_index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

website/content/en/docs/advanced-topics/scorecard/_index.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

website/content/en/docs/best-practices/common-recommendation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ spec:
5353
- If you will integrate your project with OLM then, also check its [Best Practices][olm-best-practices] section.
5454
5555
[env-test]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest
56-
[scorecard]: /docs/advanced-topics/scorecard/
56+
[scorecard]: /docs/testing-operators/scorecard/
5757
[testing-with-envtest]: /docs/building-operators/golang/testing
5858
[olm-best-practices]: https://olm.operatorframework.io/docs/best-practices/
5959
[finalizers]: /docs/building-operators/golang/advanced-topics/#handle-cleanup-on-deletion

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ To implement application-specific tests, the SDK's test harness, [scorecard][sco
3333
[envtest]: https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest
3434
[envtest-setup]:https://book.kubebuilder.io/reference/envtest.html
3535
[writing-controller-tests]: https://book.kubebuilder.io/cronjob-tutorial/writing-tests.html
36-
[writing-kuttl-scorecard-tests]: /docs/advanced-topics/scorecard/kuttl-tests
37-
[writing-custom-scorecard-tests]: /docs/advanced-topics/scorecard/custom-tests
38-
[scorecard]: /docs/advanced-topics/scorecard/scorecard
36+
[writing-kuttl-scorecard-tests]: /docs/testing-operators/scorecard/kuttl-tests
37+
[writing-custom-scorecard-tests]: /docs/testing-operators/scorecard/custom-tests
38+
[scorecard]: /docs/testing-operators/scorecard/
3939
[gomega]: https://onsi.github.io/gomega/
4040
[kuttl]: https://kuttl.dev/

website/content/en/docs/contribution-guidelines/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,5 @@ If you are looking to develop similar solutions to allow users for example to cr
7676
[default-scaffold]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v3/controllers/admiral_controller.go
7777
[kb-issue]: https://github.com/kubernetes-sigs/kubebuilder/issues/1378
7878
[create-your-own-plugins]: https://master.book.kubebuilder.io/plugins/creating-plugins.html
79-
[scorecard]: /docs/advanced-topics/scorecard/scorecard/
79+
[scorecard]: /docs/testing-operators/scorecard/
8080
[kubebuilder]: https://github.com/kubernetes-sigs/kubebuilder

website/content/en/docs/olm-integration/generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,9 +440,9 @@ when you set `--version` when running `generate <bundle|packagemanifests>`.
440440
[bundle]: https://github.com/operator-framework/operator-registry/blob/v1.16.1/docs/design/operator-bundle.md
441441
[bundle-metadata]:https://github.com/operator-framework/operator-registry/blob/v1.12.6/docs/design/operator-bundle.md#bundle-annotations
442442
[install-modes]:https://github.com/operator-framework/operator-lifecycle-manager/blob/4197455/Documentation/design/building-your-csv.md#operator-metadata
443-
[olm-capabilities]:/docs/advanced-topics/operator-capabilities/operator-capabilities
443+
[olm-capabilities]:/docs/overview/operator-capabilities/
444444
[csv-markers]:/docs/building-operators/golang/references/markers
445445
[operatorhub]:https://operatorhub.io/
446-
[scorecard]:/docs/advanced-topics/scorecard
446+
[scorecard]:/docs/testing-operators/scorecard/
447447
[operatorhub_validator]:https://olm.operatorframework.io/docs/tasks/creating-operator-bundle/#validating-your-bundle
448448
[relatedimages]:https://pkg.go.dev/github.com/operator-framework/[email protected]/pkg/operators/v1alpha1#RelatedImage

website/content/en/docs/overview/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file f
140140

141141
[ansible-guide]:/docs/building-operators/ansible/quickstart/
142142
[bug_guide]:/docs/contribution-guidelines/reporting-issues/
143-
[capability_levels]: /docs/advanced-topics/operator-capabilities/operator-capabilities
143+
[capability_levels]: /docs/overview/operator-capabilities/
144144
[contrib]: https://github.com/operator-framework/operator-sdk/blob/master/CONTRIBUTING.MD
145145
[controller_runtime]: https://github.com/kubernetes-sigs/controller-runtime
146146
[faq]: /docs/faqs/

website/content/en/docs/overview/cheat-sheet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ make bundle CHANNELS=fast,preview DEFAULT_CHANNEL=stable VERSION=1.0.0 IMG=<some
7575
[gkvs]: https://book.kubebuilder.io/cronjob-tutorial/gvks.html
7676
[extend-k8s-api]: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/
7777
[webhooks-k8s-doc]: https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/
78-
[scorcard]: /docs/advanced-topics/scorecard/
78+
[scorcard]: /docs/testing-operators/scorecard/
7979
[molecule-tests]: /docs/building-operators/ansible/testing-guide
8080
[helm-chart-tests]: https://helm.sh/docs/topics/chart_tests/
81-
[cli]: /docs/cli/
81+
[cli]: /docs/cli/

0 commit comments

Comments
 (0)