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

📖 Content organization #1324

Conversation

perdasilva
Copy link
Contributor

@perdasilva perdasilva commented Oct 1, 2024

Description

Closes #1305

This PR takes a first stab at organizing the content in docs/drafts into some kind of coherent structure.
There's still much to do in terms of making the documents more uniform and prettying them up.

Reviewer Checklist

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

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
@perdasilva perdasilva requested a review from a team as a code owner October 1, 2024 14:39
@perdasilva perdasilva marked this pull request as draft October 1, 2024 14:39
@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 Oct 1, 2024
Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 0ffea04
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/66fe92412b755600081edc86
😎 Deploy Preview https://deploy-preview-1324--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.

@perdasilva perdasilva force-pushed the perdasilva/docs/putting-it-all-together branch 25 times, most recently from f2e586d to 8cbd83b Compare October 2, 2024 15:58
@perdasilva perdasilva force-pushed the perdasilva/docs/putting-it-all-together branch 3 times, most recently from 575d580 to a552d87 Compare October 2, 2024 16:18
Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.17%. Comparing base (de17da9) to head (0ffea04).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1324   +/-   ##
=======================================
  Coverage   76.17%   76.17%           
=======================================
  Files          41       41           
  Lines        2409     2409           
=======================================
  Hits         1835     1835           
  Misses        401      401           
  Partials      173      173           
Flag Coverage Δ
e2e 58.32% <ø> (ø)
unit 53.17% <ø> (ø)

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/putting-it-all-together branch 3 times, most recently from 4bbe7df to 392d279 Compare October 2, 2024 16:55
@perdasilva perdasilva marked this pull request as ready for review October 2, 2024 16:55
@perdasilva perdasilva removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 2, 2024
@perdasilva perdasilva force-pushed the perdasilva/docs/putting-it-all-together branch from 392d279 to f8879bb Compare October 2, 2024 16:58
@perdasilva perdasilva changed the title 📖 [DRAFT] doc content organization 📖 Content organization Oct 2, 2024
@perdasilva perdasilva force-pushed the perdasilva/docs/putting-it-all-together branch 3 times, most recently from c15c145 to eccbe4b Compare October 2, 2024 17:08
Copy link
Contributor

@grokspawn grokspawn left a comment

Choose a reason for hiding this comment

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

Only nits. I have some concerns about the evident need to hide ToC (since I don't know why), but it doesn't rise to the level of challenging the move.

Separately, we need some love on the contents. In general I've tried to flag comments about existing content in a clear way so we can keep this PR focused on the portal organization / format instead. I've identified one existing editorial issue I think we can easily solve though, and a potential netlify problem when previewing bulleted lists that I ran into with semver template docs in the past.

docs/index.md Outdated Show resolved Hide resolved
docs/project/olmv1_community.md Outdated Show resolved Hide resolved
docs/project/olmv1_architecture.md Outdated Show resolved Hide resolved
@perdasilva perdasilva force-pushed the perdasilva/docs/putting-it-all-together branch from eccbe4b to 45ee3e2 Compare October 3, 2024 12:23
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
@perdasilva perdasilva force-pushed the perdasilva/docs/putting-it-all-together branch from 45ee3e2 to 0ffea04 Compare October 3, 2024 12:46
Copy link
Member

@LalatenduMohanty LalatenduMohanty left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 3, 2024
@grokspawn grokspawn added this pull request to the merge queue Oct 3, 2024
Merged via the queue into operator-framework:main with commit 814bf63 Oct 3, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Collect all 1.0.0 draft docs into a presentable hierarchy
3 participants