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