Fix deprecated doc links #2737
Merged
Fix deprecated doc links #2737
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Catherine Chan-Tse <cchantse@redhat.com>
|
/lgtm |
perdasilva
added
approved
|
Note: I changed my lgtm for an approved XD |
|
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: oceanc80 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
awgreene
reviewed
Apr 13, 2022
| @@ -10,9 +10,10 @@ | |||
|
|
|||
| User documentation can be found on the [OLM website][olm-docs]. | |||
|
|
|||
|
|
|||
exdx
reviewed
Apr 13, 2022
|
|
||
| ## Descriptors | ||
|
|
||
| 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. | ||
|
|
||
| [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) | ||
| [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) |
There was a problem hiding this comment.
nit: better not to use downstream examples in the upstream project
There was a problem hiding this comment.
@exdx I'd agree with this - do you want to take a stab at finding an example that's upstream agnostic?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Catherine Chan-Tse cchantse@redhat.com
Description of the change:
Closes #2736
Fixes deprecated documentation links.
Motivation for the change:
Provide better documentation clarity for users
Reviewer Checklist
/doc[FLAKE]are truly flaky[FLAKE]tag are no longer flaky