From f4323a3e3fbab7305be549ed1f3c46fe57c58856 Mon Sep 17 00:00:00 2001 From: Simone Bordet Date: Mon, 1 Feb 2021 00:24:13 +0100 Subject: [PATCH] Improvements to the Jetty documentation. Moved documentation examples back into jetty-documentation module. Signed-off-by: Simone Bordet --- .../jetty-asciidoctor-extensions/pom.xml | 80 ----------------- documentation/jetty-documentation/pom.xml | 86 ++++++++++++++++++- .../operations-guide/.asciidoctorconfig | 2 +- .../operations-guide/begin/chapter.adoc | 2 +- .../jetty/docs/programming/ComponentDocs.java | 0 .../jetty/docs/programming/HTTP2Docs.java | 0 .../jetty/docs/programming/JMXDocs.java | 0 .../docs/programming/SelectorManagerDocs.java | 0 .../client/ClientConnectorDocs.java | 0 .../client/http/HTTPClientDocs.java | 0 .../client/http2/HTTP2ClientDocs.java | 0 .../docs/programming/server/ServerDocs.java | 0 .../server/http/HTTPServerDocs.java | 0 .../server/http2/HTTP2ServerDocs.java | 0 .../server/session/SessionDocs.java | 0 15 files changed, 86 insertions(+), 84 deletions(-) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/ComponentDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/HTTP2Docs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/JMXDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/SelectorManagerDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/client/ClientConnectorDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/client/http2/HTTP2ClientDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/server/ServerDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/server/http/HTTPServerDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/server/http2/HTTP2ServerDocs.java (100%) rename documentation/{jetty-asciidoctor-extensions => jetty-documentation}/src/main/java/org/eclipse/jetty/docs/programming/server/session/SessionDocs.java (100%) diff --git a/documentation/jetty-asciidoctor-extensions/pom.xml b/documentation/jetty-asciidoctor-extensions/pom.xml index 3933ffe095b..3e1e684761c 100644 --- a/documentation/jetty-asciidoctor-extensions/pom.xml +++ b/documentation/jetty-asciidoctor-extensions/pom.xml @@ -21,85 +21,5 @@ test-distribution ${project.version} - - org.eclipse.jetty.toolchain - jetty-servlet-api - - - org.eclipse.jetty - jetty-alpn-server - ${project.version} - - - org.eclipse.jetty - jetty-client - ${project.version} - - - org.eclipse.jetty - jetty-jmx - ${project.version} - - - org.eclipse.jetty - jetty-rewrite - ${project.version} - - - org.eclipse.jetty - jetty-server - ${project.version} - - - org.eclipse.jetty - jetty-servlet - ${project.version} - - - org.eclipse.jetty - jetty-servlets - ${project.version} - - - org.eclipse.jetty - jetty-util-ajax - ${project.version} - - - org.eclipse.jetty - jetty-webapp - ${project.version} - - - org.eclipse.jetty.fcgi - fcgi-client - ${project.version} - - - org.eclipse.jetty.http2 - http2-server - ${project.version} - - - org.eclipse.jetty.http2 - http2-http-client-transport - ${project.version} - - - org.eclipse.jetty - jetty-slf4j-impl - ${project.version} - compile - - - org.eclipse.jetty.memcached - jetty-memcached-sessions - ${project.version} - - - org.eclipse.jetty - jetty-nosql - ${project.version} - diff --git a/documentation/jetty-documentation/pom.xml b/documentation/jetty-documentation/pom.xml index d656531f677..6c77e53c107 100644 --- a/documentation/jetty-documentation/pom.xml +++ b/documentation/jetty-documentation/pom.xml @@ -9,7 +9,7 @@ 4.0.0 jetty-documentation Jetty :: Documentation - pom + jar @@ -35,7 +35,7 @@ ${settings.localRepository} - ${project.basedir}/.. + ${project.basedir}/../.. http://www.eclipse.org/jetty/javadoc/${project.version} http://download.eclipse.org/jetty/stable-9/xref ${basedir}/.. @@ -132,4 +132,86 @@ + + + + org.eclipse.jetty.toolchain + jetty-servlet-api + + + org.eclipse.jetty + jetty-alpn-server + ${project.version} + + + org.eclipse.jetty + jetty-client + ${project.version} + + + org.eclipse.jetty + jetty-jmx + ${project.version} + + + org.eclipse.jetty + jetty-rewrite + ${project.version} + + + org.eclipse.jetty + jetty-server + ${project.version} + + + org.eclipse.jetty + jetty-servlet + ${project.version} + + + org.eclipse.jetty + jetty-servlets + ${project.version} + + + org.eclipse.jetty + jetty-util-ajax + ${project.version} + + + org.eclipse.jetty + jetty-webapp + ${project.version} + + + org.eclipse.jetty.fcgi + fcgi-client + ${project.version} + + + org.eclipse.jetty.http2 + http2-server + ${project.version} + + + org.eclipse.jetty.http2 + http2-http-client-transport + ${project.version} + + + org.eclipse.jetty + jetty-slf4j-impl + ${project.version} + + + org.eclipse.jetty.memcached + jetty-memcached-sessions + ${project.version} + + + org.eclipse.jetty + jetty-nosql + ${project.version} + + diff --git a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/.asciidoctorconfig b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/.asciidoctorconfig index 41b4a711098..c461a71d3cc 100644 --- a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/.asciidoctorconfig +++ b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/.asciidoctorconfig @@ -1,3 +1,3 @@ // Asciidoctor IDE configuration file. // See https://github.com/asciidoctor/asciidoctor-intellij-plugin/wiki/Support-project-specific-configurations -:JETTY_HOME: ../../../../../../jetty-home/target/jetty-home +:JETTY_HOME: ../../../../../../../jetty-home/target/jetty-home diff --git a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc index 26267ab6328..16bc784256e 100644 --- a/documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc +++ b/documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc @@ -16,7 +16,7 @@ This section will get you started with Eclipse Jetty. -include::../../../../../../jetty-home/src/main/resources/README.adoc[tags=quick] +include::../../../../../../../jetty-home/src/main/resources/README.adoc[tags=quick] The following sections will guide you in details about downloading, installing and starting Jetty, as well as deploying your web applications to Jetty. diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/ComponentDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/ComponentDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/ComponentDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/ComponentDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/HTTP2Docs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/HTTP2Docs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/HTTP2Docs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/HTTP2Docs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/JMXDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/JMXDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/JMXDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/JMXDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/SelectorManagerDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/SelectorManagerDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/SelectorManagerDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/SelectorManagerDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/client/ClientConnectorDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/client/ClientConnectorDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/client/ClientConnectorDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/client/ClientConnectorDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/client/http2/HTTP2ClientDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/client/http2/HTTP2ClientDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/client/http2/HTTP2ClientDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/client/http2/HTTP2ClientDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/ServerDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/ServerDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/ServerDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/ServerDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/http/HTTPServerDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/http/HTTPServerDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/http/HTTPServerDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/http/HTTPServerDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/http2/HTTP2ServerDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/http2/HTTP2ServerDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/http2/HTTP2ServerDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/http2/HTTP2ServerDocs.java diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/session/SessionDocs.java b/documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/session/SessionDocs.java similarity index 100% rename from documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/programming/server/session/SessionDocs.java rename to documentation/jetty-documentation/src/main/java/org/eclipse/jetty/docs/programming/server/session/SessionDocs.java