Improvements to the Jetty documentation.

Renamed operation-guide to operations-guide.
Moved the operations-guide old documentation under old_docs/.
Got rid of the getting-started guide, moved its documentation under operations-guide/old_docs.

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
This commit is contained in:
Simone Bordet 2020-09-10 09:50:26 +02:00
parent 5d1d7c9c26
commit b10a14ebf9
164 changed files with 89 additions and 97 deletions

View File

@ -170,7 +170,7 @@
<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>../operation-guide/index.html</OPGUIDE>
<OPGUIDE>../operations-guide/index.html</OPGUIDE>
<PROGGUIDE>../programming-guide/index.html</PROGGUIDE>
<GSTARTGUIDE>../gettingstarted-guide/index.html</GSTARTGUIDE>
<CONTRIBGUIDE>../contribution-guide/index.html</CONTRIBGUIDE>
@ -181,7 +181,7 @@
</configuration>
<executions>
<execution>
<id>gettingstarted-guide</id>
<id>operations-guide</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
@ -189,23 +189,9 @@
<configuration>
<backend>html5</backend>
<templateDir>${web.resources.directory}/asciidoc/slim-template</templateDir>
<sourceDirectory>${basedir}/src/main/asciidoc/gettingstarted-guide</sourceDirectory>
<sourceDirectory>src/main/asciidoc/operations-guide</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<outputDirectory>${project.build.directory}/html/gettingstarted-guide</outputDirectory>
</configuration>
</execution>
<execution>
<id>operation-guide</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<templateDir>${web.resources.directory}/asciidoc/slim-template</templateDir>
<sourceDirectory>${basedir}/src/main/asciidoc/operation-guide</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<outputDirectory>${project.build.directory}/html/operation-guide</outputDirectory>
<outputDirectory>${project.build.directory}/html/operations-guide</outputDirectory>
</configuration>
</execution>
<execution>

View File

@ -1,57 +0,0 @@
//
// ========================================================================
// Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under
// the terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0
//
// This Source Code may also be made available under the following
// Secondary Licenses when the conditions for such availability set
// forth in the Eclipse Public License, v. 2.0 are satisfied:
// the Apache License v2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
:doctitle: Eclipse Jetty: Getting Started Guide
:author: Jetty Developers
:email: jetty-dev@eclipse.org
:revnumber: 1.0
:revdate: {TIMESTAMP}
:toc: left
:toc-title: Getting Started Guide
:toc-style:
:header-style: eclipse-thin
:breadcrumb-style: eclipse-thin
:footer-style: default
:breadcrumb: Home:../index.html | Getting Started Guide:./index.html
// html specific directives
ifdef::backend-html5[]
:safe-mode-unsafe:
:stylesdir: ../common/css
:stylesheet: jetty.css
:linkcss:
:scriptsdir: ../common/js
endif::[]
// options for special blocks, code snippets, screen, etc
:sub-order: attributes+
// uncomment to allow include::https:// style content inclusion
//:allow-uri-read: true
// use fonts for admonitions
:icons: font
// suppress automatic id generation
:sectids!:
include::introduction/chapter.adoc[]
include::getting-started/chapter.adoc[]

View File

