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

📖 Add coast-to-coast documentation for Q4 2023 changes #533

Merged

Conversation

everettraven
Copy link
Contributor

Description

Reviewer Checklist

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

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 9, 2023
Copy link

codecov bot commented Nov 9, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d02bca5) 83.72% compared to head (e4c53aa) 83.72%.
Report is 3 commits behind head on main.

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           
Flag Coverage Δ
e2e 63.62% <ø> (ø)
unit 78.54% <ø> (ø)

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.

Copy link
Contributor

@michaelryanpeter michaelryanpeter left a 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.

docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
docs/demos/coast-to-coast-q4-2023.md Outdated Show resolved Hide resolved
@pgodowski
Copy link

Can I please ask for inclusion of the output of the kubectl get commands, so that the readers of the document could understand the result, even when they do not run the actual sequence of the commands on the real cluster?

Signed-off-by: Bryce Palmer <everettraven@gmail.com>
Signed-off-by: Bryce Palmer <everettraven@gmail.com>
since it contains all the features mentioned in this
end to end demo doc

Signed-off-by: Bryce Palmer <everettraven@gmail.com>
@everettraven everettraven marked this pull request as ready for review November 29, 2023 15:40
@everettraven everettraven requested a review from a team as a code owner November 29, 2023 15:40
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 29, 2023
```sh
cat << EOF > catalog.Dockerfile
FROM scratch
ADD catalog /configs
Copy link
Member

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.

Copy link
Contributor Author

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

Copy link
Contributor

@michaelryanpeter michaelryanpeter left a comment

Choose a reason for hiding this comment

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

lgtm

@grokspawn grokspawn added this pull request to the merge queue Dec 6, 2023
Merged via the queue into operator-framework:main with commit af730cf Dec 6, 2023
15 checks passed
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.

Convert Q42023 e2e demos to documenation Do an end-to-end demo (Q4 2023)
5 participants