You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@samza.apache.org by Jake Maes <ja...@gmail.com> on 2016/07/18 19:11:12 UTC

Review Request 50154: SAMZA-976 Samza REST Documentation

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs
-----

  docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On July 27, 2016, 12:52 a.m., Navina Ramesh wrote:
> > bin/generate-javadocs.sh, line 22
> > <https://reviews.apache.org/r/50154/diff/2/?file=1454452#file1454452line22>
> >
> >     Ok. You are almost there :) 
> >     
> >     This will overwrite the index files that you copied over for samza-api javadocs :) 
> >     
> >     I think you can create another directory under versioned called "rest-api" and copy the docs there. So, it will look like :
> >     REST_JAVADOC_DIR=$BASE_DIR/docs/learn/documentation/versioned/rest-api/javadocs
> >     
> >     This also means you have to update the url references
> 
> Jake Maes wrote:
>     Oops, that's right! Fixing it now...

Fixed the javadocs and the missing JobsResource.png in the latest diff.


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143649
-----------------------------------------------------------


On July 27, 2016, 6:12 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 6:12 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On July 27, 2016, 12:52 a.m., Navina Ramesh wrote:
> > bin/generate-javadocs.sh, line 22
> > <https://reviews.apache.org/r/50154/diff/2/?file=1454452#file1454452line22>
> >
> >     Ok. You are almost there :) 
> >     
> >     This will overwrite the index files that you copied over for samza-api javadocs :) 
> >     
> >     I think you can create another directory under versioned called "rest-api" and copy the docs there. So, it will look like :
> >     REST_JAVADOC_DIR=$BASE_DIR/docs/learn/documentation/versioned/rest-api/javadocs
> >     
> >     This also means you have to update the url references

Oops, that's right! Fixing it now...


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143649
-----------------------------------------------------------


On July 27, 2016, 12:28 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 12:28 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143649
-----------------------------------------------------------




bin/generate-javadocs.sh (line 22)
<https://reviews.apache.org/r/50154/#comment209489>

    Ok. You are almost there :) 
    
    This will overwrite the index files that you copied over for samza-api javadocs :) 
    
    I think you can create another directory under versioned called "rest-api" and copy the docs there. So, it will look like :
    REST_JAVADOC_DIR=$BASE_DIR/docs/learn/documentation/versioned/rest-api/javadocs
    
    This also means you have to update the url references


- Navina Ramesh


On July 27, 2016, 12:28 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 12:28 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On July 27, 2016, 9:37 p.m., Navina Ramesh wrote:
> > docs/learn/documentation/versioned/rest/overview.md, line 104
> > <https://reviews.apache.org/r/50154/diff/4/?file=1455494#file1455494line104>
> >
> >     Is there is no default log4j in the generate tar ball, it will good to move this "fyi" info above near the deployment steps.

Can you double check? I see the log4j file in the extracted dir:
```
samza[master] > cd samza-rest/build/distributions/deploy/samza-rest/bin/
bin[master] > ls
total 32
drwxr-xr-x  5 jmaes  170B Jul 27 13:38 ./
drwxr-xr-x  9 jmaes  306B Jul 27 13:39 ../
-rw-r--r--  1 jmaes  1.4K Jun 15 11:26 log4j.xml
-rwxr-xr-x  1 jmaes  4.8K Apr 14 14:23 run-class.sh*
-rwxr-xr-x  1 jmaes  1.0K Jul 11 11:49 run-samza-rest-service.sh*
```


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143826
-----------------------------------------------------------


On July 27, 2016, 8:47 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 8:47 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143826
-----------------------------------------------------------




docs/learn/documentation/versioned/rest/overview.md (line 104)
<https://reviews.apache.org/r/50154/#comment209758>

    Is there is no default log4j in the generate tar ball, it will good to move this "fyi" info above near the deployment steps.


- Navina Ramesh


On July 27, 2016, 8:47 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 8:47 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review145823
-----------------------------------------------------------




docs/learn/documentation/versioned/rest/monitors.md (line 23)
<https://reviews.apache.org/r/50154/#comment212180>

    Is it possible to list another potential use-case here? It will be nice to have a use-case for Monitors, outside the "yarn" world, even though we currently have only one implementation.


- Navina Ramesh


On July 29, 2016, 6:58 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 29, 2016, 6:58 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review145962
-----------------------------------------------------------


