📖 Update documentation for "Finding extensions to install" #696
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #696 +/- ##
=======================================
Coverage 64.01% 64.01%
=======================================
Files 22 22
Lines 1370 1370
=======================================
Hits 877 877
Misses 442 442
Partials 51 51
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| ## Package queries | ||
|
|
||
| Available packages in a catalog | ||
| : `jq -s '.[] | select( .schema == "olm.package")` |
There was a problem hiding this comment.
Nit: For all of the jq commands shown here can we use the "code fence" syntax (i.e triple backtick)? This results in a user being able to easily copy the command to their clipboard via a handy dandy button and IMO presents a nicer docs experience when used where possible.
There was a problem hiding this comment.
I created a follow up issue: #698
Basically, I can't get the code blocks to render in the definition list. I think I might need to move the list to a table, but if I get the code block to work, the table gets stretched really wide. There is probably something really small that I am missing with mkdocs' bespoke syntax, but after an hour trying to figure it out yesterday, I thought I would try this temporary hack.
In the interest of making the Kubecon deadline, I would prefer to get the rest of the content in place and circle back after. WDYT, @everettraven?
There was a problem hiding this comment.
SGTM - I don't think this nit should at all block this from merging!
everettraven
left a comment
everettraven
left a comment
There was a problem hiding this comment.
One minor nit that I don't think should hold this PR. Otherwise looks good to me!
| ``` | ||
|
|
||
| **This CR is most helpful when exploring the versions of a package that are available for installation on cluster, and the upgrade graph of versions** (eg if v0.5.0 of `argocd-operator` is installed on cluster, what is the next upgrade available? The answer is v0.6.0). | ||
| After you add a catalog of exetensions to your cluster, you must port forward your catalog as a service. |
There was a problem hiding this comment.
typo exetensions should be extensions
|
|
||
| ## Procedure | ||
|
|
||
| 1. Port forward the catalog server sevice: |
| $ curl http://localhost:8080/catalogs/operatorhubio/all.json | jq -s '.[] | select(.schema == "olm.package") | .name' | ||
| ``` | ||
| ??? success |
There was a problem hiding this comment.
Sorry, I had a draft for this comment, but I forgot to submit it.
The ??? creates a code block with a toggle.
I find it especially useful for long lists of example output after you run a command.
Fix typos called out in operator-framework#696 (comment) and operator-framework#696 (comment).
* Fix catalog queries code blocks Improve the formatting of the code blocks in the catalog queries description list * Fix typos Fix typos called out in #696 (comment) and #696 (comment).
4 participants
Description
Preview links
Reviewer Checklist