apex-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tweise <...@git.apache.org>
Subject [GitHub] incubator-apex-site pull request: Reorganize docs
Date Fri, 25 Mar 2016 23:52:01 GMT
Github user tweise commented on a diff in the pull request:

    https://github.com/apache/incubator-apex-site/pull/28#discussion_r57503409
  
    --- Diff: src/md/docs.md ---
    @@ -1,50 +1,65 @@
     # Documentation
     
    -### Apex Core
    +Primary documentation for Apache Apex including overviews of the product, security,
    +application development, operators and the commandline tool is
    +[here](/docs/apex/). Documentation for the Apache Apex Malhar operator library
    +including a diagrammatic taxonomy and some in-depth tutorials for selected operators
    +(such as Kafka Input) is [here](/docs/malhar/).
     
    -Latest documentation is available in [Apex Core Docs](/docs/apex/) and <a href="https://www.datatorrent.com/docs/apidocs/"
rel="nofollow">Apex JavaDoc</a>.
    +The Java API for both the platform and the operator library is
    +<a href="https://www.datatorrent.com/docs/apidocs/" rel="nofollow">here</a>.
     
    -### Apex Malhar
    +The following sections provide links to additional informative material such as
    +presentations, videos and blogs.
     
    -Latest documentation is available in [Apex Malhar Docs](/docs/malhar/).
    -
    -
    -### Writing Apex Applications
    +### Writing Apache Apex Applications
     
     - [Building Your First Apache Apex Application (video)](https://youtu.be/LwRWBudOjg4)
    +This video has a hands-on demonstration of how to check out the source code
    +repositories and build them, then run the maven archetype command
    +to generate a new Apache Apex project, populate the project with Java source files
    +for a new application, and finally, build and run the application -- all on a
    +virtual machine running Linux with Apache Hadoop installed. 
    +
     - [Top N Words Application Tutorial](http://docs.datatorrent.com/tutorials/topnwords/)
    +This document provides a detailed step-by-step description of how to build and
    +run a word counting application with Apache Apex starting with setting up your
    +development, progressing to building, running and monitoring the application,
    +visualizing the output and concluding with some advanced features such as
    +assessing operator memory requiremnets, partitioning, and debugging.
    +
     - [Sales Dimensions Application Tutorial](http://docs.datatorrent.com/tutorials/salesdimensions/)
    +Similar to the Top N Words application but covers dimensional computations on a
    +simulated sales data stream.
    +
     - [Example Applications](https://github.com/DataTorrent/examples)
    +A `git` repository with sample code for specialized tutorials covering a
    +a variety of topcs such as a high-performance key-value store (HDHT), custom
    --- End diff --
    
    topics (typo)


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message