Ship it!




Ship It!

- Navina Ramesh


On Aug. 17, 2016, 1:58 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated Aug. 17, 2016, 1:58 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated Aug. 17, 2016, 1:58 a.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
  docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
  docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated Aug. 17, 2016, 1:45 a.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
  docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
  docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 88
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line88>
> >
> >     I am running in to an issue of not finding config files in the path specified. I don't get any response on curl. 
> >     From the log file:
> >     
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:23.418 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:44.030 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:37:12.480 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:37:12.482 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     
> >     
> >     Looks like it is appening "config" to any path it tries to access. I have to look into your implementation code for why this is happening. Can you please check?
> 
> Jake Maes wrote:
>     It's not really an "issue". It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 
>     
>     That said, I can see that it is clunky to always warn, so I'll change it to a DEBUG message in the other review.
> 
> Navina Ramesh wrote:
>     It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 
>     > Ok. let me try to understand this. This code is recursively searching the installation path for a config file. Is that what is happening here and is that why there were so many log lines? 
>     Anyway, my point with this comments was that I was not getting the expected output from the curl command. With your latest patch, looks like it got fixed. Thanks!
> 
> Jake Maes wrote:
>     Also turns out there was an issue with the instructions. The config should point to the deploy/ directory, not deploy/samza. I fixed that too. Thanks!

Right, I missed that comment initially and focused on the log message. 

The issue was with the instructions setting the wrong path in the properties file. Thanks for finding it!


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review144296
-----------------------------------------------------------


On Aug. 17, 2016, 1:58 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated Aug. 17, 2016, 1:58 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 88
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line88>
> >
> >     I am running in to an issue of not finding config files in the path specified. I don't get any response on curl. 
> >     From the log file:
> >     
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:23.418 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:44.030 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:37:12.480 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:37:12.482 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     
> >     
> >     Looks like it is appening "config" to any path it tries to access. I have to look into your implementation code for why this is happening. Can you please check?
> 
> Jake Maes wrote:
>     It's not really an "issue". It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 
>     
>     That said, I can see that it is clunky to always warn, so I'll change it to a DEBUG message in the other review.
> 
> Navina Ramesh wrote:
>     It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 
>     > Ok. let me try to understand this. This code is recursively searching the installation path for a config file. Is that what is happening here and is that why there were so many log lines? 
>     Anyway, my point with this comments was that I was not getting the expected output from the curl command. With your latest patch, looks like it got fixed. Thanks!

Also turns out there was an issue with the instructions. The config should point to the deploy/ directory, not deploy/samza. I fixed that too. Thanks!


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review144296
-----------------------------------------------------------


On Aug. 17, 2016, 1:58 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated Aug. 17, 2016, 1:58 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> >

Reminder: This review is for the doc, not the code. So any code feedback will not be reflected in this review. Instead see https://reviews.apache.org/r/50151/


> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 73
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line73>
> >
> >     Should change run-samza-rest-service.sh to be executable (chmod 755)

I think it is. I just applied the patch from JIRA to a fresh copy of samza on both my mac and linux machines an had no problems running through the tutorial.

Also:
```
samza-rest[master] > ls -la bin/run-samza-rest-service.sh 
-rwxr-xr-x  1  1.0K Aug 16 12:43 bin/run-samza-rest-service.sh*
```
and
```
samza-rest[master] > ls ../../../../src/main/bash/run-samza-rest-service.sh 
-rwxr-xr-x  1  1.0K Aug 16 12:43 ../../../../src/main/bash/run-samza-rest-service.sh*
```


> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 88
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line88>
> >
> >     I am running in to an issue of not finding config files in the path specified. I don't get any response on curl. 
> >     From the log file:
> >     
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:23.418 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:44.030 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:37:12.480 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:37:12.482 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     
> >     
> >     Looks like it is appening "config" to any path it tries to access. I have to look into your implementation code for why this is happening. Can you please check?

It's not really an "issue". It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 

That said, I can see that it is clunky to always warn, so I'll change it to a DEBUG message in the other review.


> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > bin/generate-javadocs.sh, line 21
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458025#file1458025line21>
> >
> >     We need to add this path to .gitignore.
> >     We should add this path to build.gradle excludes so that build will stop complaining about missing license headers on geenrated files.

Done, thanks


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review144296
-----------------------------------------------------------


