Skip to content

[#32601][prism] Initial Deep Dive Documentation#32143

Merged
lostluck merged 10 commits intoapache:masterfrom
lostluck:prismDeepDive
Oct 3, 2024
Merged

[#32601][prism] Initial Deep Dive Documentation#32143
lostluck merged 10 commits intoapache:masterfrom
lostluck:prismDeepDive

Conversation

@lostluck
Copy link
Copy Markdown
Contributor

@lostluck lostluck commented Aug 9, 2024 •
edited
Loading

Add additional, initial, in depth documentation for how Prism executes pipelines, and it's various systems.

See the rendered view for the mermaid diagrams. https://github.com/apache/beam/pull/32143/files?short_path=15906a7#diff-15906a7fc80b5c1ff20d96ba3d8348452e1be358d5ba7e187c3d75776fb1b9f6

Fixes #32601

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@codecov
Copy link
Copy Markdown

codecov bot commented Aug 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.11%. Comparing base (2f93d8b) to head (3771f1f).
Report is 43 commits behind head on master.

Additional details and impacted files 
@@             Coverage Diff              @@
##             master   #32143      +/-   ##
============================================
- Coverage     59.11%   59.11%   -0.01%     
  Complexity     4499     4499              
============================================
  Files          1316     1316              
  Lines        180967   181233     +266     
  Branches       4361     4361              
============================================
+ Hits         106981   107134     +153     
- Misses        70289    70388      +99     
- Partials       3697     3711      +14
Flag Coverage Δ
go 34.68% <ø> (+0.07%) ⬆️

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.

@lostluck lostluck marked this pull request as ready for review September 26, 2024 16:55
@lostluck lostluck changed the title initial draft prism docs [prism] Initial Deep Dive Documentation Sep 26, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 26, 2024

Assigning reviewers. If you would like to opt out of this review, comment assign to next reviewer:

R: @jrmccluskey for label go.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

jrmccluskey
jrmccluskey reviewed Sep 26, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@jrmccluskey jrmccluskey left a comment

Choose a reason for hiding this comment

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

First pass of review edits

lostluck
lostluck commented Sep 26, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor Author

@lostluck lostluck left a comment

Choose a reason for hiding this comment

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

Thanks for the first pass!

@lostluck lostluck changed the title [prism] Initial Deep Dive Documentation [#32601][prism] Initial Deep Dive Documentation Sep 30, 2024
@lostluck
Copy link
Copy Markdown
Contributor Author

lostluck commented Oct 2, 2024

I'm definitely on the side of Good Enough vs Perfect when it comes to this documentation, and then subsequent changes can be more focused. May I have an estimate on when another pass will occur?

@jrmccluskey
Copy link
Copy Markdown
Contributor

jrmccluskey commented Oct 2, 2024

I will do a quick second pass first thing tomorrow morning, should be sufficient for an approval at that point

jrmccluskey
jrmccluskey approved these changes Oct 3, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@jrmccluskey jrmccluskey left a comment

Choose a reason for hiding this comment

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

LGTM mod the remaining typos

@lostluck @jrmccluskey
Apply suggestions from code review
d1957b2 
Co-authored-by: Jack McCluskey <34928439+jrmccluskey@users.noreply.github.com>
@github-actions github-actions bot added prism and removed prism labels Oct 3, 2024
@lostluck lostluck merged commit 001ac59 into apache:master Oct 3, 2024
reeba212 pushed a commit to reeba212/beam that referenced this pull request Dec 4, 2024
@lostluck @jrmccluskey @reeba212
[apache#32601][prism] Initial Deep Dive Documentation (apache#32143)
0fa7b99 
Co-authored-by: lostluck <13907733+lostluck@users.noreply.github.com>
Co-authored-by: Jack McCluskey <34928439+jrmccluskey@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jrmccluskey jrmccluskey jrmccluskey approved these changes

Assignees

No one assigned

Labels

go Next Action: Reviewers runners

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Deep Dive Documentation on how Prism Works

2 participants

@lostluck @jrmccluskey