You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@apex.apache.org by sashadt <gi...@git.apache.org> on 2016/02/27 02:54:44 UTC

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

GitHub user sashadt opened a pull request:

    https://github.com/apache/incubator-apex-core/pull/245

    Apexcore 293.migrate docs.v2

    

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

    $ git pull https://github.com/sashadt/incubator-apex-core APEXCORE-293.migrateDocs.v2

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

    https://github.com/apache/incubator-apex-core/pull/245.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 #245
    
----
commit 3575c2fbdde5aa42ff2b9b33dc3072c16328da80
Author: sashadt <sa...@datatorrent.com>
Date:   2015-09-24T03:41:19Z

    Initial documentation

commit 4adfde599a61d4446d937c52ec55af7069904479
Author: sashadt <sa...@datatorrent.com>
Date:   2015-09-24T05:52:30Z

    Moving CNAME to docs

commit 66a9a008dd7f3c112f6f4ff45aa74513666bdb6f
Author: sashadt <sa...@datatorrent.com>
Date:   2015-09-25T08:31:49Z

    Combining login and demos section of the sandbox guide

commit 739e22464e6119bb4ac1464634c3e0cb409d2303
Author: sashadt <sa...@datatorrent.com>
Date:   2015-09-25T08:36:23Z

    Converting links to open in new tab

commit 95e748f7dca8c0e874af746534bd05c25391fdec
Author: sashadt <sa...@datatorrent.com>
Date:   2015-09-29T19:57:23Z

    Adding architecture, creating apps

commit b846f1cc5def7c89a64e317e959a4df4bbf1b037
Author: sashadt <sa...@datatorrent.com>
Date:   2015-09-29T19:57:43Z

    Renaming sales demo

commit 68433d729f83db59ddbc26d1512f4aaffd98a63f
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-01T03:07:29Z

    Updating main page, apex, malhar, rts overview, sandbox

commit b8a0f1bdfd405df7003a9ebfd3cbea14241a3950
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-02T23:39:26Z

    Updating front page links to be relative

commit 57bc68471c9f38ef7a33522fefac94c211f507ee
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-02T23:42:36Z

    Updating front page links to be relative

commit 025cc1ba5ebc8d4c96313eec68c191b70f8311a5
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-02T23:51:26Z

    Updating front page links to be relative

commit 72d07b2054bd2c69f104427d1545077c5f9249f4
Author: Andy Perlitch <an...@datatorrent.com>
Date:   2015-10-09T20:28:50Z

    updated dtmanage.md with rewrite

commit d6d626921f5cb80a80a8921f1acb6d36a2c92db5
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-13T23:21:48Z

    SPOI-6498 #resolve Updating documentation navigation

commit 2dd2d5dbb1924b0ba7438e1fd89190d69bca9af4
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-14T18:14:52Z

    Moving creating with dtAssemble to first create page

commit dde13a18ca57d2b97365850319ef42824e83d692
Author: Chandni Singh <cs...@apache.org>
Date:   2015-10-20T00:34:00Z

    SPOI-6471: documentation for FileSplitter

commit dfef81b5f1d8d642a67a0f958629e4568a13605d
Author: Chandni Singh <cs...@apache.org>
Date:   2015-10-23T19:14:24Z

    addressed review comments by ram

commit 616d0d933ff0be50b0d36cde05c93543162fc03d
Author: chinmaykolhatkar <ch...@datatorrent.com>
Date:   2015-10-09T15:30:56Z

    Adding dimension computation store tutorial. Ready for review.

commit b49995a45e185d3ec969b5f5bff002c2d8fbd5f3
Author: sandeshh <sa...@gmail.com>
Date:   2015-10-27T23:34:05Z

    Markdown for Apex Application package & Application configuration package

commit 3b85e7e37e0dc5415738aaa143c141c981334586
Author: Chandni Singh <cs...@apache.org>
Date:   2015-10-27T05:33:56Z

    SPOI-6472: Block reader tutorial

commit edee79e5d15847c06db4015a28d39bc6704a7f5e
Author: Chandni Singh <cs...@apache.org>
Date:   2015-10-27T22:21:16Z

    SPOI-6472 #comment addressing comments by Tim and Ram

