Skip to content

Commit 43005d6

Browse files
authored
Merge pull request #670 from camilamacedo86/fix-link-doc-olm
Fix broken links - OLM Documentation was replaced by doc
2 parents b087a51 + e7a860e commit 43005d6

File tree

7 files changed

+8
-7
lines changed

7 files changed

+8
-7
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
1+
# Intelij IDEA
2+
.idea
23
# Created by https://www.gitignore.io/api/macos,linux,windows,visualstudiocode
34
# Edit at https://www.gitignore.io/?templates=macos,linux,windows,visualstudiocode
45

docs/ci.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Operators submitted to the `community-operators/` directory are tested against a
4646
[registry-bundle]:https://github.com/operator-framework/operator-registry#manifest-format
4747
[courier-verify]:https://github.com/operator-framework/operator-courier/#command-line-interface
4848
[registry]:https://github.com/operator-framework/operator-registry
49-
[olm-alm-examples]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#crd-templates
49+
[olm-alm-examples]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#crd-templates
5050
[courier-docs]:https://github.com/operator-framework/operator-courier/#operator-courier
5151
[quay]:https://quay.io
5252
[quay-create-repo]:https://docs.quay.io/guides/create-repo.html

docs/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This repository makes use of the [Operator Framework](https://github.com/operato
1515

1616
To add your operator to any of the above platforms, you will need to submit your Operator packaged for use with [Operator Lifecycle Manager](https://github.com/operator-framework/operator-lifecycle-manager/). This mainly consists of a YAML file called `ClusterServiceVersion` which contains references to all of the `CustomResource Definitions` (CRDs), RBAC rules, `Deployment` and container image needed to install and securely run your Operator. It also contains user-visible info like a description of its features and supported Kubernetes versions (also see further recommendations below). Note that your Operator is not supposed to self-register it's CRDs.
1717

18-
[Follow this guide to create an OLM-compatible CSV for your operator](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md). You can also see an example [here](./required-fields.md#example-csv). An Operator's CSV must contain the fields and mentioned [here](./required-fields.md#required-fields-for-operatorhub) for it to be displayed properly within the various platforms.
18+
[Follow this guide to create an OLM-compatible CSV for your operator](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md). You can also see an example [here](./required-fields.md#example-csv). An Operator's CSV must contain the fields and mentioned [here](./required-fields.md#required-fields-for-operatorhub) for it to be displayed properly within the various platforms.
1919

2020
### Bundle format
2121

docs/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Thanks submitting your Operator. Please check below list before you create your
66
* [ ] Are you familiar with our [contribution guidelines](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md)?
77
* [ ] Have you [packaged and deployed](https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md) your Operator for Operator Framework?
88
* [ ] Have you tested your Operator with all Custom Resource Definitions?
9-
* [ ] Have you tested your Operator in all supported [installation modes](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#operator-metadata)?
9+
* [ ] Have you tested your Operator in all supported [installation modes](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#operator-metadata)?
1010

1111
### Updates to existing Operators
1212

docs/required-fields.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Preparing your CSV for use with OLM
44

5-
Before you begin, we strongly advise that you follow Operator-Lifecycle-Manager's docs on [building a CSV for the Operator Framework](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md). These outline the functional purpose of the CSV and which fields are required for installing your Operator CSV through OLM.
5+
Before you begin, we strongly advise that you follow Operator-Lifecycle-Manager's docs on [building a CSV for the Operator Framework](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md). These outline the functional purpose of the CSV and which fields are required for installing your Operator CSV through OLM.
66

77
## Required fields for OperatorHub
88

docs/testing-operators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -376,5 +376,5 @@ operator-sdk scorecard --olm-deployed --crds-dir my-operator/ --csv-path my-oper
376376

377377
## Additional Resources
378378

379-
* [Cluster Service Version Spec](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md)
379+
* [Cluster Service Version Spec](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md)
380380
* [Example Bundle](https://github.com/operator-framework/community-operators/tree/master/upstream-community-operators/etcd)

upstream-community-operators/lib-bucket-provisioner/lib-bucket-provisioner.v1.0.0.clusterserviceversion.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ spec:
9797
9898
This operator package is **CRD-only** and the operator is a no-op operator.
9999
100-
Instead, bucket provisioners using this library are using these CRD's and using CSV [required-crds](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md#required-crds) them so that OLM can install it as a dependency.
100+
Instead, bucket provisioners using this library are using these CRD's and using CSV [required-crds](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#required-crds) them so that OLM can install it as a dependency.
101101
102102
### Generic Bucket Provisioning
103103

0 commit comments

Comments
 (0)