refactor: put each guide into its own module instead of using ROOT for everything
This ensures that content is separated properly by Antora when it generates the documentation and
we can link cleanly between different modules.
MODIFY
docs/antora.yml
docs/antora.yml
name: core
-title: Development Guide
+title: Apiman Guides
version: 2.1.0.Final
-start_page: ROOT:development/Guide.adoc
+start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc

MODIFY
docs/modules/ROOT/nav.adoc
docs/modules/ROOT/nav.adoc
-* xref:development/Guide.adoc[Guide]
-** xref:development/Gateway.adoc[Gateway]
-** xref:development/Plugins.adoc[Plugins]
-** xref:development/Resources.adoc[Resources]
\ No newline at end of file
+* xref:migration:migrations.adoc[Migration Guide]
+
+* xref:development:Guide.adoc[Development Guide]
+** xref:development:Guide.adoc#_developer_resources[Developer Resources]
+** xref:development:Guide.adoc#_plugins[Apiman Plugins]
+** xref:development:Guide.adoc#_gateway_implementations[Gateway Implementations]
+

ADD
docs/modules/ROOT/pages/index.adoc
+include::welcome::page$index.adoc[]
\ No newline at end of file

RENAME
docs/modules/ROOT/pages/development/Gateway.adoc
docs/modules/development/pages/Gateway.adoc
RENAME
docs/modules/ROOT/pages/development/Guide.adoc
docs/modules/development/pages/Guide.adoc
Are you interested in contributing to the development of apiman?Maybe you want to embed the
project in your own solution?In either case this is the guide for you.
+[#_developer_resources]
== Developer Resources
This section describes a number of resources that are useful if you wish to contribute
code to apiman.It is likely also a good starting point for those wishing to provide
@@ -13,7 +14,6 @@ be found in the 'Plugins' section.
include::Resources.adoc[]
-
== Architecture
The basic architecture of apiman is fairly straightforward.There are several WARs that
make up the default apiman installation.These include:
@@ -42,6 +42,7 @@ servlet that embeds the apiman Policy Engine. All requests to the API Gateway W
assumed to be intended for managed APIs previously published to it.
+[#_plugins]
== Plugins
The easiest way to extend the functionality of apiman is by implementing an apiman
plugin.This section details how this is done and what functionality can be
@@ -50,6 +51,7 @@ extended or provided.
include::Plugins.adoc[]
+[#_gateway_implementations]
== Gateway Implementations
At the heart of any apiman gateway implementation is the flexible, lightweight
apiman-core.The core serves to execute policies upon the traffic passing through

RENAME
docs/modules/ROOT/pages/development/Plugins.adoc
docs/modules/development/pages/Plugins.adoc
@@ -597,7 +597,7 @@ after a plugin has been selected by a user.
----
.Generated UI Form
-image::plugin-policy-config-1.png[Generated UI Form]
+image::ROOT:plugin-policy-config-1.png[Generated UI Form]
.JSON Configuration Data Format
[source,json]

RENAME
docs/modules/ROOT/pages/development/Resources.adoc
docs/modules/development/pages/Resources.adoc
refactor: put each guide into its own module instead of using ROOT for everything

This ensures that content is separated properly by Antora when it generates the documentation and
we can link cleanly between different modules.