-
Notifications
You must be signed in to change notification settings - Fork 54
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
📖 Add coast-to-coast documentation for Q4 2023 changes #533
📖 Add coast-to-coast documentation for Q4 2023 changes #533
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #533 +/- ##
=======================================
Coverage 83.72% 83.72%
=======================================
Files 20 20
Lines 811 811
=======================================
Hits 679 679
Misses 91 91
Partials 41 41
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job! Please reach out if you have questions about any of my suggestions.
896f1c6
to
a8e1268
Compare
Can I please ask for inclusion of the output of the |
Signed-off-by: Bryce Palmer <everettraven@gmail.com>
Signed-off-by: Bryce Palmer <everettraven@gmail.com>
a8e1268
to
3acecb5
Compare
since it contains all the features mentioned in this end to end demo doc Signed-off-by: Bryce Palmer <everettraven@gmail.com>
```sh | ||
cat << EOF > catalog.Dockerfile | ||
FROM scratch | ||
ADD catalog /configs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a directory structure (output of tree .
) of top level catalog dir. Ran through the tutorial for building a catalog, and faced the error that catalog/ isn't available, because I had index.yaml
inside parent dir.
Just a nit, but would be helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Following this tutorial command by command should have resulted in a tree
output of:
$ tree catalog/
catalog/
└── index.yaml
1 directory, 1 file
Following this tutorial without modifying the output paths in the commands should result in a successful build. While I can see how the output of this command would be helpful I'd prefer to do it as a follow up or provide a better explanation of building a File-Based Catalog image for OLMv1 in it's own document
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Description
Adds documentation with step by step instructions guiding a reader through using the new functionality added in Q4 2023, highlighting each new feature as it is used.
resolves Do an end-to-end demo (Q4 2023) #496
resolves Convert Q42023 e2e demos to documenation #502
Reviewer Checklist