commit 3497f0bacd047fc4c916d1527b6462f84fd17555
Author: Chandni Singh <cs...@apache.org>
Date:   2015-10-27T23:57:32Z

    changed folder from fs to io

commit f42bbc0b0a2bd5d02eb42cfdc810228fac2f40d0
Author: sandeshh <sa...@gmail.com>
Date:   2015-10-28T01:04:02Z

    Added the images to repo

commit 0bfefd6d442e7adc5ed7c3591e08593a2ea79fe3
Author: sandeshh <sa...@gmail.com>
Date:   2015-10-28T01:12:14Z

    removing unnecessary characters

commit 67b65a236b203aecd7c2dc8bbd6eaab06d517fbf
Author: yogidevendra <de...@datatorrent.com>
Date:   2015-10-28T10:36:40Z

    First release of dtingest tutorial
    
    1. Removed unused images.
    
    2. Added images used in the tutorial
    
    3. Replaced contents of markdown page for dtingest tutorial.
    
    4. Fixed image paths

commit d69f096b219d3f14b8aa8d3ba3ea91dfb68aca2e
Author: Sasha <sa...@datatorrent.com>
Date:   2015-10-28T16:41:18Z

    Merge pull request #6 from yogidevendra/DTIN-83-dtingest-tutorial
    
    First release of dtingest tutorial

commit 6eb1d0aa280cf52db736e4328f535c64bbf484c4
Author: Sasha <sa...@datatorrent.com>
Date:   2015-10-28T16:41:35Z

    Merge pull request #5 from sandeshh/master
    
    Application package & Application configuration package

commit ddc18d02d43d2f7e28619b4c2df513a3f4007114
Author: sashadt <sa...@datatorrent.com>
Date:   2015-10-28T16:59:05Z

    SPOI-6625 #resolve Updating documentation organization

commit d56b5ef49e2a18329fc9efe5c1d62b77699dde3b
Author: David Yan <da...@datatorrent.com>
Date:   2015-10-28T17:33:38Z

    Touched up markdown version of App Package doc

commit bd9d39657883ffa3f692815a30c533f4fba05279
Author: David Yan <da...@datatorrent.com>
Date:   2015-10-28T17:34:19Z

    Merge branch 'master' of github.com:davidyan74/docs

commit 802e6b8ec80078a8d09b5bc87fb19cf411c36b5c
Author: sandeshh <sa...@gmail.com>
Date:   2015-10-28T19:00:30Z

    Added the space before "H2" header construct "##" and the title.

commit 01d687d1a8be6254311cd3faf01e127762480e6c
Author: sandeshh <sa...@gmail.com>
Date:   2015-10-28T19:07:46Z

    Update ApexPackage.md

----


---
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.
---

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

Posted by sashadt <gi...@git.apache.org>.
Github user sashadt commented on the pull request:

    https://github.com/apache/incubator-apex-core/pull/245#issuecomment-190467563
  
    Deployment is a separate issue which needs to be addressed.  The idea for now is that each version gets copied to a separate directory, and the main project website has links to each sub-directory for specific version.


---
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.
---

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

