Skip to content
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.

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

📖 Update "Adding a catalog of extensions" #694

Conversation

michaelryanpeter
Copy link
Contributor

@michaelryanpeter michaelryanpeter commented Mar 12, 2024

#693
Rendered preview: https://deploy-preview-694--olmv1.netlify.app/tasks/adding-a-catalog/

  • Add prerequisites
  • Format content as a procedure with steps
  • Add PollInterval field
  • Add configuration to mkdocs.yml for style/formatting of codeblocks

Description

Updating the docs in anticipation of KubeCon

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@michaelryanpeter michaelryanpeter requested a review from a team as a code owner March 12, 2024 19:48
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 12, 2024
@michaelryanpeter michaelryanpeter force-pushed the docs-update-adding-catalog-of-extensions branch from 4083df4 to 4bd6235 Compare March 12, 2024 19:55
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 12, 2024
operator-framework#693

- Add prerequisites
- Format content as a procedure with steps
- Add PollInterval field

Signed-off-by: Michael Ryan Peter <mipeter@redhat.com>
@michaelryanpeter michaelryanpeter force-pushed the docs-update-adding-catalog-of-extensions branch from 4bd6235 to f495394 Compare March 12, 2024 19:55
- Edit `mkdocs.yml`
- Add support for definition lists
- Syntax highlighting
Copy link

netlify bot commented Mar 13, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit d8ef5a7
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/65f1d4a51e5baf0008bcb048
😎 Deploy Preview https://deploy-preview-694--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Mar 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.01%. Comparing base (38da6fc) to head (d8ef5a7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #694   +/-   ##
=======================================
  Coverage   64.01%   64.01%           
=======================================
  Files          22       22           
  Lines        1370     1370           
=======================================
  Hits          877      877           
  Misses        442      442           
  Partials       51       51           
Flag Coverage Δ
e2e 47.37% <ø> (ø)
unit 58.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@michaelryanpeter michaelryanpeter force-pushed the docs-update-adding-catalog-of-extensions branch from ca98c83 to 95c4712 Compare March 13, 2024 14:52
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

LGTM!

@everettraven everettraven added this pull request to the merge queue Mar 13, 2024
Merged via the queue into operator-framework:main with commit ebe2c03 Mar 13, 2024
17 checks passed
2. Apply the catalog CR:

``` terminal
$ kubectl apply -f <catalog_cr>.yaml

Choose a reason for hiding this comment

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

should this be kubectl apply -f catalog_cr.yaml?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants