Skip to content

OSDOCS-2602: Improve CatalogSource concept docs #35853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
adellape merged 1 commit into from
Sep 10, 2021
Merged

OSDOCS-2602: Improve CatalogSource concept docs #35853

adellape merged 1 commit into from
Sep 10, 2021

Conversation

@adellape
Copy link
Contributor

@adellape adellape commented Aug 26, 2021 •
edited
Loading

https://issues.redhat.com/browse/OSDOCS-2602

  • Updated OLM's global namespace to be a replaceable attribute based on upstream (the olm namespace for the openshift-origin distro) vs downstream (the openshift-marketplace namespace for any other distro).
  • Re-wrote/re-org'd content from intro para
  • Added [TIP] admonition
  • Updated the example YAML and added more callout descriptions along the way
  • Added status section in YAML example
  • Added "Additional resources"
  • Added "Viewing Operator catalog source status by using the CLI"

Preview:

@adellape adellape added this to the Next Release milestone Aug 26, 2021
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 26, 2021
@netlify
Copy link

netlify bot commented Aug 26, 2021 •
edited
Loading

✔️ Deploy Preview for osdocs ready!

🔨 Explore the source changes: 46c773e

🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/613a7eb884335e0008e30c71

😎 Browse the preview: https://deploy-preview-35853--osdocs.netlify.app

@adellape adellape force-pushed the cs_update branch 7 times, most recently from 4446625 to 4a90647 Compare August 26, 2021 22:41
Xia-Zhao-rh
Xia-Zhao-rh reviewed Aug 27, 2021
View reviewed changes
@adellape adellape added the peer-review-needed Signifies that the peer review team needs to review this PR label Aug 27, 2021
mikemckiernan
mikemckiernan reviewed Aug 27, 2021
View reviewed changes
Copy link

@mikemckiernan mikemckiernan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One sentence that's a bit long and a nit. Looks good, please let me know if there's anything I can clarify.

@mikemckiernan mikemckiernan added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Aug 27, 2021
@adellape adellape force-pushed the cs_update branch 4 times, most recently from 506cc29 to 1bcbbd9 Compare August 27, 2021 20:51
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 27, 2021
@adellape adellape force-pushed the cs_update branch 2 times, most recently from 46f337a to 65d7b1d Compare August 27, 2021 22:19
@adellape
Copy link
Contributor Author

adellape commented Aug 27, 2021

Added to description:

Updated OLM's global namespace to be a replaceable attribute based on upstream (the olm namespace for the openshift-origin distro) vs downstream (the openshift-marketplace namespace for any other distro).

@adellape adellape force-pushed the cs_update branch 2 times, most recently from 747008a to 6c7cff5 Compare September 8, 2021 20:12
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 9, 2021
@openshift-ci
Copy link

openshift-ci bot commented Sep 9, 2021

New changes are detected. LGTM label has been removed.

@adellape adellape force-pushed the cs_update branch 13 times, most recently from dd87303 to 52b8707 Compare September 9, 2021 18:54
@adellape
Copy link
Contributor Author

adellape commented Sep 9, 2021 •
edited
Loading

@dmesser @Xia-Zhao-rh

I think some additional hints around the pod backing the catalog and troubleshooting that in case the catalog status fails to transition to READY would be great.

Added a Viewing Operator catalog source status using the CLI section to match the existing subscription status-related procedure, which is now linked to from the "Catalog source" concept page.

Overall diff of changes since last QE/PM review:

https://github.com/openshift/openshift-docs/compare/6c7cff5d511d42fd65f7fa434f7b7109782046a9..46c773e981fcc29d26da94ddcfbcfff510124993

mikemckiernan
mikemckiernan reviewed Sep 9, 2021
View reviewed changes
Copy link

@mikemckiernan mikemckiernan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully the review helps. Ignore anything you disagree with. If I goofed something, please let me know.

@adellape adellape force-pushed the cs_update branch 2 times, most recently from 85d9d14 to f0e6451 Compare September 9, 2021 21:35
@adellape
Copy link
Contributor Author

adellape commented Sep 10, 2021

Merging this so I can build off of it for the catalogImageTemplate docs in #36199, but if there are any further suggestions/edits to come from this PR, I can follow-up there.

@adellape adellape merged commit e3e929d into openshift:main Sep 10, 2021
@adellape adellape deleted the cs_update branch September 10, 2021 16:54
@adellape
Copy link
Contributor Author

adellape commented Sep 10, 2021

/cherrypick enterprise-4.9

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Sep 10, 2021

@adellape: new pull request created: #36263

Details

In response to this:

/cherrypick enterprise-4.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Sep 10, 2021
Merged
This was referenced Sep 15, 2021
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@mikemckiernan mikemckiernan mikemckiernan left review comments

@Xia-Zhao-rh Xia-Zhao-rh Xia-Zhao-rh left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@Xia-Zhao-rh Xia-Zhao-rh

Labels

branch/enterprise-4.6 branch/enterprise-4.7 branch/enterprise-4.8 branch/enterprise-4.9 peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

Next Release

Development

Successfully merging this pull request may close these issues.

5 participants

@adellape @Xia-Zhao-rh @dmesser @openshift-cherrypick-robot @mikemckiernan