On Aug. 17, 2016, 1:45 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated Aug. 17, 2016, 1:45 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 73
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line73>
> >
> >     Should change run-samza-rest-service.sh to be executable (chmod 755)
> 
> Jake Maes wrote:
>     I think it is. I just applied the patch from JIRA to a fresh copy of samza on both my mac and linux machines an had no problems running through the tutorial.
>     
>     Also:
>     ```
>     samza-rest[master] > ls -la bin/run-samza-rest-service.sh 
>     -rwxr-xr-x  1  1.0K Aug 16 12:43 bin/run-samza-rest-service.sh*
>     ```
>     and
>     ```
>     samza-rest[master] > ls ../../../../src/main/bash/run-samza-rest-service.sh 
>     -rwxr-xr-x  1  1.0K Aug 16 12:43 ../../../../src/main/bash/run-samza-rest-service.sh*
>     ```
> 
> Navina Ramesh wrote:
>     Weird.. even with your new patch it still complained about permissions. Never mind. I will verify it and fix it, if required before pushing it. Thanks!

Hmm, maybe its a difference between ```git apply``` and ```patch``` commands. Thanks for making sure it works. And remember to also include the PNG file attached to the JIRA. The path is specified in the JIRA comments.


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review144296
-----------------------------------------------------------


On Aug. 17, 2016, 1:58 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated Aug. 17, 2016, 1:58 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.

> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 73
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line73>
> >
> >     Should change run-samza-rest-service.sh to be executable (chmod 755)
> 
> Jake Maes wrote:
>     I think it is. I just applied the patch from JIRA to a fresh copy of samza on both my mac and linux machines an had no problems running through the tutorial.
>     
>     Also:
>     ```
>     samza-rest[master] > ls -la bin/run-samza-rest-service.sh 
>     -rwxr-xr-x  1  1.0K Aug 16 12:43 bin/run-samza-rest-service.sh*
>     ```
>     and
>     ```
>     samza-rest[master] > ls ../../../../src/main/bash/run-samza-rest-service.sh 
>     -rwxr-xr-x  1  1.0K Aug 16 12:43 ../../../../src/main/bash/run-samza-rest-service.sh*
>     ```

Weird.. even with your new patch it still complained about permissions. Never mind. I will verify it and fix it, if required before pushing it. Thanks!


> On Aug. 16, 2016, 12:50 a.m., Navina Ramesh wrote:
> > docs/learn/tutorials/versioned/samza-rest-getting-started.md, line 88
> > <https://reviews.apache.org/r/50154/diff/6/?file=1458034#file1458034line88>
> >
> >     I am running in to an issue of not finding config files in the path specified. I don't get any response on curl. 
> >     From the log file:
> >     
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:23.418 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:36:44.030 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     2016-08-15 17:37:12.480 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
> >     2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
> >     2016-08-15 17:37:12.482 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
> >     
> >     
> >     Looks like it is appening "config" to any path it tries to access. I have to look into your implementation code for why this is happening. Can you please check?
> 
> Jake Maes wrote:
>     It's not really an "issue". It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 
>     
>     That said, I can see that it is clunky to always warn, so I'll change it to a DEBUG message in the other review.

It works fine, but the SimpleInstallationFinder wasn't written with ONLY hello-samza in mind and this log message is intended to help users determine why the JobsResource isn't finding their jobs. 
> Ok. let me try to understand this. This code is recursively searching the installation path for a config file. Is that what is happening here and is that why there were so many log lines? 
Anyway, my point with this comments was that I was not getting the expected output from the curl command. With your latest patch, looks like it got fixed. Thanks!


- Navina


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review144296
-----------------------------------------------------------


On Aug. 17, 2016, 1:58 a.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated Aug. 17, 2016, 1:58 a.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   .gitignore 3e974168cc4f982151758b6727c69f17b9013f8c 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/learn/documentation/versioned/index.html 84e15a25bc8f1bb2996150bde24b81ff05dae224 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review144296
-----------------------------------------------------------




bin/generate-javadocs.sh (line 21)
<https://reviews.apache.org/r/50154/#comment212142>

    We need to add this path to .gitignore.
    We should add this path to build.gradle excludes so that build will stop complaining about missing license headers on geenrated files.



docs/learn/tutorials/versioned/samza-rest-getting-started.md (line 22)
<https://reviews.apache.org/r/50154/#comment210303>

    nit: "executed a couple of basic curl ..."



