GitHub user ssisk opened a pull request:
https://github.com/apache/beam-site/pull/173
[BEAM-1665] Add Pipeline I/O section to website - outline + move some
existing txt
This PR has a fair number of TODOs in the website content, but I have PRs
queued up with more content from the IO authoring guide and none of the TODOs
are for content already on the website.
It has very little actual new content - mostly, it created structure and
moves existing content around.
* I did not to go with a single page for all this content b/c both java and
python have enough unique content that they deserve their own separate sections
(ie, just tabs on the code isn't enough), and the "click to the next page"
model currently implemented allows the user to pick java vs python, but then
after reading those pages, the next page for both points at the same place -
the users mostly follow the same path, but for java vs python specific content,
they will diverge then converge again.
* I moved the "list of built-in I/O" content over to it's own separate page
since it'd be nice to have more content there - e.g. capabilities matrix, and
it felt special enough to pull out of the programming guide.
* We decided not to put all of this content in the contribute section of
the site since the expectation is we don't think all users will contribute
their IO transforms, so we want most of the docs to just be about writing an IO
transforms, and they lay out the expectations in the contribute part of the IO
section.
R @melap
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ssisk/beam-site io-guide
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam-site/pull/173.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #173
----
commit b0e0862042dd189dfcf8d1994d482fca99853a3b
Author: Stephen Sisk <[email protected]>
Date: 2017-03-09T01:49:37Z
Add Pipeline I/O section to website - outline + move some existing content
* I did not to go with a single page for all this content b/c both java and
python have enough unique content that they deserve their own separate sections
(ie, just tabs on the code isn't enough), and the "click to the next page"
model currently implemented allows the user to pick java vs python, but then
after reading those pages, the next page for both points at the same place -
the users mostly follow the same path, but for java vs python specific content,
they will diverge then converge again.
* I moved the "list of built-in I/O" content over to it's own separate page
since it'd be nice to have more content there - e.g. capabilities matrix, and
it felt special enough to pull out of the programming guide.
* We decided not to put all of this content in the contribute section of
the site since the expectation is we don't think all users will contribute
their IO transforms, so we want most of the docs to just be about writing an IO
transforms, and they lay out the expectations in the contribute part of the IO
section.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
