Skip to content

Commit 126a95d

Browse files
porridgejoelanford
andauthored
Editorial improvements to Reference/file-based-catalogs.md. (#330)
Signed-off-by: Marcin Owsiany <[email protected]> Co-authored-by: Joe Lanford <[email protected]>
1 parent 372a697 commit 126a95d

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

content/en/docs/Reference/file-based-catalogs.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ they are present, they must adhere to their respective field schemas. Any other
115115
116116
The combination of the `schema`, `package`, and `name` fields must be unique within a catalog.
117117
118-
See the [Properties](#properties) section for information about the property type.
118+
See the [Properties](#properties) section for information about the `properties` field.
119119
120120
Here is an example of an object which adheres to the `Meta` schema:
121121
@@ -162,8 +162,9 @@ callers to parse the object using a more specific type that maps to the "my.othe
162162

163163
### OLM-defined schemas
164164

165-
An OLM catalog currently uses three schemas: `olm.package`, `olm.channel`, and `olm.bundle`, which correspond to OLM's
166-
existing package, channel, and bundle concepts.
165+
An OLM catalog currently uses the following schemas:
166+
- `olm.package`, `olm.channel`, and `olm.bundle`, which correspond to OLM's existing package, channel, and bundle concepts,
167+
- `olm.deprecations`, which provides information for support and upgrades.
167168

168169
Each operator package in a catalog requires exactly one `olm.package` blob, at least one `olm.channel` blob, and one or
169170
more `olm.bundle` blobs.
@@ -173,7 +174,7 @@ more `olm.bundle` blobs.
173174
174175
#### `olm.package`
175176

176-
An `olm.package` defines package-level metadata for an operator. This includes its name, description, default channel
177+
An `olm.package` defines package-level (i.e. top level) metadata for an operator. This includes its name, description, default channel
177178
and icon.
178179

179180
Here is an example of an `olm.package` blob:
@@ -226,7 +227,7 @@ entries:
226227

227228
# replaces is optional. It is the name of the bundle that is replaced
228229
# by this entry. It must be present in the entry list, unless this
229-
# entry is the channel tail. Channel tails are allowed to have replaces
230+
# entry is a channel tail. Channel tails are allowed to have replaces
230231
# values that are not present in the entry list.
231232
replaces: foo.v0.2.1
232233

@@ -256,7 +257,7 @@ necessary to locate the bundle's contents, the related images used by the operat
256257
can be used by clients to orchestrate lifecycling behavior, build user interfaces, provide filtering mechanisms, etc.
257258
For example, the "olm.gvk" property can be used to specify a Kubernetes group, version, and kind that this operator
258259
version provides, and the "olm.gvk.required" property can be used to specify a GVK that this operator requires.
259-
components that understand these properties can implement dependency resolution by matching GVK providers and
260+
Components that understand these properties can implement dependency resolution by matching GVK providers and
260261
requirers.
261262

262263
See the [Properties](#properties) section for information about the properties understood by OLM.
@@ -846,7 +847,7 @@ There are many possible ways to build a catalog, but an extremely simple approac
846847
## Automation
847848

848849
Operator authors and catalog maintainers are encouraged to automate their catalog maintenance with CI/CD workflows.
849-
catalog maintainers could further improve on this by building Git-ops automation that:
850+
Catalog maintainers could further improve on this by building Git-ops automation that:
850851
- Checks that PR authors are permitted to make the requested changes (e.g. updating their package's image reference)
851852
- Checks that the catalog updates pass `opm validate`
852853
- Checks that the updated bundle and/or catalog image reference(s) exist, the catalog images run successfully in a cluster,

0 commit comments

Comments
 (0)