[GitHub] incubator-flink pull request: Documentation completely transferred...

[zentol]

GitHub user skunert opened a pull request:

    https://github.com/apache/incubator-flink/pull/54

    Documentation completely transferred to markdown

    This commit contains the rest of the documentation transferred to markdown.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/skunert/incubator-flink documentation

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-flink/pull/54.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 #54
   
----
commit 7a4a72ecc84645a92b01187782c0ead5b7d44cde
Author: Sebastian Kunert <[hidden email]>
Date:   2014-06-24T13:42:07Z

    transformed java_api_quickstart, run_example_quickstart, setup_quickstart to markdown

commit f690e5e005e1058c3ca096e426db7d1f34f884e9
Author: Sebastian Kunert <[hidden email]>
Date:   2014-07-01T08:24:28Z

    Merge branch 'master' into documentation

commit 15a302529cb29798f1f54b76e75631914e485069
Author: Sebastian Kunert <[hidden email]>
Date:   2014-07-01T09:37:10Z

    updated rest of documentation and checked links

----


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user skunert commented on the pull request:

    https://github.com/apache/incubator-flink/pull/54#issuecomment-47656211
 
    I changed the gh_link script a bit to support custom naming of the link. The last argument is now always the name of the link. The downside is that if you want to name the link you have to also insert the branch.
   
    # Example
    {% gh_link README.md master This is the readme file %}
   
    Even though it is not that elegant that the last 5 arguments build the name string I think it is a necessary feature for the documentation. I also found some links that are still incorrect so this is not yet finished.


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user rmetzger commented on the pull request:

    https://github.com/apache/incubator-flink/pull/54#issuecomment-47744164
 
    Regarding the `gh_link` plugin: Can't we pass a null value or something if we don't want to specify the branch?


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user rmetzger commented on a diff in the pull request:

    https://github.com/apache/incubator-flink/pull/54#discussion_r14443468
 
    --- Diff: docs/iterations.md ---
    @@ -162,7 +164,7 @@ setFinalState(solution);
     In the following example, every vertex has an **ID** and a **coloring**. Each vertex will propagete its vertex ID to neighboring vertices. The **goal** is to *assign the minimum ID to every vertex in a subgraph*. If a received ID is smaller then the current one, it changes to the color of the vertex with the received ID. One application of this can be found in *community analysis* or *connected components* computation.
     
     <p class="text-center">
    -    <img alt="Delta Iterate Operator Example" width="100%" src="{{ site.baseurl }}/docs/0.4/img/iterations_delta_iterate_operator_example.png" />
    --- End diff --
   
    Did we remove the `site.baseurl` everywhere? I think its a quite useful feature.


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user rmetzger commented on a diff in the pull request:

    https://github.com/apache/incubator-flink/pull/54#discussion_r14443972
 
    --- Diff: docs/java_api_examples.md ---
    @@ -280,7 +280,7 @@ DataSet<Tuple3<Integer, Integer, Double>> priceSums =
     priceSums.writeAsCsv(outputPath);
     ```
     
    -The [Relational Query program](https://github.com/stratosphere/stratosphere/blob/release-{{site.current_stable}}/stratosphere-examples/stratosphere-java-examples/src/main/java/eu/stratosphere/example/java/relational/RelationalQuery.java) implements the above query. It requires the following parameters to run: `<orders input path>, <lineitem input path>, <output path>`.
    +The [Relational Query program](https://github.com/apache/incubator-flink/blob/ca2b287a7a78328ebf43766b9fdf39b56fb5fd4f/stratosphere-examples/stratosphere-java-examples/src/main/java/eu/stratosphere/example/java/relational/RelationalQuery.java) implements the above query. It requires the following parameters to run: `<orders input path>, <lineitem input path>, <output path>`.
    --- End diff --
   
    I think we should use the gh_link plugin here.


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user rmetzger commented on the pull request:

    https://github.com/apache/incubator-flink/pull/54#issuecomment-47746023
 
    Thanks alot for doing this. It is very important for our project to have a good, up-to-date documentation.
    I know that its sometimes annoying to do documentation, so I highly appreciate that you did the pull request!


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user skunert commented on the pull request:

    https://github.com/apache/incubator-flink/pull/54#issuecomment-47749283
 
    Thats what I meant with the last sentence of the PR. There are still a lot of links missing, I will fix this.


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user rmetzger commented on the pull request:

    https://github.com/apache/incubator-flink/pull/54#issuecomment-47749436
 
    Okay. Thank you!


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---

[zentol]

Github user uce commented on a diff in the pull request:

    https://github.com/apache/incubator-flink/pull/54#discussion_r14445968
 
    --- Diff: docs/iterations.md ---
    @@ -162,7 +164,7 @@ setFinalState(solution);
     In the following example, every vertex has an **ID** and a **coloring**. Each vertex will propagete its vertex ID to neighboring vertices. The **goal** is to *assign the minimum ID to every vertex in a subgraph*. If a received ID is smaller then the current one, it changes to the color of the vertex with the received ID. One application of this can be found in *community analysis* or *connected components* computation.
     
     <p class="text-center">
    -    <img alt="Delta Iterate Operator Example" width="100%" src="{{ site.baseurl }}/docs/0.4/img/iterations_delta_iterate_operator_example.png" />
    --- End diff --
   
    The idea was to remove it from the links to other doc pages. That's why we now have a flat hierarchy of MD files.


---
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 [hidden email] or file a JIRA ticket
with INFRA.
---