Issue #3897 add image example to contribution guide

jetty · Jul 22, 2019 · e1f2073 · e1f2073
1 parent e016d6a
commit e1f2073
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 12 deletions.
diff --git a/jetty-documentation/src/main/asciidoc/contribution-guide/4-documentation.adoc b/jetty-documentation/src/main/asciidoc/contribution-guide/4-documentation.adoc
@@ -142,6 +142,14 @@ This is a test to link to link:{DISTGUIDE}[Distribution Guide]
 
 This is a test to deep link to link:{DISTGUIDE}#startup[Distribution Guide Deep Link]
 
+images::
+  Images are placed in the `/images*` directory of the guide they should appear in and then referenced with a `image:` tag.
+
+....
+image:small_powered_by.gif
+....
+
+image:small_powered_by.gif
 
 version differences::
   In general differences in functionality within a release should go into nested sections and use titles like 'Prior to: ##' or 'In version: ##'.

diff --git a/...-documentation/src/main/asciidoc/contribution-guide/images/small_powered_by.gif b/...-documentation/src/main/asciidoc/contribution-guide/images/small_powered_by.gif
diff --git a/jetty-documentation/src/main/asciidoc/contribution-guide/index.adoc b/jetty-documentation/src/main/asciidoc/contribution-guide/index.adoc
@@ -23,10 +23,9 @@
 :revdate: {TIMESTAMP}
 :toc: left
 :toc-title: Contribution Guide
-:toc-image: jetty-logo.svg
+:toc-image: ../common/images/jetty-logo.svg
 :toc-image-url: /jetty/index.html
 
-:imagesdir: ../common/images
 
 // docinfo lets you pull in shared content and/or influence via render type
 //:docinfodir: {DOCINFODIR}/documentation

diff --git a/.../asciidoc/distribution-guide/configuring/deploying/deployment-architecture.adoc b/.../asciidoc/distribution-guide/configuring/deploying/deployment-architecture.adoc
@@ -27,7 +27,7 @@ The Jetty distribution contains example `DeploymentManager` configurations to de
 
 The `DeploymentManager` is the heart of the typical webapp deployment mechanism; it operates as a combination of an Application LifeCycle Graph, Application Providers that find and provide Applications into the Application LifeCycle Graph, and a set of bindings in the graph that control the deployment process.
 
-image:images/Jetty_DeployManager_DeploymentManager_Roles.png[image,width=195]
+image:Jetty_DeployManager_DeploymentManager_Roles.png[image,width=195]
 
 [[udm-application-providers]]
 ==== Application Providers
@@ -40,7 +40,7 @@ The main `AppProvider` with the Jetty distribution is the link:{JDURL}/org/eclip
 
 The core feature of the `DeploymentManager` is the link:{JDURL}/org/eclipse/jetty/deploy/AppLifeCycle.html[Application LifeCycle Graph].
 
-image:images/Jetty_DeployManager_AppLifeCycle-1.png[image,width=340]
+image:Jetty_DeployManager_AppLifeCycle-1.png[image,width=340]
 
 The nodes and edges of this graph are pre-defined in Jetty along the most common actions and states found.
 These nodes and edges are not hardcoded; they can be adjusted and added to depending on need (for example, any complex requirements for added workflow, approvals, staging, distribution, coordinated deploys for a cluster or cloud, etc.).
@@ -68,7 +68,7 @@ There are four default bindings:
 * link:{JDURL}/org/eclipse/jetty/deploy/bindings/StandardStopper.html[`StandardStopper`] — Stops the ContextHandler and stops accepting incoming requests.
 * link:{JDURL}/org/eclipse/jetty/deploy/bindings/StandardUndeployer.html[`StandardUndeployer`] — Removes the ContextHandler from Jetty.
 
-image:images/Jetty_DeployManager_DefaultAppLifeCycleBindings.png[image,width=851]
+image:Jetty_DeployManager_DefaultAppLifeCycleBindings.png[image,width=851]
 
 A fifth, non-standard binding, called link:{JDURL}/org/eclipse/jetty/deploy/bindings/DebugBinding.html[DebugBinding], is also available for debugging reasons; it logs the various transitions through the Application LifeCycle.
 

diff --git a/...es/Jetty_DeployManager_AppLifeCycle-1.png → ...es/Jetty_DeployManager_AppLifeCycle-1.png b/...es/Jetty_DeployManager_AppLifeCycle-1.png → ...es/Jetty_DeployManager_AppLifeCycle-1.png
diff --git a/...oyManager_DefaultAppLifeCycleBindings.png → ...oyManager_DefaultAppLifeCycleBindings.png b/...oyManager_DefaultAppLifeCycleBindings.png → ...oyManager_DefaultAppLifeCycleBindings.png
diff --git a/...DeployManager_DeploymentManager_Roles.png → ...DeployManager_DeploymentManager_Roles.png b/...DeployManager_DeploymentManager_Roles.png → ...DeployManager_DeploymentManager_Roles.png
diff --git a/jetty-documentation/src/main/asciidoc/distribution-guide/index.adoc b/jetty-documentation/src/main/asciidoc/distribution-guide/index.adoc
@@ -23,10 +23,9 @@
 :revdate: {TIMESTAMP}
 :toc: left
 :toc-title: Administration Guide
-:toc-image: jetty-logo.svg
+:toc-image: ../common/images/jetty-logo.svg
 :toc-image-url: /jetty/index.html
-
-:imagesdir: ../common/images
+
 
 // docinfo lets you pull in shared content and/or influence via render type
 //:docinfodir: {DOCINFODIR}/documentation
@@ -77,4 +76,4 @@ include::configuring/deploying/chapter.adoc[]
 include::configuring/contexts/chapter.adoc[]
 include::configuring/connectors/chapter.adoc[]
 include::configuring/security/chapter.adoc[]
-include::configuring/jsp/chapter.adoc[]
+include::configuring/jsp/chapter.adoc[]
diff --git a/jetty-documentation/src/main/asciidoc/quickstart-guide/index.adoc b/jetty-documentation/src/main/asciidoc/quickstart-guide/index.adoc
@@ -23,11 +23,9 @@
 :revdate: {TIMESTAMP}
 :toc: left
 :toc-title: Quickstart Guide
-:toc-image: jetty-logo.svg
+:toc-image: ../common/images/jetty-logo.svg
 :toc-image-url: /jetty/index.html
 
-:imagesdir: ../common/images
-
 // docinfo lets you pull in shared content and/or influence via render type
 //:docinfodir: {DOCINFODIR}/documentation
 //:docinfo1: