Skip to content

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

Merged
grokspawn merged 3 commits into
operator-framework:mainfrom
everettraven:docs/e2e-demo-q42023
Dec 6, 2023
Merged

📖 Add coast-to-coast documentation for Q4 2023 changes#533
grokspawn merged 3 commits into
operator-framework:mainfrom
everettraven:docs/e2e-demo-q42023

Conversation

@everettraven

@everettraveneverettraven commented Nov 9, 2023

Copy link
Copy Markdown
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-ciopenshift-ciBot 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
@codecov

codecovBot commented Nov 9, 2023•
edited
Loading

Copy link
Copy Markdown

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
FlagCoverage Δ
e2e63.62% <ø> (ø)
unit78.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.

michaelryanpeter
michaelryanpeter reviewed Nov 9, 2023
View reviewed changes

@michaelryanpetermichaelryanpeter left a comment

Copy link
Copy Markdown
Contributor

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.

Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
grokspawn
grokspawn reviewed Nov 10, 2023
View reviewed changes
Comment threadinternal/catalogmetadata/client/client.go Outdated
@everettraveneverettraven mentioned this pull request Nov 13, 2023
Closed
@pgodowski

pgodowski commented Nov 14, 2023

Copy link
Copy Markdown

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?

pgodowski
pgodowski suggested changes Nov 14, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md
@everettraven
(docs): coast-to-coast demo doc for q4 2023 changes
520df03
Signed-off-by: Bryce Palmer <everettraven@gmail.com>
@everettraven
add examples of the expected output of commands to verify correct state
3acecb5
Signed-off-by: Bryce Palmer <everettraven@gmail.com>
everettraven
everettraven commented Nov 27, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md Outdated
@everettraven
set operator-controller version reference to v0.8.0
e4c53aa
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 ownerNovember 29, 2023 15:40
@openshift-ciopenshift-ciBot 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
varshaprasad96
varshaprasad96 reviewed Dec 5, 2023
View reviewed changes
Comment threaddocs/demos/coast-to-coast-q4-2023.md
```sh
cat << EOF > catalog.Dockerfile
FROM scratch
ADD catalog /configs

@varshaprasad96varshaprasad96Dec 5, 2023

Copy link
Copy Markdown
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.

@everettraveneverettravenDec 5, 2023

Copy link
Copy Markdown
ContributorAuthor

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

michaelryanpeter
michaelryanpeter approved these changes Dec 6, 2023
View reviewed changes

@michaelryanpetermichaelryanpeter left a comment

Copy link
Copy Markdown
Contributor

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 af730cfDec 6, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@varshaprasad96varshaprasad96varshaprasad96 left review comments
@grokspawngrokspawngrokspawn approved these changes
@pgodowskipgodowskiAwaiting requested review from pgodowski
+1 more reviewer
@michaelryanpetermichaelryanpetermichaelryanpeter approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

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

@everettraven@pgodowski@varshaprasad96@michaelryanpeter@grokspawn