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

📖 Quickstart #1142

Merged

Conversation

perdasilva
Copy link
Contributor

@perdasilva perdasilva commented Aug 19, 2024

Description

Quickstart documentation: please review it in gdocs here

Closes #1123

Reviewer Checklist

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

@perdasilva perdasilva requested a review from a team as a code owner August 19, 2024 19:26
@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 Aug 19, 2024
Copy link

netlify bot commented Aug 19, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit aaf25f8
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/66d9621e16426c0008bc000a
😎 Deploy Preview https://deploy-preview-1142--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 Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.12%. Comparing base (04ee036) to head (aaf25f8).
Report is 19 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1142      +/-   ##
==========================================
- Coverage   77.27%   77.12%   -0.15%     
==========================================
  Files          35       36       +1     
  Lines        1945     2020      +75     
==========================================
+ Hits         1503     1558      +55     
- Misses        308      327      +19     
- Partials      134      135       +1     
Flag Coverage Δ
e2e 57.62% <ø> (-1.10%) ⬇️
unit 55.39% <ø> (+0.53%) ⬆️

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.

@perdasilva perdasilva force-pushed the perdasilva/docs/quistart branch 10 times, most recently from 9a99c15 to 4d1e2c0 Compare August 24, 2024 00:44
@perdasilva perdasilva force-pushed the perdasilva/docs/quistart branch 2 times, most recently from 77c26b6 to 7d8ecf1 Compare August 29, 2024 19:11
Per Goncalves da Silva added 2 commits August 30, 2024 14:37
Signed-off-by: Per Goncalves da Silva <[email protected]>
Signed-off-by: Per Goncalves da Silva <[email protected]>
@perdasilva perdasilva force-pushed the perdasilva/docs/quistart branch from 7d8ecf1 to 1a5d6cd Compare August 30, 2024 16:25
@perdasilva perdasilva changed the title [WIP] 📖 Quickstart 📖 Quickstart Sep 5, 2024
@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 Sep 5, 2024
@perdasilva
Copy link
Contributor Author

please review it in gdocs here

Signed-off-by: Per Goncalves da Silva <[email protected]>
@perdasilva perdasilva force-pushed the perdasilva/docs/quistart branch from 1a5d6cd to aaf25f8 Compare September 5, 2024 07:47
@perdasilva
Copy link
Contributor Author

Please review the quickstart docs here - this PR will be subsequently updated

source:
type: image
image:
ref: quay.io/operatorhubio/catalog:latest
Copy link
Member

Choose a reason for hiding this comment

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

We install this catalog now as part of the install.sh script. Should we call that out?

Copy link
Member

Choose a reason for hiding this comment

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

I approved and put in the merge queue, we can iterate if we feel more changes are really necessary.

@joelanford joelanford added this pull request to the merge queue Sep 5, 2024
Merged via the queue into operator-framework:main with commit c53453b Sep 5, 2024
17 of 18 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.

Docs: Quickstart Guide
2 participants