You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@heron.apache.org by GitBox <gi...@apache.org> on 2020/10/30 03:44:38 UTC
[GitHub] [incubator-heron] joshfischer1108 opened a new pull request #3626: clean up site docs
joshfischer1108 opened a new pull request #3626:
URL: https://github.com/apache/incubator-heron/pull/3626
Starting to add some website clean up on the documentation.. Mainly removing dead links. More to come.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-heron] Code0x58 commented on a change in pull request #3626: clean up site docs
Posted by GitBox <gi...@apache.org>.
Code0x58 commented on a change in pull request #3626:
URL: https://github.com/apache/incubator-heron/pull/3626#discussion_r514988252
##########
File path: website2/docs/topology-development-streamlet-api.md
##########
@@ -113,34 +113,26 @@ $ heron submit local \
### Java Streamlet API starter project
-If you'd like to up and running quickly with the Heron Streamlet API for Java, you can clone [this repository](https://github.com/streamlio/heron-java-streamlet-api-example), which includes an example topology built using the Streamlet API as well as the necessary Maven configuration. To build a JAR with dependencies of this example topology:
-
-```bash
-$ git clone https://github.com/streamlio/heron-java-streamlet-api-example
-$ cd heron-java-streamlet-api-example
-$ mvn assembly:assembly
-$ ls target/*.jar
-target/heron-java-streamlet-api-example-latest-jar-with-dependencies.jar
-target/heron-java-streamlet-api-example-latest.jar
-```
+If you'd like to up and running quickly with the Heron Streamlet API for Java, you can view the example topologies [here](https://github.com/apache/incubator-heron/tree/master/examples/src/java/org/apache/heron/examples/streamlet)
Review comment:
```suggestion
If you'd like to up and running quickly with the Heron Streamlet API for Java, you can view the example topologies [here](https://github.com/apache/incubator-heron/tree/master/examples/src/java/org/apache/heron/examples/streamlet)
```
##########
File path: website2/docs/guides-python-topologies.md
##########
@@ -181,8 +181,7 @@ $ heron submit local \
Note the `-` in this submission command. If you define a topology by subclassing `TopologyBuilder` you do not need to instruct Heron where your main method is located.
> #### Example topologies buildable as PEXs
-> * See [this repo](https://github.com/streamlio/pants-dev-environment) for an example of a Heron topology written in Python and deployable as a Pants-packaged PEX.
-> * See [this repo](https://github.com/streamlio/bazel-dev-environment) for an example of a Heron topology written in Python and deployable as a Bazel-packaged PEX.
+> TODO
Review comment:
@windhamwong. do you have any ideas/thoughts on this area?
##########
File path: website2/docs/topology-development-topology-api-python.md
##########
@@ -181,8 +181,7 @@ $ heron submit local \
Note the `-` in this submission command. If you define a topology by subclassing `TopologyBuilder` you do not need to instruct Heron where your main method is located.
> #### Example topologies buildable as PEXs
Review comment:
this and `website2/docs/topology-development-streamlet-api.md` don't look DRY, they appear to have identical content given this small diff context
##########
File path: website2/docs/topology-development-topology-api-python.md
##########
@@ -687,8 +686,7 @@ $ heron submit local \
Note the `-` in this submission command. If you define a topology by subclassing `TopologyBuilder` you do not need to instruct Heron where your main method is located.
> #### Example topologies buildable as PEXs
-> * See [this repo](https://github.com/streamlio/pants-dev-environment) for an example of a Heron topology written in Python and deployable as a Pants-packaged PEX.
Review comment:
this even appears to be a duplicate within the same file (given the diff is the same as the hunk above)
##########
File path: website2/website/versioned_docs/version-0.20.0-incubating/guides-python-topologies.md
##########
@@ -182,8 +182,7 @@ $ heron submit local \
Note the `-` in this submission command. If you define a topology by subclassing `TopologyBuilder` you do not need to instruct Heron where your main method is located.
> #### Example topologies buildable as PEXs
-> * See [this repo](https://github.com/streamlio/pants-dev-environment) for an example of a Heron topology written in Python and deployable as a Pants-packaged PEX.
Review comment:
is there a `website2/versioned_docs/*/topology-development-topology-api-python.md` to also apply changes to?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org