docs/learn/tutorials/versioned/samza-rest-getting-started.md (line 73)
<https://reviews.apache.org/r/50154/#comment212172>

    Should change run-samza-rest-service.sh to be executable (chmod 755)



docs/learn/tutorials/versioned/samza-rest-getting-started.md (line 88)
<https://reviews.apache.org/r/50154/#comment212177>

    I am running in to an issue of not finding config files in the path specified. I don't get any response on curl. 
    From the log file:
    
    2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
    2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
    2016-08-15 17:36:23.417 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
    2016-08-15 17:36:23.418 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
    2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
    2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
    2016-08-15 17:36:44.029 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
    2016-08-15 17:36:44.030 [qtp1276504061-19] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
    2016-08-15 17:37:12.480 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/lib/config
    2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/bin/config
    2016-08-15 17:37:12.481 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/tmp/config
    2016-08-15 17:37:12.482 [qtp1276504061-18] SimpleInstallationFinder [WARN] Config path not found: /home/nramesh/Projects/samza-hello-samza/deploy/samza/config/config
    
    Looks like it is appening "config" to any path it tries to access. I have to look into your implementation code for why this is happening. Can you please check?


- Navina Ramesh


On July 29, 2016, 6:58 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 29, 2016, 6:58 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On Aug. 16, 2016, 12:55 a.m., Navina Ramesh wrote:
> > One last comment: Can you attach the .png file to the JIRA? Otherwise, the local deployment has a broken link.

done


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review145822
-----------------------------------------------------------


On July 29, 2016, 6:58 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 29, 2016, 6:58 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review145822
-----------------------------------------------------------



One last comment: Can you attach the .png file to the JIRA? Otherwise, the local deployment has a broken link.

- Navina Ramesh


On July 29, 2016, 6:58 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 29, 2016, 6:58 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated July 29, 2016, 6:58 p.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
  docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
  docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
  docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated July 29, 2016, 6:53 p.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
  docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
  docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
  docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On July 27, 2016, 9:36 p.m., Navina Ramesh wrote:
> > I think it will be simpler if we can just provide architectural overview in the website and add a separate tutorial to run it with samza-hello-samza. Thanks!
> 
> Jake Maes wrote:
>     So, do you suggest moving the deployment steps to the tutorial or duplicating them? 
>     
>     It seems to me deployment is the primary hurdle to get up and running with Samza REST so I wanted it to be front and center in the docs.

I think I found the right balance. See the latest diff for the split overview and tutorial. There is some repetition, but I think it flows well. Thanks for the suggestion. I like it better this way.


> On July 27, 2016, 9:36 p.m., Navina Ramesh wrote:
> > docs/learn/documentation/versioned/rest/overview.md, line 102
> > <https://reviews.apache.org/r/50154/diff/3/?file=1455463#file1455463line102>
> >
> >     Since this document serves as both overview and tutorial, can you please add more documentation on how to run the service? Perhaps some curl commands and sample output will be useful. 
> >     
> >     I was able to install samza-rest on my box. But I don't know what I should be doing beyond that.
> 
> Jake Maes wrote:
>     That's good feedback. The reason that wasn't included is because it depends on what Resources you expose. The JobsResource ships with Samza REST but can be excluded. I can refer them to the JobsResource page if they're just getting started and want to try it out.

Fixed with the new tutorial. Thanks!


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143777
-----------------------------------------------------------


On July 29, 2016, 6:53 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 29, 2016, 6:53 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
>   docs/learn/tutorials/versioned/index.md b4d687a63638aca4f876af88556de9973acfd718 
>   docs/learn/tutorials/versioned/samza-rest-getting-started.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.

> On July 27, 2016, 9:36 p.m., Navina Ramesh wrote:
> > I think it will be simpler if we can just provide architectural overview in the website and add a separate tutorial to run it with samza-hello-samza. Thanks!

So, do you suggest moving the deployment steps to the tutorial or duplicating them? 

It seems to me deployment is the primary hurdle to get up and running with Samza REST so I wanted it to be front and center in the docs.


> On July 27, 2016, 9:36 p.m., Navina Ramesh wrote:
> > docs/learn/documentation/versioned/rest/overview.md, line 83
> > <https://reviews.apache.org/r/50154/diff/3/?file=1455463#file1455463line83>
> >
> >     Table is missing description for job.proxy.factory.class , job.installations.path

