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

Addition of readme + Blog fixes #4

Closed
wants to merge 9 commits into from
Closed

Addition of readme + Blog fixes #4

wants to merge 9 commits into from

Conversation

chimerasaurus
Copy link

This PR has three changes:

  • Addition of basic README file
  • Addition of <!--more--> tag to create summary for new blog post
  • Addition of "Read more" buttons for blog posts

I tried pagination for the blog; does not work well (so buttons were used instead to keep the blog page from growing huge over time.)


$ jekyll build

One built, all of the static content will be placed in the folder `_site` inside
Copy link

Choose a reason for hiding this comment

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

I believe it's "content" now, not "_site".

Copy link
Author

Choose a reason for hiding this comment

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

@takidau My dumb - I missed that change from Max. Fixed in README which is now part of the PR.

Fix for output path in readme
The Apache Beam website uses `svnpubsub`. The `_site` folder contains the
website's content. When the content in `_site` is committed to the svn
repository, the Apache Beam website will automatically be updated.
One built, all of the static content will be placed in the folder `content` inside
Copy link

Choose a reason for hiding this comment

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

s/One/Once.

Copy link
Author

Choose a reason for hiding this comment

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

Fixed.

Typo fix.
@takidau
Copy link

takidau commented Mar 18, 2016

+1

@chimerasaurus
Copy link
Author

Just rebuilt static content; turns out jekyll serve will only do it for you sometimes.

@@ -93,784 +93,13 @@ <h3 id="a-classpost-link-hrefbeamcapability20160317capability-matrixhtmlclarifyi

<p>With initial code drops complete (<a href="https://github.com/apache/incubator-beam/pull/1">Dataflow SDK and Runner</a>, <a href="https://github.com/apache/incubator-beam/pull/12">Flink Runner</a>, <a href="https://github.com/apache/incubator-beam/pull/42">Spark Runner</a>) and expressed interest in runner implementations for <a href="https://issues.apache.org/jira/browse/BEAM-9">Storm</a>, <a href="https://issues.apache.org/jira/browse/BEAM-19">Hadoop</a>, and <a href="https://issues.apache.org/jira/browse/BEAM-79">Gearpump</a> (amongst others), we wanted to start addressing a big question in the Apache Beam (incubating) community: what capabilities will each runner be able to support?</p>

<p>While we’d love to have a world where all runners support the full suite of semantics included in the Beam Model (formerly referred to as the <a href="https://www.vldb.org/pvldb/vol8/p1792-Akidau.pdf">Dataflow Model</a>), practically speaking, there will always be certain features that some runners can’t provide. For example, a Hadoop-based runner would be inherently batch-based and may be unable to (easily) implement support for unbounded collections. However, that doesn’t prevent it from being extremely useful for a large set of uses. In other cases, the implementations provided by one runner may have slightly different semantics that those provided by another (e.g. even though the current suite of runners all support exactly-once delivery guarantees, an <a href="https://samza.apache.org/">Apache Samza</a> runner, which would be a welcome addition, would currently only support at-least-once).</p>
Copy link
Member

Choose a reason for hiding this comment

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

I'm probably missing something obvious, but not sure why this section is going away. Is this duplicated elsewhere?

Copy link
Author

Choose a reason for hiding this comment

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

GitHub lies! ;)

The new blog page uses a "summary" section for posts (delimited by a "" tag) to keep the blog index from becoming huge. To make things easy, new new static page also includes "Read more" buttons after the summary so people can click on them and enjoy the full post goodness.

This is a balance between having a super long blog page and weird pagination, which doesn't work with Jekyll + Markdown, sadly.

@davorbonaci
Copy link
Member

Nice text!

I love that the instructions will be prominently displayed, and that people won't need to lookup documents elsewhere, etc.

Generally, I'd prefer separate PRs for unrelated things; leave as is for now.

s/dealing with//g
@chimerasaurus
Copy link
Author

@davorbonaci I agree about seperate PRs. Sorry - this one ended up being a minor Blog fix which snowballed a little into a readme and also trying to figure out how the new publish scheme works (so I can also document it.) :)

Fix to "Generating the static website" section.
Change to "About this site"
Fix for "About this site"
@asfgit asfgit closed this in d5dfeb6 Mar 21, 2016
robertwb pushed a commit to robertwb/incubator-beam that referenced this pull request Jun 5, 2018
melap pushed a commit to apache/beam that referenced this pull request Jun 20, 2018
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.

3 participants