bee4732 Include complete documentation instead of per-directory readmes.
src/docs.pdf (new) | Bin 0 -> 111589 bytes
src/lucee-base/logs/readme.md (gone) | 12 -----
src/lucee-base/lucee-server/readme.md (gone) | 17 ------
src/lucee-base/modules/readme.md (gone) | 14 -----
src/lucee-base/readme.md (gone) | 54 --------------------
src/lucee-base/resources/readme.md (gone) | 13 -----
src/lucee-base/webapps/readme.md (gone) | 39 --------------
src/lucee-base/webinfs/readme.md (gone) | 14 -----
8 files changed, 163 deletions(-)
diff --git a/src/docs.pdf b/src/docs.pdf
new file mode 100644
index 0000000..830ac75
Binary files /dev/null and b/src/docs.pdf differ
diff --git a/src/lucee-base/logs/readme.md b/src/lucee-base/logs/readme.md
deleted file mode 100644
index 99e285a..0000000
--- a/src/lucee-base/logs/readme.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Lucee on Jetty logs directory.
-
-The primary Lucee on Jetty readme is README.TXT in the top-level directory.
-
-This directory is where Jetty will place log files, including stderr and stdout.
-
-For details on Jetty logging, see the Jetty documentation:
- http://www.eclipse.org/jetty/documentation/current/configuring-logging.html
-
-
-Lucee log files are located within a web context's configuration directory, that
-is, within `lucee-base/webinfs/{web-context-label}/logs`
diff --git a/src/lucee-base/lucee-server/readme.md b/src/lucee-base/lucee-server/readme.md
deleted file mode 100644
index db4baa5..0000000
--- a/src/lucee-base/lucee-server/readme.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# Lucee on Jetty lucee-server directory.
-
-The primary Lucee on Jetty readme is README.TXT in the top-level directory.
-
-This lucee-server directory is where Lucee stores the configuration for the
-Lucee Server and the patches when Lucee is updated - by default this directory
-is found in lib/ext/lucee-server (alongside the Lucee JARs), but this bundle has
-been configured for a more convenient location.
-
-The context directory contains the lucee-server.xml config file for the Lucee
-Server Admin, along with other global/server-level files.
-
-The patches directory will contain one or more X.X.X.xxx.lco files - the latest
-patch in this directory is the version Lucee will run.
-
-A manual upgrade can be performed by copying a newer .lco file to this directory
-and restarting Lucee.
diff --git a/src/lucee-base/modules/readme.md b/src/lucee-base/modules/readme.md
deleted file mode 100644
index 65c8636..0000000
--- a/src/lucee-base/modules/readme.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# Lucee on Jetty modules directory.
-
-The primary Lucee on Jetty readme is README.TXT in the top-level directory.
-
-Jetty uses modules to group dependenies, libraries, and configuration so that
-a single module can be enabled without needing to manually enable all the others
-that it uses, and to verify that relevant files exist.
-
-You can read more about modules in the Jetty documentation:
- http://www.eclipse.org/jetty/documentation/current/startup-modules.html
-
-The **lucee.mod** file defines a Lucee module consisting of the other modules
-Lucee requires to run, referencing the Lucee JAR and Jetty configuration
-located within the lucee directory.
\ No newline at end of file
diff --git a/src/lucee-base/readme.md b/src/lucee-base/readme.md
deleted file mode 100644
index 46fa60b..0000000
--- a/src/lucee-base/readme.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Lucee on Jetty lucee-base directory.
-
-For the primary Lucee on Jetty readme, see README.TXT in the parent directory.
-
-This lucee-base directory uses the split jetty-home/jetty-base functionality
-available in Jetty 9, to allow configuration of Lucee against an unmodified
-Jetty instance. For more information on jetty-base see the Jetty documentation
-at http://www.eclipse.org/jetty/documentation/current/startup-base-and-home.html
-
-This file contains information about the following:
-* The structure and purpose of the files and directories here.
-* Jetty and Lucee configurations which have been made.
-
-For more specific information, check for a readme in the relevant directory.
-(If there is no readme, check the Jetty documentation for further details.)
-
-
-## Directories and files
-
- readme.md - this file.
- start.ini - Jetty startup modules & configuration.
- logs - Jetty's log files are created here.
- lucee-server - Lucee's server context and patches go here.
- modules - Additional Jetty module files.
- ~ lucee.mod - Lucee module for Jetty.
- ~ lucee/ - Configuration files for Lucee module.
- ~ lib - Lucee's JAR file.
- ~ etc - Jetty configuration overrides.
- ~ lucee-servlets.xml - Lucee CFML Servlet configuration.
- ~ rewrite-rules.xml - Jetty URL rewrite rules.
- ~ lucee-webapp-common.xml - common configuration for lucee webapp contexts.
- ~ lucee-global-webapp-common.xml - applies common configuration to all contexts.
- resources - Jetty resource files.
- ~ jetty-logging.properties - Jetty logging configuration
- webapps - Jetty looks for webapp contexts here.
- ~ ROOT.xml - the XML config file for the default webapp context.
- webinfs - Lucee's webapp context configuration and log files.
-
-
-## Jetty configuration
-
-* The `start.ini` file lists the relevant built-in modules plus `modules/lucee.mod`
-* The `modules/lucee.mod` file then loads `rewrite-rules.xml` and `lucee-global-webapp-common.xml`
-* The `modules/lucee/etc/rewrite-rules.xml` file rewrites *.cfm to enable path info.
-* The `modules/lucee/etc/lucee-global-webapp-common.xml` file uses an overrideDescriptor in `lucee-webapp-common.xml` to load `lucee-servlets.xml` for every context.
-* The `modules/lucee/etc/lucee-servlets.xml` file maps *.cfm and *.cfc to Lucee's CFMLServlet.
-
-
-## Lucee configuration
-
-* The `lucee-server-directory` parameter is set to use `lucee-base/lucee-server`
-instead of the `lucee-base/lib/ext/lucee-server` default.
-* The `lucee-web-directory` parameter is set to use `lucee-base/webinfs/{web-context-label}`
-instead of `lucee-base/webapps/{context}/WEB-INF/lucee`
diff --git a/src/lucee-base/resources/readme.md b/src/lucee-base/resources/readme.md
deleted file mode 100644
index b5d8b54..0000000
--- a/src/lucee-base/resources/readme.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Lucee on Jetty resources directory.
-
-The primary Lucee on Jetty readme is README.TXT in the top-level directory.
-
-The resources directory is where Jetty looks for logging configuration, in the
-form of either jetty-logging.properties or logging.properties files.
-
-You can read more about logging in the Jetty documentation:
- http://eclipse.org/jetty/documentation/current/configuring-logging.html
-
-The **jetty-logging.properties** file instructs Lucee to use the StdErrLog class
-for its logging, resulting in stdout and stderr being redirected to a log file
-in the lucee-base/logs directory.
\ No newline at end of file
diff --git a/src/lucee-base/webapps/readme.md b/src/lucee-base/webapps/readme.md
deleted file mode 100644
index 54fafd4..0000000
--- a/src/lucee-base/webapps/readme.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# Lucee on Jetty webapps directory.
-
-The primary Lucee on Jetty readme is README.TXT in the top-level directory.
-The default Jetty webapps readme is README.TXT in jetty-home/webapps
-
-This webapps directory is where Jetty WebApp Contexts are located.
-
-There is one context by default - ROOT.xml - which listens on localhost and has
-its resourceBase (webroot) set to the lucee-base/webapps/ROOT directory.
-
-
-## Adding a new context
-
-Create a new XML file from the ROOT.xml, set the resourceBase appropriately, and
-specify the virtual host aliases that the context responds to.
-
-Jetty is configured to automatically deploy new contexts, without needing to
-restart the Jetty server. For details on this, see the Jetty Documentation
-section below.
-
-
-## Adding a virtual host to a context
-
-A context will respond to the hostnames specified in its virtual host aliases
-section. The default ROOT context has been configured to run only on localhost,
-but can be reconfigured if desired.
-
-If a context does not have any virtual hosts configured, it will respond for any
-hostname or IP which points to the machine.
-
-Details on how to configure virtual hosts are available at:
- http://www.eclipse.org/jetty/documentation/current/configuring-virtual-hosts.html
-
-
-## Jetty Documentation
-
-There is a README.txt in jetty-home/webapps which provides some information on
-webapp deployment, or a more complete explanation is available online:
- http://www.eclipse.org/jetty/documentation/current/configuring-deployment.html
diff --git a/src/lucee-base/webinfs/readme.md b/src/lucee-base/webinfs/readme.md
deleted file mode 100644
index eaf917a..0000000
--- a/src/lucee-base/webinfs/readme.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# Lucee on Jetty webinfs directory.
-
-The primary Lucee on Jetty readme is README.TXT in the top-level directory.
-
-This webinfs directory contains the configuration for web contexts which Lucee
-has been enabled for - by default this would be found in a WEB-INF/lucee
-directory in each context's webroot (resourceBase), but this bundle has been
-configured to place them here instead.
-(Configuration is done via the CFMLServlet `lucee-web-directory` parameter in
-the `etc/lucee-servlets.xml` file.)
-
-Each Jetty context that Lucee is enabled for will have its own directory, named
-as the lucee-context-label - this defaults to a unique hash but can be changed
-in Lucee Server Admin.