@ -16,19 +16,20 @@
// ========================================================================
//
:doctitle: Eclipse Jetty: Operation Guide
:doctitle: Eclipse Jetty: Operations Guide
:author: Jetty Developers
:email: jetty-dev@eclipse.org
:revnumber: 1.0
:revnumber: {version}
:revdate: {TIMESTAMP}
:toc: left
:toc-title: Operation Guide
:toc-title: Operations Guide
:toc-style:
:header-style: eclipse-thin
:breadcrumb-style: eclipse-thin
:footer-style: default
:breadcrumb: Home:../index.html | Operation Guide:./index.html
:breadcrumb: Home:../index.html | Operations Guide:./index.html
// docinfo lets you pull in shared content and/or influence via render type
//:docinfodir: {DOCINFODIR}/documentation
@ -55,21 +56,35 @@ endif::[]
// suppress automatic id generation
:sectids!:
// download and install
include::introduction.adoc[]
// TODO: jetty.home vs jetty.base
include::startup/chapter.adoc[]
include::contexts/chapter.adoc[]
include::deploying/chapter.adoc[]
include::connectors/chapter.adoc[]
include::http2/chapter.adoc[]
include::logging/chapter.adoc[]
include::security/chapter.adoc[]
include::sessions/sessions.adoc[]
include::jsp/chapter.adoc[]
include::annotations/chapter.adoc[]
include::jmx/chapter.adoc[]
include::jndi/chapter.adoc[]
include::alpn/chapter.adoc[]
include::fastcgi/chapter.adoc[]
include::extras/chapter.adoc[]
include::runner/chapter.adoc[]
include::tuning/chapter.adoc[]
// TODO: how jetty standalone work what start.jar does, command line options, modules, etc.
// TODO: this is mostly in old_docs/startup.
// TODO: [[quick-start-configure]]
// TODO: list of modules, how to write a custom module, examples e.g. http2, etc.
== OLD DOCUMENTATION
include::old_docs/gettingstarted/introduction/chapter.adoc[]
include::old_docs/gettingstarted/getting-started/chapter.adoc[]
// TODO: how about other directories under old_docs/gettingstarted/?
include::old_docs/startup/chapter.adoc[]
include::old_docs/contexts/chapter.adoc[]
include::old_docs/deploying/chapter.adoc[]
include::old_docs/connectors/chapter.adoc[]
include::old_docs/http2/chapter.adoc[]
include::old_docs/logging/chapter.adoc[]
include::old_docs/security/chapter.adoc[]
include::old_docs/sessions/sessions.adoc[]
include::old_docs/jsp/chapter.adoc[]
include::old_docs/annotations/chapter.adoc[]
include::old_docs/jmx/chapter.adoc[]
include::old_docs/jndi/chapter.adoc[]
include::old_docs/alpn/chapter.adoc[]
include::old_docs/fastcgi/chapter.adoc[]
include::old_docs/extras/chapter.adoc[]
include::old_docs/runner/chapter.adoc[]
include::old_docs/tuning/chapter.adoc[]

View File

@ -0,0 +1,48 @@
//
// ========================================================================
// Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under
// the terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0
//
// This Source Code may also be made available under the following
// Secondary Licenses when the conditions for such availability set
// forth in the Eclipse Public License, v. 2.0 are satisfied:
// the Apache License v2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
[[og-guide]]
== Eclipse Jetty Operations Guide
The Eclipse Jetty Operations Guide targets sysops, devops, and developers who want to install Eclipse Jetty as a standalone server to deploy web applications.
[[og-download]]
=== Downloading Eclipse Jetty
The Eclipse Jetty distribution is available for download from link:https://www.eclipse.org/jetty/download.html[]
The Eclipse Jetty distribution is available in both `zip` and `gzip` formats; download the one most appropriate for your system, typically `zip` for Windows and `gzip` for other operative systems.
[[og-install]]
=== Installing Eclipse Jetty
After the download, unpacking the Eclipse Jetty distribution will extract the files into a directory called `jetty-distribution-VERSION`, where `VERSION` is the version that you downloaded, for example `10.0.0`, so that the directory is called `jetty-distribution-10.0.0`.
Unpack the Eclipse Jetty distribution compressed file in a convenient location, for example under `/opt`.
The rest of the instructions in this documentation will refer to this location as `$JETTY_HOME`.
IMPORTANT: It is important that *only* stable release versions are used in production environments.
Versions that have been deprecated or are released as Milestones (M), Alpha, Beta or Release Candidates (RC) are *not* suitable for production as they may contain security flaws or incomplete/non-functioning feature sets.
[[og-running]]
=== Running Eclipse Jetty
Eclipse Jetty as a standalone server has no graphical user interface, so configuring and running the server is done from the command line.
TODO: section about general architecture - modules etc.

View File

@ -27,7 +27,7 @@ The Jetty documentation is broken up in to four parts:
It provides information about what Jetty is and where you can download it, and where to find Jetty in repositories like Central Maven.
It also provides a Quick Start guide on how to get Jetty up and running as well as an overview of how and what to configure in Jetty.
* The link:{OPGUIDE}[Operation Guide] details configuring Jetty as a distributed package at a more granular level.
* The link:{OPGUIDE}[Operations Guide] details configuring Jetty as a distributed package at a more granular level.
From server startup to session management, logging, HTTP/2 support and Jetty optimization, these chapters will help administrators get the most out of their distributed Jetty server instances.
This section also covers configuring many of the most common servlet container features such as JNDI and JMX.

Some files were not shown because too many files have changed in this diff Show More