Improvements to the Jetty documentation.

Moved all old documentation under old_docs/.
Generating a small index.html that points to the guides and the old documentation.

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
This commit is contained in:
Simone Bordet 2020-09-29 15:19:25 +02:00
parent 6e3d7c85f3
commit 9c00826105
238 changed files with 239 additions and 195 deletions

View File

@ -127,6 +127,18 @@
</attributes> </attributes>
</configuration> </configuration>
<executions> <executions>
<execution>
<id>index</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>src/main/asciidoc</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<outputDirectory>${project.build.directory}/html</outputDirectory>
</configuration>
</execution>
<execution> <execution>
<id>operations-guide</id> <id>operations-guide</id>
<phase>generate-resources</phase> <phase>generate-resources</phase>
@ -163,6 +175,18 @@
<outputDirectory>${project.build.directory}/html/programming-guide</outputDirectory> <outputDirectory>${project.build.directory}/html/programming-guide</outputDirectory>
</configuration> </configuration>
</execution> </execution>
<execution>
<id>old_docs</id>
<phase>prepare-package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDirectory>${basedir}/src/main/asciidoc/old_docs</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<outputDirectory>${project.build.directory}/html/old_docs</outputDirectory>
</configuration>
</execution>
</executions> </executions>
</plugin> </plugin>
<plugin> <plugin>

View File

@ -36,6 +36,3 @@ ifdef::backend-html5[]
:safe-mode-unsafe: :safe-mode-unsafe:
:linkcss: :linkcss:
endif::[] endif::[]
// TODO: remove this attribute once all documentation has been ported.
:sub-order: attributes+

View File

@ -0,0 +1,39 @@
//
// ========================================================================
// 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 Documentation
include::config.adoc[]
== xref:operations-guide/index.adoc[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.
== xref:programming-guide/index.adoc[Jetty Programming Guide]
The Eclipse Jetty Programming Guide targets developers who want to use the Eclipse Jetty libraries in their applications, and advanced sysops/devops that want to customize the deployment of web applications.
== xref:contribution-guide/index.adoc[Jetty Contribution Guide]
The Eclipse Jetty Programming Guide targets developers that wish to contribute to the Jetty Project with code patches or documentation improvements.
== xref:old_docs/index.adoc[OLD Jetty Documentation]
The guides above are a work in progress for the current Jetty version.
The old Jetty documentation refers to old Jetty versions, and it is currently being ported to the current Jetty version.

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