Skip to content

Commit f8d7f78

Browse files
authored
Fix deprecated doc links (#2737)
Signed-off-by: Catherine Chan-Tse <[email protected]>
1 parent c5ef8b4 commit f8d7f78

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

CONTRIBUTING.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ This is a rough outline of what a contributor's workflow looks like:
3131
- Identify or create an issue.
3232
- Create a topic branch from where to base the contribution. This is usually the master branch.
3333
- Make commits of logical units.
34-
- Make sure commit messages are in the proper format (see below).
35-
- Ensure all relevant commit messages contain a valid sign-off message (see below).
34+
- Make sure commit messages are in the proper format ([see below][commit-messages]).
35+
- Ensure all relevant commit messages contain a valid sign-off message ([see below][commit-messages]).
3636
- Push changes in a topic branch to a personal fork of the repository.
3737
- Submit a pull request to the operator-framework/operator-lifecycle-manager repository.
3838
- Wait and respond to feedback from the maintainers listed in the OWNERS file.
@@ -47,7 +47,7 @@ It can be helpful after submitting a PR to self-review your changes. This allows
4747

4848
When opening PRs that are in a rough draft or WIP state, prefix the PR description with `WIP: ...` or create a draft PR. This can help save reviewer's time by communicating the state of a PR ahead of time. Draft/WIP PRs can be a good way to get early feedback from reviewers on the implementation, focusing less on smaller details, and more on the general approach of changes.
4949

50-
When contributing changes that require a new dependency, check whether it's feasable to directly vendor that code [without introducing a new dependency](https://go-proverbs.github.io/).
50+
When contributing changes that require a new dependency, check whether it's feasible to directly vendor that code [without introducing a new dependency](https://go-proverbs.github.io/).
5151

5252
Each PR must be labeled with at least one "lgtm" label and at least one "approved" label before it can be merged. Maintainers that have approval permissions are listed in the "approvers" column in the root [OWNERS][owners] file.
5353

@@ -62,19 +62,19 @@ In addition to the linked style documentation, OLM formats Golang packages using
6262

6363
Please follow this style to make the OLM project easier to review, maintain and develop.
6464

65-
### Sign-off ([DCO][DCO])
65+
### Commit Messages and Sign-off ([DCO][DCO])
6666

6767
A [sign-off][sign-off] is a line towards the end of a commit message that certifies the commit author(s).
6868

69-
For more information on the structuring of commit messages, read the information in the [DCO](https://github.com/apps/dco) application that the OLM projects uses.
69+
For more information on the structuring of commit messages, read the information in the [DCO][dco] application that the OLM projects uses.
7070

7171
## Documentation
7272

7373
If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature.
7474

7575
The OLM documentation mainly lives in the [operator-framework/olm-docs][olm-docs] repository.
7676

77-
[operator_framework]: https://groups.google.com/forum/#!forum/operator-framework
77+
[operator_framework]: <https://groups.google.com/forum/#!forum/operator-framework>
7878
[dco]: <https://developercertificate.org/>
7979
[owners]: <https://github.com/operator-framework/operator-lifecycle-manager/blob/master/OWNERS>
8080
[issues]: <https://github.com/operator-framework/operator-lifecycle-manager/issues>
@@ -84,3 +84,4 @@ The OLM documentation mainly lives in the [operator-framework/olm-docs][olm-docs
8484
[sign-off]: <https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff>
8585
[goimports]: <https://pkg.go.dev/golang.org/x/tools/cmd/goimports>
8686
[gofmt]: <https://pkg.go.dev/cmd/gofmt>
87+
[commit-messages]: <https://github.com/operator-framework/operator-lifecycle-manager/blob/master/CONTRIBUTING.md#commit-messages-and-sign-off-dco>

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010

1111
User documentation can be found on the [OLM website][olm-docs].
1212

13+
1314
## Overview
1415

15-
This project is a component of the [Operator Framework](https://github.com/operator-framework), an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post](https://operatorhub.io/what-is-an-operator) and learn about practical use cases at [OLM-Book](https://operator-framework.github.io/olm-book/).
16+
This project is a component of the [Operator Framework](https://github.com/operator-framework), an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post](https://operatorhub.io/what-is-an-operator) and learn about practical use cases at the [OLM website][olm-docs].
1617

1718
OLM extends Kubernetes to provide a declarative way to install, manage, and upgrade Operators and their dependencies in a cluster. It provides the following features:
1819

@@ -47,13 +48,13 @@ Operators can behave like managed service providers. Their user interface on the
4748

4849
## Getting Started
4950

50-
Check the [Getting Started][olm-getting-started] section.
51+
Check out the [Getting Started][olm-getting-started] section in the docs.
5152

5253
### Installation
5354

5455
Install OLM on a Kubernetes cluster by following the [installation guide][installation-guide].
5556

56-
For a complete end-to-end example of how OLM fits into the Operator Framework, see the [Operator Framework Getting Started Guide](https://github.com/operator-framework/getting-started). Also, see [Getting Started on OperatorHub.io](https://operatorhub.io/getting-started).
57+
For a complete end-to-end example of how OLM fits into the Operator Framework, see the [Operator Framework website](https://operatorframework.io/about/) and the [Getting Started guide on OperatorHub.io](https://operatorhub.io/getting-started).
5758

5859
## User Interface (Running the console Locally)
5960

@@ -96,13 +97,14 @@ Learn more about the components used by OLM by reading about the [architecture]
9697

9798
OLM standardizes interactions with operators by requiring that the interface to an operator be via the Kubernetes API. Because we expect users to define the interfaces to their applications, OLM currently uses CRDs to define the Kubernetes API interactions.
9899

99-
Examples: [EtcdCluster CRD](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/0.9.4/etcdclusters.etcd.database.coreos.com.crd.yaml), [EtcdBackup CRD](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/0.9.4/etcdbackups.etcd.database.coreos.com.crd.yaml)
100+
Examples: [EtcdCluster CRD](https://github.com/redhat-openshift-ecosystem/community-operators-prod/blob/main/operators/etcd/0.9.4/etcdclusters.etcd.database.coreos.com.crd.yaml),
101+
[EtcdBackup CRD](https://github.com/redhat-openshift-ecosystem/community-operators-prod/blob/main/operators/etcd/0.9.4/etcdbackups.etcd.database.coreos.com.crd.yaml)
100102

101103
## Descriptors
102104

103105
OLM introduces the notion of “descriptors” of both `spec` and `status` fields in kubernetes API responses. Descriptors are intended to indicate various properties of a field in order to make decisions about their content. For example, this can drive connecting two operators together (e.g. connecting the connection string from a mysql instance to a consuming application) and be used to drive rich interactions in a UI.
104106

105-
[See an example of a ClusterServiceVersion with descriptors](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/0.9.2/etcdoperator.v0.9.2.clusterserviceversion.yaml)
107+
[See an example of a ClusterServiceVersion with descriptors](https://github.com/redhat-openshift-ecosystem/community-operators-prod/blob/main/operators/etcd/0.9.2/etcdoperator.v0.9.2.clusterserviceversion.yaml)
106108

107109
## Dependency Resolution
108110

@@ -129,7 +131,7 @@ OLM has the concept of catalogs, which are repositories of application definitio
129131

130132
Catalogs contain a set of Packages, which map “channels” to a particular application definition. Channels allow package authors to write different upgrade paths for different users (e.g. alpha vs. stable).
131133

132-
Example: [etcd package](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/etcd.package.yaml)
134+
Example: [etcd package](https://github.com/redhat-openshift-ecosystem/community-operators-prod/blob/main/operators/etcd/etcd.package.yaml)
133135

134136
Users can subscribe to channels and have their operators automatically updated when new versions are released.
135137

@@ -154,7 +156,7 @@ Catalogs are served internally over a grpc interface to OLM from [operator-regis
154156

155157
## Samples
156158

157-
To explore any operator samples using the OLM, see the [https://operatorhub.io/](https://operatorhub.io/) and its resources in [Community Operators](https://github.com/operator-framework/community-operators/tree/master/upstream-community-operators).
159+
To explore any operator samples using the OLM, see the [https://operatorhub.io/](https://operatorhub.io/) and its resources in [Community Operators](https://github.com/k8s-operatorhub/community-operators/tree/main/operators).
158160

159161
## Community and how to get involved
160162

@@ -194,6 +196,6 @@ Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][licens
194196
[operator-framework-community]: https://github.com/operator-framework/community
195197
[operator-framework-communication]: https://github.com/operator-framework/community#get-involved
196198
[operator-framework-meetings]: https://github.com/operator-framework/community#meetings
197-
[contributor-documentation]: https://olm.operatorframework.io/docs/contribution-guidelines/
199+
[contributor-documentation]: ./CONTRIBUTING.md
198200
[olm-getting-started]: https://olm.operatorframework.io/docs/getting-started/
199201
[installation-guide]: doc/install/install.md

doc/dev/reporting_flakes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Reporting flakes
22

33
If you are struggling to get your PR through because unrelated e2e or unit tests are randomly failing, it's likely
4-
you are being plagued by a flaky test 😱, a test that wasn't constructed as carefully as it should have been as is
4+
you are being plagued by a flaky test 😱, a test that wasn't constructed as carefully as it should have been and is
55
failing even when it should be succeeding. When this happens, check our [issues](https://github.com/operator-framework/operator-lifecycle-manager/issues)
66
to see if it has been filed before. Search also in the `closed issues`. If you find one, re-open it if necessary.
77
Otherwise, [file](https://github.com/operator-framework/operator-lifecycle-manager/issues/new) a flaky test issue.

0 commit comments

Comments
 (0)