That's because those configs are for the JobsResource, which may be included or excluded by users. The JobsResource configs are on the JobsResource page:
learn/documentation/latest/rest/resources/jobs.html#configuration


> On July 27, 2016, 9:36 p.m., Navina Ramesh wrote:
> > docs/learn/documentation/versioned/rest/overview.md, line 102
> > <https://reviews.apache.org/r/50154/diff/3/?file=1455463#file1455463line102>
> >
> >     Since this document serves as both overview and tutorial, can you please add more documentation on how to run the service? Perhaps some curl commands and sample output will be useful. 
> >     
> >     I was able to install samza-rest on my box. But I don't know what I should be doing beyond that.

That's good feedback. The reason that wasn't included is because it depends on what Resources you expose. The JobsResource ships with Samza REST but can be excluded. I can refer them to the JobsResource page if they're just getting started and want to try it out.


- Jake


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143777
-----------------------------------------------------------


On July 27, 2016, 8:47 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 8:47 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Navina Ramesh <nr...@linkedin.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/#review143777
-----------------------------------------------------------



I think it will be simpler if we can just provide architectural overview in the website and add a separate tutorial to run it with samza-hello-samza. Thanks!


docs/learn/documentation/versioned/rest/overview.md (line 71)
<https://reviews.apache.org/r/50154/#comment209700>

    Avoid using /export/content/ or any absolute path. It will be useful to describe what this location should point to.



docs/learn/documentation/versioned/rest/overview.md (line 83)
<https://reviews.apache.org/r/50154/#comment209705>

    Table is missing description for job.proxy.factory.class , job.installations.path



docs/learn/documentation/versioned/rest/overview.md (line 102)
<https://reviews.apache.org/r/50154/#comment209756>

    Since this document serves as both overview and tutorial, can you please add more documentation on how to run the service? Perhaps some curl commands and sample output will be useful. 
    
    I was able to install samza-rest on my box. But I don't know what I should be doing beyond that.


- Navina Ramesh


On July 27, 2016, 8:47 p.m., Jake Maes wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/50154/
> -----------------------------------------------------------
> 
> (Updated July 27, 2016, 8:47 p.m.)
> 
> 
> Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).
> 
> 
> Bugs: SAMZA-976
>     https://issues.apache.org/jira/browse/SAMZA-976
> 
> 
> Repository: samza
> 
> 
> Description
> -------
> 
> SAMZA-976 Samza REST Documentation
> 
> 
> Diffs
> -----
> 
>   bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
>   docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
>   docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
>   docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
>   docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/50154/diff/
> 
> 
> Testing
> -------
> 
> Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.
> 
> 
> Thanks,
> 
> Jake Maes
> 
>


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated July 27, 2016, 8:47 p.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
  docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated July 27, 2016, 6:12 p.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/img/versioned/learn/documentation/rest/JobsResource.png PRE-CREATION 
  docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes


Re: Review Request 50154: SAMZA-976 Samza REST Documentation

Posted by Jake Maes <ja...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/50154/
-----------------------------------------------------------

(Updated July 27, 2016, 12:28 a.m.)


Review request for samza, Boris Shkolnik, Chris Pettitt, Jake Maes, Navina Ramesh, Jagadish Venkatraman, Xinyu Liu, and Yi Pan (Data Infrastructure).


Bugs: SAMZA-976
    https://issues.apache.org/jira/browse/SAMZA-976


Repository: samza


Description
-------

SAMZA-976 Samza REST Documentation


Diffs (updated)
-----

  bin/generate-javadocs.sh da9f32da8f2a1f89ff28178ee703c4a065189da8 
  docs/learn/documentation/versioned/index.html 1e79bd6f39ee67b5a2b74222d647342990bbbe23 
  docs/learn/documentation/versioned/rest/monitors.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/overview.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resource-directory.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources.md PRE-CREATION 
  docs/learn/documentation/versioned/rest/resources/jobs.md PRE-CREATION 

Diff: https://reviews.apache.org/r/50154/diff/


Testing
-------

Verified by building the local site documentation and browsing. I wasn't able to verify the javadoc. If anyone knows why java doc would not be generated for new classes, I'd be interested to know.


Thanks,

Jake Maes