This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch WW-4440-readme in repository https://gitbox.apache.org/repos/asf/struts.git
commit 9c078aef148dcbc69f0ff18702f9223f27680ff8 Author: Lukasz Lenart <[email protected]> AuthorDate: Thu Oct 27 12:53:05 2022 +0200 WW-4440 Adds basic README.md to all submodules --- apps/README.md | 12 ++++++++++++ assembly/README.md | 3 +++ bom/README.md | 20 ++++++++++++++++++++ core/README.md | 6 ++++++ plugins/README.md | 3 +++ plugins/async/README.md | 6 ++++++ plugins/bean-validation/README.md | 7 +++++++ plugins/cdi/README.md | 6 ++++++ plugins/config-browser/README.md | 6 ++++++ plugins/convention/README.md | 6 ++++++ plugins/dwr/README.md | 6 ++++++ plugins/embeddedjsp/README.md | 2 ++ plugins/gxp/README.md | 2 ++ plugins/jasperreports/README.md | 6 ++++++ plugins/javatemplates/README.md | 6 ++++++ plugins/jfreechart/README.md | 6 ++++++ plugins/json/README.md | 6 ++++++ plugins/junit/README.md | 7 +++++++ plugins/osgi/README.md | 2 ++ plugins/oval/README.md | 2 ++ plugins/pell-multipart/README.md | 2 ++ plugins/plexus/README.md | 2 ++ plugins/portlet-mocks/README.md | 2 ++ plugins/portlet-tiles/README.md | 2 ++ plugins/portlet/README.md | 2 ++ plugins/rest/README.md | 7 +++++++ plugins/sitemesh/README.md | 2 ++ plugins/spring/README.md | 6 ++++++ plugins/testng/README.md | 6 ++++++ plugins/tiles/README.md | 6 ++++++ plugins/velocity/README.md | 6 ++++++ 31 files changed, 163 insertions(+) diff --git a/apps/README.md b/apps/README.md new file mode 100644 index 000000000..0036a0d3a --- /dev/null +++ b/apps/README.md @@ -0,0 +1,12 @@ +# Struts 2 Apps +These module consists of two example applications, which were built using the Apache Struts project. +One is an old-fashioned Web application and another is a modern REST based single page app. + +## Installation +Enter a given folder, either `showcase/` or `rest-showcase/` and start the app using Maven: + +``` +mvn jetty:run +``` + +then open your browser at http://localhost:8080 and navigate to a proper context. diff --git a/assembly/README.md b/assembly/README.md new file mode 100644 index 000000000..2bcd93d08 --- /dev/null +++ b/assembly/README.md @@ -0,0 +1,3 @@ +# Struts 2 Assemblies +This module is used to prepare ZIP archives with different set of JARs, like code source, Javadocs, etc. +It's a part of the release process, it shouldn't be used directly by users. diff --git a/bom/README.md b/bom/README.md new file mode 100644 index 000000000..02bacfe8d --- /dev/null +++ b/bom/README.md @@ -0,0 +1,20 @@ +# Struts 2 BOM +This is a Bill-Of-Materials to be used with Maven based project. It allows to import all the Struts 2 +dependencies at once and used them in your project where needed. + +## Installation +You must add a proper import statement into your `pom.xml` as presented below: + +```xml +<dependencyManagement> + <dependencies> + <dependency> + <groupId>org.apache.struts</groupId> + <artifactId>struts2-bom</artifactId> + <version>${struts2.version}</version> + <type>pom</type> + <scope>import</scope> + </dependency> + </dependencies> +</dependencyManagement> +``` diff --git a/core/README.md b/core/README.md new file mode 100644 index 000000000..0d10dcbc9 --- /dev/null +++ b/core/README.md @@ -0,0 +1,6 @@ +# Struts 2 Core +This is a core of the Apache Struts framework and all other modules depend on it. +It requires Java 8 at minimum and a Servlet container supporting Java Servlet API 3.1 at least. + +## Installation +Just drop this plugin into `WEB-INF/lib` folder or add it as Maven dependency diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 000000000..ac7306895 --- /dev/null +++ b/plugins/README.md @@ -0,0 +1,3 @@ +# Struts 2 Plugins +A set of officially supported plugins which are provided with the framework, you can read more about them +in the [documentation](https://struts.apache.org/plugins/). diff --git a/plugins/async/README.md b/plugins/async/README.md new file mode 100644 index 000000000..19f91e70d --- /dev/null +++ b/plugins/async/README.md @@ -0,0 +1,6 @@ +# Struts 2 Async plugin +This plugin add support for async actions which can be used since Servlet API 3.0 +(lack of documentation!!!) + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency diff --git a/plugins/bean-validation/README.md b/plugins/bean-validation/README.md new file mode 100644 index 000000000..d1d532c25 --- /dev/null +++ b/plugins/bean-validation/README.md @@ -0,0 +1,7 @@ +# Struts 2 Bean Validation plugin +This plugin add support for using the Bean Validation API instead of the built-in native Struts 2 validation logic. +You will find more details in [documentation](https://struts.apache.org/plugins/bean-validation/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. You must also provide +a proper implementation of the Bean Validation API, eg.: [Hibernate Bean Validation](https://hibernate.org/validator/) diff --git a/plugins/cdi/README.md b/plugins/cdi/README.md new file mode 100644 index 000000000..2c6e33617 --- /dev/null +++ b/plugins/cdi/README.md @@ -0,0 +1,6 @@ +# Struts 2 CDI plugin +This plugin add support for using the Contexts and Dependency Injection (CDI) API with your Struts actions. +You will find more details in [documentation](https://struts.apache.org/plugins/cdi/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/config-browser/README.md b/plugins/config-browser/README.md new file mode 100644 index 000000000..b29539b38 --- /dev/null +++ b/plugins/config-browser/README.md @@ -0,0 +1,6 @@ +# Struts 2 Config Browser plugin +This plugin allows to browse configuration of Struts in your application. **It shouldn't be used in production**! +You will find more details in [documentation](https://struts.apache.org/plugins/config-browser/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/convention/README.md b/plugins/convention/README.md new file mode 100644 index 000000000..b9a6a7c19 --- /dev/null +++ b/plugins/convention/README.md @@ -0,0 +1,6 @@ +# Struts 2 Convention plugin +This plugin allows to use _convention over configuration_ approach instead of configuring everything using `struts.xml`. +You will find more details in [documentation](https://struts.apache.org/plugins/convention/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/dwr/README.md b/plugins/dwr/README.md new file mode 100644 index 000000000..dc0c30a37 --- /dev/null +++ b/plugins/dwr/README.md @@ -0,0 +1,6 @@ +# Struts 2 Direct Web Remoting (DWR) plugin +This plugin allows to use Struts validation via DWR as remote beans. +You will find more details in [documentation](https://struts.apache.org/plugins/dwr/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/embeddedjsp/README.md b/plugins/embeddedjsp/README.md new file mode 100644 index 000000000..7064762e2 --- /dev/null +++ b/plugins/embeddedjsp/README.md @@ -0,0 +1,2 @@ +# Struts 2 EmbeddedJSP plugin +This plugin is deprecated and it will be removed soon, **please do not use it**! diff --git a/plugins/gxp/README.md b/plugins/gxp/README.md new file mode 100644 index 000000000..42c813027 --- /dev/null +++ b/plugins/gxp/README.md @@ -0,0 +1,2 @@ +# Struts 2 GXP plugin +This plugin is deprecated and it will be removed soon, **please do not use it**! diff --git a/plugins/jasperreports/README.md b/plugins/jasperreports/README.md new file mode 100644 index 000000000..a43d9cf0d --- /dev/null +++ b/plugins/jasperreports/README.md @@ -0,0 +1,6 @@ +# Struts 2 Direct Web Remoting (DWR) plugin +This plugin allows to use Jasper reports as a one of the result types. +You will find more details in [documentation](https://struts.apache.org/plugins/jasperreports/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/javatemplates/README.md b/plugins/javatemplates/README.md new file mode 100644 index 000000000..9c670c56c --- /dev/null +++ b/plugins/javatemplates/README.md @@ -0,0 +1,6 @@ +# Struts 2 Java Templates plugin +This plugin provides a faster Java implementation of tags in the `simple` theme. +You will find more details in [documentation](https://struts.apache.org/plugins/javatemplates/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/jfreechart/README.md b/plugins/jfreechart/README.md new file mode 100644 index 000000000..92881663f --- /dev/null +++ b/plugins/jfreechart/README.md @@ -0,0 +1,6 @@ +# Struts 2 JFreeChart plugin +The JFreeChart plugin allows Actions to easily return generated charts and graphs. +You will find more details in [documentation](https://struts.apache.org/plugins/jfreechart/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/json/README.md b/plugins/json/README.md new file mode 100644 index 000000000..c384bedfe --- /dev/null +++ b/plugins/json/README.md @@ -0,0 +1,6 @@ +# Struts 2 JFreeChart plugin +The JSON plugin provides a json result type that serializes actions into JSON. +You will find more details in [documentation](https://struts.apache.org/plugins/json/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/junit/README.md b/plugins/junit/README.md new file mode 100644 index 000000000..d0d0e5464 --- /dev/null +++ b/plugins/junit/README.md @@ -0,0 +1,7 @@ +# Struts 2 JFreeChart plugin +The JUnit Plugin supports testing actions within a Struts invocation, meaning that a full request is simulated, +and the output of the action can be tested. +You will find more details in [documentation](https://struts.apache.org/plugins/junit/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/osgi/README.md b/plugins/osgi/README.md new file mode 100644 index 000000000..c99dbc39f --- /dev/null +++ b/plugins/osgi/README.md @@ -0,0 +1,2 @@ +# Struts 2 OSGi plugin +This plugin is deprecated and it will be removed soon, **please do not use it**! diff --git a/plugins/oval/README.md b/plugins/oval/README.md new file mode 100644 index 000000000..735e75e27 --- /dev/null +++ b/plugins/oval/README.md @@ -0,0 +1,2 @@ +# Struts 2 OVal plugin +This plugin is deprecated and it will be removed soon, **please do not use it**! diff --git a/plugins/pell-multipart/README.md b/plugins/pell-multipart/README.md new file mode 100644 index 000000000..0372995e8 --- /dev/null +++ b/plugins/pell-multipart/README.md @@ -0,0 +1,2 @@ +# Struts 2 Pell Multipart plugin +This plugin is deprecated and it will be removed soon, **please do not use it**! diff --git a/plugins/plexus/README.md b/plugins/plexus/README.md new file mode 100644 index 000000000..090ecb849 --- /dev/null +++ b/plugins/plexus/README.md @@ -0,0 +1,2 @@ +# Struts 2 Plexus plugin +This plugin is deprecated and it will be removed soon, **please do not use it**! diff --git a/plugins/portlet-mocks/README.md b/plugins/portlet-mocks/README.md new file mode 100644 index 000000000..550476204 --- /dev/null +++ b/plugins/portlet-mocks/README.md @@ -0,0 +1,2 @@ +# Struts 2 Portlet Mocks plugin +This plugin is deprecated, and it will be removed soon, **please do not use it**! diff --git a/plugins/portlet-tiles/README.md b/plugins/portlet-tiles/README.md new file mode 100644 index 000000000..5cff1590b --- /dev/null +++ b/plugins/portlet-tiles/README.md @@ -0,0 +1,2 @@ +# Struts 2 Portlet Tiles plugin +This plugin is deprecated, and it will be removed soon, **please do not use it**! diff --git a/plugins/portlet/README.md b/plugins/portlet/README.md new file mode 100644 index 000000000..69958edb0 --- /dev/null +++ b/plugins/portlet/README.md @@ -0,0 +1,2 @@ +# Struts 2 Portlet plugin +This plugin is deprecated, and it will be removed soon, **please do not use it**! diff --git a/plugins/rest/README.md b/plugins/rest/README.md new file mode 100644 index 000000000..8553dec90 --- /dev/null +++ b/plugins/rest/README.md @@ -0,0 +1,7 @@ +# Struts 2 REST plugin +The REST Plugin provides high level support for the implementation of RESTful resource based web applications +with the Convention Plugin. +You will find more details in [documentation](https://struts.apache.org/plugins/rest/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/sitemesh/README.md b/plugins/sitemesh/README.md new file mode 100644 index 000000000..b11ca91e9 --- /dev/null +++ b/plugins/sitemesh/README.md @@ -0,0 +1,2 @@ +# Struts 2 Sitemesh plugin +This plugin is deprecated, and it will be removed soon, **please do not use it**! diff --git a/plugins/spring/README.md b/plugins/spring/README.md new file mode 100644 index 000000000..fbaf2781e --- /dev/null +++ b/plugins/spring/README.md @@ -0,0 +1,6 @@ +# Struts 2 Spring plugin +The Spring Plugin works by overriding the Struts ObjectFactory to enhance the creation of core framework objects +You will find more details in [documentation](https://struts.apache.org/plugins/spring/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/testng/README.md b/plugins/testng/README.md new file mode 100644 index 000000000..ac8faa03f --- /dev/null +++ b/plugins/testng/README.md @@ -0,0 +1,6 @@ +# Struts 2 TestNG plugin +The TestNG plugin provides integration with the popular TestNG unit testing framework. +You will find more details in [documentation](https://struts.apache.org/plugins/testng/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/tiles/README.md b/plugins/tiles/README.md new file mode 100644 index 000000000..41a4fbe28 --- /dev/null +++ b/plugins/tiles/README.md @@ -0,0 +1,6 @@ +# Struts 2 Tiles plugin +The Tiles plugin allows actions to return Tiles pages. +You will find more details in [documentation](https://struts.apache.org/plugins/tiles/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. diff --git a/plugins/velocity/README.md b/plugins/velocity/README.md new file mode 100644 index 000000000..3b27875eb --- /dev/null +++ b/plugins/velocity/README.md @@ -0,0 +1,6 @@ +# Struts 2 Velocity plugin +The Tiles plugin allows actions to return Tiles pages. +You will find more details in [documentation](https://struts.apache.org/plugins/velocity/). + +## Installation +Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
