diff --git a/jetty-documentation/src/main/asciidoc/administration/part.adoc b/jetty-documentation/src/main/asciidoc/administration/part.adoc index 2b457b3d901..e471f7fbda3 100644 --- a/jetty-documentation/src/main/asciidoc/administration/part.adoc +++ b/jetty-documentation/src/main/asciidoc/administration/part.adoc @@ -18,6 +18,7 @@ include::startup/chapter.adoc[] include::sessions/chapter.adoc[] +include::logging/chapter.adoc[] include::jndi/chapter.adoc[] include::annotations/chapter.adoc[] include::jmx/chapter.adoc[] @@ -27,4 +28,3 @@ include::fastcgi/chapter.adoc[] include::extras/chapter.adoc[] include::runner/chapter.adoc[] include::tuning/chapter.adoc[] -include::logging/chapter.adoc[] diff --git a/jetty-documentation/src/main/asciidoc/configuring/contexts/temporary-directories.adoc b/jetty-documentation/src/main/asciidoc/configuring/contexts/temporary-directories.adoc index 2e1b2f8a1c2..bb1be515494 100644 --- a/jetty-documentation/src/main/asciidoc/configuring/contexts/temporary-directories.adoc +++ b/jetty-documentation/src/main/asciidoc/configuring/contexts/temporary-directories.adoc @@ -17,7 +17,7 @@ [[ref-temporary-directories]] === Temporary Directories -Jetty itself has no temporary directories, but you can assign a directory for each web application, into which the WAR is unpacked, JSPs compiled on-the-fly, etc. +Jetty itself has no temporary directories, but you can assign a directory for each web application, into which the WAR is unpacked, JSPs compiled on-the-fly, etc. If you do not assign a specific temporary directory, Jetty will create one as needed when your web application starts. Whether you set the location of the temporary directory - or you let Jetty create one for you - you also have a choice to either keep or delete the temporary directory when the web application stops. @@ -41,11 +41,11 @@ Once the temp directory is created, it is retrievable as the value (as a File) o ===== The location of the temp directory -By default, Jetty will create this directory inside the directory named by the `java.io.tmpdir` System property. -You can instruct Jetty to use a different parent directory by setting the context attribute `org.eclipse.jetty.webapp.basetempdir` to the name of the desired parent directory. +By default, Jetty will create this directory inside the directory named by the `java.io.tmpdir` System property. +You can instruct Jetty to use a different parent directory by setting the context attribute `org.eclipse.jetty.webapp.basetempdir` to the name of the desired parent directory. The directory named by this attribute _must_ exist and be __writeable__. -As usual with Jetty, you can either set this attribute in a context xml file, or you can do it in code. +As usual with Jetty, you can either set this attribute in a context xml file, or you can do it in code. Here's an example of setting it in an xml file: @@ -77,9 +77,9 @@ context.setAttribute("org.eclipse.jetty.webapp.basetempdir", "/tmp/foo"); There are several ways to use a particular directory as the temporary directory: -call WebAppContext.setTempDirectory(String dir):: - Like before this can be accomplished with an xml file or directly in code. Here's an example of setting the temp directory in xml: - + +*Call WebAppContext.setTempDirectory(String dir)* +Like before this can be accomplished with an xml file or directly in code. Here's an example of setting the temp directory in xml: + [source, xml, subs="{sub-order}"] ---- @@ -101,8 +101,8 @@ context.setWar("foo.war"); context.setTempDirectory(new File("/some/dir/foo")); ---- -set the `javax.servlet.context.tempdir` context attribute:: - You should set this context attribute with the name of directory you want to use as the temp directory. Again, you can do this in xml: +*Set the `javax.servlet.context.tempdir` context attribute* +You should set this context attribute with the name of directory you want to use as the temp directory. Again, you can do this in xml: [source, xml, subs="{sub-order}"] ---- @@ -139,17 +139,17 @@ ____ ==== The "work" directory -Mostly for backward compatibility, from jetty-9.1.1 onwards, it is be possible to create a directory named "work" in the `$\{jetty.base}` directory. -If such a directory is found, it is assumed you want to use it as the parent directory for all of the temporary directories of the webapps in that `$\{jetty.base}`. +Mostly for backward compatibility, from jetty-9.1.1 onwards, it is be possible to create a directory named "work" in the `$\{jetty.base}` directory. +If such a directory is found, it is assumed you want to use it as the parent directory for all of the temporary directories of the webapps in that `$\{jetty.base}`. Moreover, as has historically been the case, these temp directories inside the work directory are not cleaned up when jetty exists (or more correctly speaking, the `temp` directory corresponding to a context is not cleaned up when that context stops). -When a work directory is used, the algorithm for generating the name of the context-specific temp directories omits the random digit string. +When a work directory is used, the algorithm for generating the name of the context-specific temp directories omits the random digit string. This ensures the name of the directory remains consistent across context restarts. ==== Persisting the temp directory -Sometimes you may find it useful to keep the contents of the temporary directory between restarts of the web application. -By default, Jetty will _not_ persist the temp directory. +Sometimes you may find it useful to keep the contents of the temporary directory between restarts of the web application. +By default, Jetty will _not_ persist the temp directory. To configure Jetty to keep it, use link:{JDURL}/org/eclipse/jetty/webapp/WebAppContext.html[WebAppContext.setPersistTempDirectory(true)]. ____ diff --git a/jetty-documentation/src/main/asciidoc/development/part.adoc b/jetty-documentation/src/main/asciidoc/development/part.adoc index f1f64145998..cfadcad14c4 100644 --- a/jetty-documentation/src/main/asciidoc/development/part.adoc +++ b/jetty-documentation/src/main/asciidoc/development/part.adoc @@ -16,14 +16,14 @@ = Jetty Development Guide -include::maven/chapter.adoc[] -include::ant/chapter.adoc[] -include::handlers/chapter.adoc[] include::embedding/chapter.adoc[] -include::debugging/chapter.adoc[] -include::frameworks/chapter.adoc[] include::clients/http/chapter.adoc[] +include::maven/chapter.adoc[] +include::handlers/chapter.adoc[] +include::debugging/chapter.adoc[] include::websockets/intro/chapter.adoc[] include::websockets/jetty/chapter.adoc[] //include::websockets/java/chapter.adoc[] include::continuations/chapter.adoc[] +include::frameworks/chapter.adoc[] +include::ant/chapter.adoc[] diff --git a/jetty-documentation/src/main/asciidoc/quick-start/getting-started/chapter.adoc b/jetty-documentation/src/main/asciidoc/quick-start/getting-started/chapter.adoc index fc196e2c434..f84630f55d3 100644 --- a/jetty-documentation/src/main/asciidoc/quick-start/getting-started/chapter.adoc +++ b/jetty-documentation/src/main/asciidoc/quick-start/getting-started/chapter.adoc @@ -17,10 +17,9 @@ [[quick-start-getting-started]] == Using Jetty Introduction -You can use Jetty in many different ways, ranging from embedding Jetty in applications, launching it from different build systems, from different JVM-based languages, or as a standalone distribution. +You can use Jetty in many different ways, ranging from embedding Jetty in applications, launching it from different build systems, from different JVM-based languages, or as a standalone distribution. This guide covers the latter, a standalone distribution suitable for deploying web applications. include::jetty-installing.adoc[] include::jetty-running.adoc[] include::jetty-deploying.adoc[] -include::jetty-coordinates.adoc[] diff --git a/jetty-documentation/src/main/asciidoc/quick-start/introduction/chapter.adoc b/jetty-documentation/src/main/asciidoc/quick-start/introduction/chapter.adoc index bf29a783f61..804dcb066e9 100644 --- a/jetty-documentation/src/main/asciidoc/quick-start/introduction/chapter.adoc +++ b/jetty-documentation/src/main/asciidoc/quick-start/introduction/chapter.adoc @@ -20,3 +20,4 @@ include::what-is-jetty.adoc[] include::what-version.adoc[] include::jetty-javaee.adoc[] +include::jetty-coordinates.adoc[] diff --git a/jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-coordinates.adoc b/jetty-documentation/src/main/asciidoc/quick-start/introduction/jetty-coordinates.adoc similarity index 91% rename from jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-coordinates.adoc rename to jetty-documentation/src/main/asciidoc/quick-start/introduction/jetty-coordinates.adoc index 5b439d9e5b9..947b7ed1232 100644 --- a/jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-coordinates.adoc +++ b/jetty-documentation/src/main/asciidoc/quick-start/introduction/jetty-coordinates.adoc @@ -19,8 +19,8 @@ ==== Maven Coordinates -Jetty has existed in Maven Central almost since its inception, however under a couple of different coordinates over the years. -When Jetty was based at SourceForge and then The Codehaus it was located under the `groupId` of `org.mortbay.jetty`. +Jetty has existed in Maven Central almost since its inception, though the coordinates have changed over the years. +When Jetty was based at SourceForge and then The Codehaus it was located under the `groupId` of `org.mortbay.jetty`. With Jetty 7 the project moved to the Eclipse foundation and to a new `groupId` at that time to reflect its new home. The top level Project Object Model (POM) for the Jetty project is located under the following coordinates. @@ -39,7 +39,7 @@ The top level Project Object Model (POM) for the Jetty project is located under The changes between versions of Jetty are tracked in a file called VERSIONS.txt, which is under source control and is generated on release. Those generated files are also uploaded into Maven Central during the release of the top level POM. You can find them as a classifier marked artifact. -http://central.maven.org/maven2/org/eclipse/jetty/jetty-project/ +http://central.maven.org/maven2/org/eclipse/jetty/jetty-project/ [source, xml, subs="{sub-order}"] ---- diff --git a/jetty-documentation/src/main/asciidoc/quick-start/introduction/what-is-jetty.adoc b/jetty-documentation/src/main/asciidoc/quick-start/introduction/what-is-jetty.adoc index 05e09315c7d..d88ab7affe3 100644 --- a/jetty-documentation/src/main/asciidoc/quick-start/introduction/what-is-jetty.adoc +++ b/jetty-documentation/src/main/asciidoc/quick-start/introduction/what-is-jetty.adoc @@ -25,4 +25,4 @@ This guide is in two parts. * The second part describes advanced uses of Jetty, providing in depth coverage of specific features like our highly scalable async client, proxy servlet configuration, the Jetty Maven plugin, and using Jetty as an embedded server. The advanced section includes tutorials, howtos, videos, and reference materials. Feedback is always welcome! -Additionally, if you are interested in how to contribute to the open source project there is a section on that as well! +Additionally, if you are interested in how to contribute to the open source project there is a link:#community[section on that as well!]