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

[BEAM-9916] Update I/O documentation links and create more complete I/O matrix #11802

Merged
merged 6 commits into from
May 27, 2020

Conversation

epicfaace
Copy link
Contributor

@epicfaace epicfaace commented May 23, 2020

Update I/O documentation links to point to the appropriate pydoc / javadoc / godoc pages.

Also, create a more complete I/O matrix that has all the existing I/O's used in all three languages, with a tab to switch between languages, too. The matrix is now populated from the io_matrix.yaml file, as well.

R: @pabloem

The page now looks like this:

image

Additionally, I've also added links to the built-in I/O connector guides on the side bar, because previously they didn't exist:

image


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

  • Choose reviewer(s) and mention them in a comment (R: @username).
  • Format the pull request title like [BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replace BEAM-XXX with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
  • 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.

Post-Commit Tests Status (on master branch)

Lang SDK Apex Dataflow Flink Gearpump Samza Spark
Go Build Status --- --- Build Status --- --- Build Status
Java Build Status Build Status Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status Build Status Build Status
Build Status
Build Status
Python Build Status
Build Status
Build Status
Build Status
--- Build Status
Build Status
Build Status
Build Status
Build Status
--- --- Build Status
XLang --- --- --- Build Status --- --- Build Status

Pre-Commit Tests Status (on master branch)

--- Java Python Go Website
Non-portable Build Status Build Status
Build Status
Build Status Build Status
Portable --- Build Status --- ---

See .test-infra/jenkins/README for trigger phrase, status and link of all Jenkins jobs.

@aromanenko-dev aromanenko-dev self-requested a review May 26, 2020 14:33
@aromanenko-dev
Copy link
Contributor

retest this please

@pabloem
Copy link
Member

pabloem commented May 26, 2020

Thanks Ashwin, this looks really nice. I'll take a thorough look today, and hopefully merge or add comments.

@datancoffee
Copy link

Can we also add a section on "Applications" for application-specific connectors?


Add a section "Applications" after the "Database" section but before "Miscellaneous"

FhirIO provides an API for reading and writing resources to Google Cloud Healthcare Fhir API.

https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/FhirIO.java

HL7v2IO provides an API for reading from and writing to Google Cloud Healthcare HL7v2 API.

https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/healthcare/HL7v2IO.java

@pabloem
Copy link
Member

pabloem commented May 26, 2020

FhirIO and HL7v2IO are not yet part of a release (they will be in 2.22.0 and 2.21.0 respectively), so we can skip that update for now. @jaketf will add them once their corresponding releases are out.

@pabloem pabloem merged commit e1531b7 into apache:master May 27, 2020
@pabloem
Copy link
Member

pabloem commented May 27, 2020

I've merged your changes. They are really good. Thanks @epicfaace !
We need to follow up on

@epicfaace epicfaace deleted the bi branch May 27, 2020 00:17
@datancoffee
Copy link

FhirIO and HL7v2IO are not yet part of a release (they will be in 2.22.0 and 2.21.0 respectively), so we can skip that update for now. @jaketf will add them once their corresponding releases are out.

Sounds good. Thanks, Pablo!
New page looks much more readable than before (and can be extended with new sections)

@aromanenko-dev
Copy link
Contributor

@epicfaace Thanks for working on this, now this doc part looks much better!

@epicfaace epicfaace mentioned this pull request May 27, 2020
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants