Improvements to the Jetty documentation.

Added the custom module section. Shortened titles to better fit the TOC. Enlarged content from 62.5em to 80em. Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
jetty · Feb 19, 2021 · a495539 · a495539
1 parent 5fee012
commit a495539
Show file tree

Hide file tree

Showing 23 changed files with 291 additions and 266 deletions.
diff --git a/documentation/jetty-documentation/pom.xml b/documentation/jetty-documentation/pom.xml
@@ -46,13 +46,13 @@
           <attributes>
             <project.basedir>${project.basedir}</project.basedir>
             <maven.local.repo>${settings.localRepository}</maven.local.repo>
+            <prog_guide>../programming-guide/index.html</prog_guide>
             <JDURL>http://www.eclipse.org/jetty/javadoc/${project.version}</JDURL>
             <JXURL>http://download.eclipse.org/jetty/stable-9/xref</JXURL>
             <SRCDIR>${basedir}/..</SRCDIR>
             <GITBROWSEURL>https://github.com/eclipse/jetty.project/tree/master</GITBROWSEURL>
             <GITDOCURL>https://github.com/eclipse/jetty.project/tree/jetty-10.0.x-doc-refactor/jetty-documentation/src/main/asciidoc</GITDOCURL>
             <OPGUIDE>../operations-guide/index.html</OPGUIDE>
-            <PROGGUIDE>../programming-guide/index.html</PROGGUIDE>
             <GSTARTGUIDE>../gettingstarted-guide/index.html</GSTARTGUIDE>
             <CONTRIBGUIDE>../contribution-guide/index.html</CONTRIBGUIDE>
             <MVNCENTRAL>https://repo1.maven.org/maven2</MVNCENTRAL>

diff --git a/documentation/jetty-documentation/src/main/asciidoc/config.adoc b/documentation/jetty-documentation/src/main/asciidoc/config.adoc
@@ -23,6 +23,8 @@
 :sectlinks:
 :sectanchors:
 
+:source-highlighter: coderay
+
 // Use fonts for admonitions.
 :icons: font
 

diff --git a/documentation/jetty-documentation/src/main/asciidoc/old_docs/startup/chapter.adoc b/documentation/jetty-documentation/src/main/asciidoc/old_docs/startup/chapter.adoc
@@ -14,6 +14,5 @@
 [[startup]]
 == Starting Jetty
 
-include::custom-modules.adoc[]
 include::startup-unix-service.adoc[]
 include::startup-windows-service.adoc[]
diff --git a/...tion/jetty-documentation/src/main/asciidoc/old_docs/startup/custom-modules.adoc b/...tion/jetty-documentation/src/main/asciidoc/old_docs/startup/custom-modules.adoc
diff --git a/...documentation/src/main/asciidoc/operations-guide/architecture/architecture.adoc b/...documentation/src/main/asciidoc/operations-guide/architecture/architecture.adoc
@@ -14,6 +14,41 @@
 [[og-arch]]
 === Architecture Overview
 
+[[og-arch-concepts]]
+==== Main Concepts
+
+Jetty is an HTTP server and Servlet Container, and supports deployments of web applications.
+
+The Jetty _server_ listens on one or more network ports using one or more __connector__s.
+
+Clients send HTTP requests for specific URIs, such as `+https://host/store/cart+`.
+
+The HTTP requests arrive to the connectors through the network; the Jetty server processes the requests and, based on their URIs, forwards them to the appropriate web application.
+
+[plantuml]
+----
+skinparam backgroundColor transparent
+skinparam monochrome true
+skinparam shadowing false
+skinparam roundCorner 10
+
+scale 1.25
+
+cloud Internet as internet
+rectangle "Jetty Server" as server
+rectangle "HTTP/1.1 Connector" as http
+rectangle "HTTP/2 Connector" as http2
+rectangle "WebApp "Store"" as store
+rectangle "WebApp "Catalog"" as catalog
+
+internet -- http
+internet -- http2
+http -- server
+http2 -- server
+server -- store
+server -- catalog
+----
+
 There are three main concepts on which the Jetty standalone server is based:
 
 * The xref:og-arch-modules[Jetty _module_ system], where Jetty modules provides Jetty features.

diff --git a/...tion/jetty-documentation/src/main/asciidoc/operations-guide/deploy/chapter.adoc b/...tion/jetty-documentation/src/main/asciidoc/operations-guide/deploy/chapter.adoc
@@ -12,7 +12,7 @@
 //
 
 [[og-deploy]]
-=== Customizing Web Application Deployment
+=== Web Application Deployment
 
 Most of the times you want to be able to customize the deployment of your web applications, for example by changing the `contextPath`, or by adding JNDI entries, or by configuring virtual hosts, etc.
 

diff --git a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/index.adoc b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/index.adoc
@@ -29,7 +29,6 @@ include::modules/chapter.adoc[]
 include::deploy/chapter.adoc[]
 include::protocols/chapter.adoc[]
 include::keystore/chapter.adoc[]
-include::xml/chapter.adoc[]
 include::sessions/chapter.adoc[]
 include::quickstart/chapter.adoc[]
 include::annotations/chapter.adoc[]
@@ -39,3 +38,4 @@ include::jaas/chapter.adoc[]
 include::jmx/chapter.adoc[]
 include::logging/chapter.adoc[]
 include::troubleshooting/chapter.adoc[]
+include::xml/chapter.adoc[]
diff --git a/...on/jetty-documentation/src/main/asciidoc/operations-guide/keystore/chapter.adoc b/...on/jetty-documentation/src/main/asciidoc/operations-guide/keystore/chapter.adoc
@@ -12,7 +12,7 @@
 //
 
 [[og-keystore]]
-=== Configuring KeyStores
+=== Configuring SSL/TLS KeyStores
 
 A KeyStore is a file on the file system that contains a private key and a public certificate, along with the certificate chain of the certificate authorities that issued the certificate.
 The private key, the public certificate and the certificate chain, but more generally the items present in a KeyStore, are typically referred to as "cryptographic material".