Posted by sashadt <gi...@git.apache.org>.
Github user sashadt commented on the pull request:

    https://github.com/apache/incubator-apex-core/pull/245#issuecomment-189556617
  
    ![image](https://cloud.githubusercontent.com/assets/4966983/13370103/c64fc52a-dcb3-11e5-906a-8d69bcb0f2a2.png)



---
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.
---

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

Posted by tweise <gi...@git.apache.org>.
Github user tweise commented on the pull request:

    https://github.com/apache/incubator-apex-core/pull/245#issuecomment-190071158
  
    Sasha, I have cleaned up this import and moved it to the following branch:
    
    https://github.com/tweise/incubator-apex-core/tree/APEXCORE-293
    
    Please double check. Also, if you find something in the remaining history that can/should be purged let me know.
    
    I need to work on fixing the build failure next.


---
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.
---

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

Posted by tweise <gi...@git.apache.org>.
Github user tweise commented on the pull request:

    https://github.com/apache/incubator-apex-core/pull/245#issuecomment-190072705
  
    How will the deployment work with multiple versions?


---
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.
---

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

Posted by sashadt <gi...@git.apache.org>.
Github user sashadt closed the pull request at:

    https://github.com/apache/incubator-apex-core/pull/245


---
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.
---

[GitHub] incubator-apex-core pull request: Apexcore 293.migrate docs.v2

Posted by tweise <gi...@git.apache.org>.
Github user tweise commented on a diff in the pull request:

    https://github.com/apache/incubator-apex-core/pull/245#discussion_r54453968
  
    --- Diff: docs/application_packages.md ---
    @@ -0,0 +1,667 @@
    +Apache Apex Application Packages
    +================================
    +
    +An Apache Apex Application Package is a zip file that contains all the
    +necessary files to launch an application in Apache Apex. It is the
    +standard way for assembling and sharing an Apache Apex application.
    +
    +# Requirements
    +
    +You will need have the following installed:
    +
    +1. Apache Maven 3.0 or later (for assembling the App Package)
    +2. Apache Apex 3.0.0 or later (for launching the App Package in your cluster)
    +
    +# Creating Your First Apex App Package
    +
    +You can create an Apex Application Package using your Linux command
    +line, or using your favorite IDE.
    +
    +## Using Command Line
    +
    +First, change to the directory where you put your projects, and create
    +an Apex application project using Maven by running the following
    +command.  Replace "com.example", "mydtapp" and "1.0-SNAPSHOT" with the
    +appropriate values (make sure this is all on one line):
    +
    +    $ mvn archetype:generate \
    +     -DarchetypeGroupId=org.apache.apex \
    +     -DarchetypeArtifactId=apex-app-archetype -DarchetypeVersion=3.2.0-incubating \
    +     -DgroupId=com.example -Dpackage=com.example.mydtapp -DartifactId=mydtapp \
    +     -Dversion=1.0-SNAPSHOT
    +
    +This creates a Maven project named "mydtapp". Open it with your favorite
    +IDE (e.g. NetBeans, Eclipse, IntelliJ IDEA). In the project, there is a
    +sample DAG that generates a number of tuples with a random number and
    +prints out "hello world" and the random number in the tuples.  The code
    +that builds the DAG is in
    +src/main/java/com/example/mydtapp/Application.java, and the code that
    +runs the unit test for the DAG is in
    +src/test/java/com/example/mydtapp/ApplicationTest.java. Try it out by
    +running the following command:
    +
    +    $cd mydtapp; mvn package
    +
    +This builds the App Package runs the unit test of the DAG.  You should
    +be getting test output similar to this:
    +
    +```
    + -------------------------------------------------------
    +  TESTS
    + -------------------------------------------------------
    +
    + Running com.example.mydtapp.ApplicationTest
    + hello world: 0.8015370953286478
    + hello world: 0.9785359225545481
    + hello world: 0.6322611586644047
    + hello world: 0.8460953663451775
    + hello world: 0.5719372906929072
    + hello world: 0.6361174312337172
    + hello world: 0.14873007534816318
    + hello world: 0.8866986277418261
    + hello world: 0.6346526809866057
    + hello world: 0.48587295703904465
    + hello world: 0.6436832429676687
    +
    + ...
    +
    + Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 11.863
    + sec
    +
    + Results :
    +
    + Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
    +```
    +
    +The "mvn package" command creates the App Package file in target
    +directory as target/mydtapp-1.0-SNAPSHOT.apa. You will be able to use
    +that App Package file to launch this sample application in your actual
    +Apex installation.
    +
    +## Using IDE
    +
    +Alternatively, you can do the above steps all within your IDE.  For
    +example, in NetBeans, select File -\> New Project.  Then choose “Maven”
    +and “Project from Archetype” in the dialog box, as shown.
    +
    +![](images/AppPackage/ApplicationPackages.html-image00.png)
    --- End diff --
    
    @davidyan74 can we update the screen shot to reflect the changed groupId?



---
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.
---