Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jetty-dev] Embedded Examples

yeah, if we can hammer out the basic convention for this I plan to get all the embedded examples wired up...and a clear contribution process for others to contribute more examples

embedding is a very popular usage of jetty so things we can do to make it easier and clearer have to help..

jesse

--
jesse mcconnell
jesse.mcconnell@xxxxxxxxx


On Thu, May 23, 2013 at 4:18 PM, Eirik Bjørsnøs <eirbjo@xxxxxxxxx> wrote:

Jesse,

Wow, this is a great initiative!

Next up we could have an example of running a war file in a webappcontext, setting a init parameter or two.

After that, I'd love to see a servlet 3.0 example, which is currently non-trivial to implement in embedded / main method code because of this: https://bugs.eclipse.org/bugs/show_bug.cgi?id=342972

Eirik.



On Thu, May 23, 2013 at 10:52 PM, Shirley Boulay <boulay@xxxxxxxxxxx> wrote:
way cool. -sb


On Thu, May 23, 2013 at 4:38 PM, Jesse McConnell <jesse.mcconnell@xxxxxxxxx> wrote:
just to toot the horn of the docs some more, things I like are:

- the title of the Example has a link to the actual source
- you can doubleclick on the source and it makes it simple to cut and paste
- <version> in maven coordinates section uses the ${project.version} trick so it is always up to date with the version of the documentation


--
jesse mcconnell
jesse.mcconnell@xxxxxxxxx


On Thu, May 23, 2013 at 3:34 PM, Jesse McConnell <jesse.mcconnell@xxxxxxxxx> wrote:
I added the following page earlier today.


I wanted to get feedback on the general approach.  This is largely in response to the number of times I have run across people stumped on seemingly simple embedded jetty usage and their inability to find more complete examples.  I have also linked a lot of folks in stack overflow and on jetty irc directly to our embedded examples and it would be better if we could link into our docs and help people help themselves.

So...what I want to do is slurp in the file like I show above and then have a walk through section that explains some of the nuts and bolts of embedded behavior in a step by step manner.  Personally I like the approach of the walkthrough indicating the lines that the description pertains to but this has the potential to get out of date.  However I have an <important> tag at the top and I am personally comfortable with it getting out of date and having a clear notification mechanism for addressing it like this.  Also the examples do not change frequently so...

Now, the flip side is that we could just document our example files better and merge the walkthrough together with the comments in the java files, but we hit a technical limitation with the JavaParser we are using to support pulling out specific methods into the documentation.  The comments are basically chewed up :)

so...I can spend some time sorting that out but personally I rather like the approach I have here so I wanted to get some other opinions.

cheers,
jesse


--
jesse mcconnell
jesse.mcconnell@xxxxxxxxx


_______________________________________________
jetty-dev mailing list
jetty-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/jetty-dev




--
Shirley Boulay
Technical Writer

Intalio, the modern way to build business applications..
Webtide developer advice, services and support from the
Jetty & CometD authors/experts.


_______________________________________________
jetty-dev mailing list
jetty-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/jetty-dev



_______________________________________________
jetty-dev mailing list
jetty-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/jetty-dev



Back to the top