Merge pull request #90 from electric-cloud/adoc

adoc
electric-cloud · Oct 22, 2020 · 1b0f707 · 1b0f707
2 parents 126afc7 + 2b25f37
commit 1b0f707
Show file tree

Hide file tree

Showing 59 changed files with 913 additions and 1,835 deletions.
diff --git a/build.gradle b/build.gradle
@@ -28,7 +28,7 @@ repositories {
 
 group = "com.electriccloud"
 description = "Plugins : EC-OpenStack"
-version = "1.3.5"
+version = "1.3.6"
 
 apply plugin: 'groovy'
 apply plugin: 'flow-gradle-plugin'

diff --git a/help/help.adoc b/help/help.adoc
diff --git a/...s/images/parameters/allocate_ip_panel.png → ...s/images/parameters/allocate-ip-panel.png b/...s/images/parameters/allocate_ip_panel.png → ...s/images/parameters/allocate-ip-panel.png
diff --git a/...mages/parameters/associate_floatingip.png → ...mages/parameters/associate-floatingip.png b/...mages/parameters/associate_floatingip.png → ...mages/parameters/associate-floatingip.png
diff --git a/htdocs/images/parameters/attach_volume.png → htdocs/images/parameters/attach-volume.png b/htdocs/images/parameters/attach_volume.png → htdocs/images/parameters/attach-volume.png
diff --git a/htdocs/images/parameters/cleanup_panel.png → htdocs/images/parameters/cleanup-panel.png b/htdocs/images/parameters/cleanup_panel.png → htdocs/images/parameters/cleanup-panel.png
diff --git a/...es/parameters/cloudmanager_grow_panel.png → ...es/parameters/cloudmanager-grow-panel.png b/...es/parameters/cloudmanager_grow_panel.png → ...es/parameters/cloudmanager-grow-panel.png
diff --git a/.../parameters/cloudmanager_shrink_panel.png → .../parameters/cloudmanager-shrink-panel.png b/.../parameters/cloudmanager_shrink_panel.png → .../parameters/cloudmanager-shrink-panel.png
diff --git a/...es/parameters/cloudmanager_sync_panel.png → ...es/parameters/cloudmanager-sync-panel.png b/...es/parameters/cloudmanager_sync_panel.png → ...es/parameters/cloudmanager-sync-panel.png
diff --git a/...images/parameters/configuration_panel.png → ...images/parameters/configuration-panel.png b/...images/parameters/configuration_panel.png → ...images/parameters/configuration-panel.png
diff --git a/htdocs/images/parameters/create_image.png → htdocs/images/parameters/create-image.png b/htdocs/images/parameters/create_image.png → htdocs/images/parameters/create-image.png
diff --git a/...s/parameters/create_instance_snapshot.png → ...s/parameters/create-instance-snapshot.png b/...s/parameters/create_instance_snapshot.png → ...s/parameters/create-instance-snapshot.png
diff --git a/...cs/images/parameters/create_key_panel.png → ...cs/images/parameters/create-key-panel.png b/...cs/images/parameters/create_key_panel.png → ...cs/images/parameters/create-key-panel.png
diff --git a/htdocs/images/parameters/create_stack.png → htdocs/images/parameters/create-stack.png b/htdocs/images/parameters/create_stack.png → htdocs/images/parameters/create-stack.png
diff --git a/...ges/parameters/create_volume_snapshot.png → ...ges/parameters/create-volume-snapshot.png b/...ges/parameters/create_volume_snapshot.png → ...ges/parameters/create-volume-snapshot.png
diff --git a/htdocs/images/parameters/create_volume.png → htdocs/images/parameters/create-volume.png b/htdocs/images/parameters/create_volume.png → htdocs/images/parameters/create-volume.png
diff --git a/...cs/images/parameters/delete_key_panel.png → ...cs/images/parameters/delete-key-panel.png b/...cs/images/parameters/delete_key_panel.png → ...cs/images/parameters/delete-key-panel.png
diff --git a/htdocs/images/parameters/delete_stack.png → htdocs/images/parameters/delete-stack.png b/htdocs/images/parameters/delete_stack.png → htdocs/images/parameters/delete-stack.png
diff --git a/htdocs/images/parameters/delete_volume.png → htdocs/images/parameters/delete-volume.png b/htdocs/images/parameters/delete_volume.png → htdocs/images/parameters/delete-volume.png
diff --git a/htdocs/images/parameters/deploy_panel.png → htdocs/images/parameters/deploy-panel.png b/htdocs/images/parameters/deploy_panel.png → htdocs/images/parameters/deploy-panel.png
diff --git a/htdocs/images/parameters/detach_volume.png → htdocs/images/parameters/detach-volume.png b/htdocs/images/parameters/detach_volume.png → htdocs/images/parameters/detach-volume.png
diff --git a/htdocs/images/parameters/extend_volume.png → htdocs/images/parameters/extend-volume.png b/htdocs/images/parameters/extend_volume.png → htdocs/images/parameters/extend-volume.png
diff --git a/...cs/images/parameters/release_ip_panel.png → ...cs/images/parameters/release-ip-panel.png b/...cs/images/parameters/release_ip_panel.png → ...cs/images/parameters/release-ip-panel.png
diff --git a/htdocs/images/parameters/teardown_panel.png → htdocs/images/parameters/teardown-panel.png b/htdocs/images/parameters/teardown_panel.png → htdocs/images/parameters/teardown-panel.png
diff --git a/htdocs/images/parameters/update_stack.png → htdocs/images/parameters/update-stack.png b/htdocs/images/parameters/update_stack.png → htdocs/images/parameters/update-stack.png
diff --git a/...s/images/use_cases/Case_1/cleanup_log.png → ...s/images/use-cases/case-1/cleanup-log.png b/...s/images/use_cases/Case_1/cleanup_log.png → ...s/images/use-cases/case-1/cleanup-log.png
diff --git a/...s/use_cases/Case_1/cleanup_parameters.png → ...s/use-cases/case-1/cleanup-parameters.png b/...s/use_cases/Case_1/cleanup_parameters.png → ...s/use-cases/case-1/cleanup-parameters.png
diff --git a/...s/use_cases/Case_1/consume_parameters.png → ...s/use-cases/case-1/consume-parameters.png b/...s/use_cases/Case_1/consume_parameters.png → ...s/use-cases/case-1/consume-parameters.png
diff --git a/...images/use_cases/Case_1/create_config.png → ...images/use-cases/case-1/create-config.png b/...images/use_cases/Case_1/create_config.png → ...images/use-cases/case-1/create-config.png
diff --git a/...cs/images/use_cases/Case_1/deploy_log.png → ...cs/images/use-cases/case-1/deploy-log.png b/...cs/images/use_cases/Case_1/deploy_log.png → ...cs/images/use-cases/case-1/deploy-log.png
diff --git a/...es/use_cases/Case_1/deploy_parameters.png → ...es/use-cases/case-1/deploy-parameters.png b/...es/use_cases/Case_1/deploy_parameters.png → ...es/use-cases/case-1/deploy-parameters.png
diff --git a/htdocs/images/use_cases/Case_1/job.png → htdocs/images/use-cases/case-1/job.png b/htdocs/images/use_cases/Case_1/job.png → htdocs/images/use-cases/case-1/job.png
diff --git a/htdocs/images/use_cases/Case_1/results.png → htdocs/images/use-cases/case-1/results.png b/htdocs/images/use_cases/Case_1/results.png → htdocs/images/use-cases/case-1/results.png
diff --git a/pages/EC-OpenStack_help.xml b/pages/EC-OpenStack_help.xml
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -33,4 +33,7 @@
             <javascript>war/ecplugins.openstack.ConfigurationManagement/ecplugins.openstack.ConfigurationManagement.nocache.js</javascript>
         </component>
     </components>
+    <hasAdoc>true</hasAdoc>
+    <catalogLabel>OpenStack</catalogLabel>
+    <detailedDescription>OpenStack is an Infrastructure as a Service (IaaS) cloud computing project by Rackspace Cloud and NASA. It is free open-source software released under the terms of the Apache License. This plugin allows users to build a cloud by launching images and assigning metadata to instances, providing a more generic interface for managing resources.</detailedDescription>
 </plugin>
diff --git a/src/main/resources/project/ui_forms/allocate.ip.xml b/src/main/resources/project/ui_forms/allocate.ip.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#AllocateIP</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#AllocateIP</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/associate_ip.xml b/src/main/resources/project/ui_forms/associate_ip.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#AssociateFloatingIP</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#AssociateFloatingIP</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/attach_volume.xml b/src/main/resources/project/ui_forms/attach_volume.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#AttachVolume</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#AttachVolume</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/cleanup.xml b/src/main/resources/project/ui_forms/cleanup.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#Cleanup</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#Cleanup</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/create.key.xml b/src/main/resources/project/ui_forms/create.key.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CreateKeyPair</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CreateKeyPair</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/create_image.xml b/src/main/resources/project/ui_forms/create_image.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CreateVolume</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CreateVolume</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/create_instancesnapshot.xml b/src/main/resources/project/ui_forms/create_instancesnapshot.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CreateInstanceSnapshot</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CreateInstanceSnapshot</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/create_stack.xml b/src/main/resources/project/ui_forms/create_stack.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CreateStack</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CreateStack</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/create_volume.xml b/src/main/resources/project/ui_forms/create_volume.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CreateVolume</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CreateVolume</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/create_volumesnapshot.xml b/src/main/resources/project/ui_forms/create_volumesnapshot.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CreateVolumeSnapshot</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CreateVolumeSnapshot</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/delete.key.xml b/src/main/resources/project/ui_forms/delete.key.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#DeleteKeyPair</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#DeleteKeyPair</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/delete_stack.xml b/src/main/resources/project/ui_forms/delete_stack.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#DeleteStack</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#DeleteStack</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/delete_volume.xml b/src/main/resources/project/ui_forms/delete_volume.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#DeleteVolume</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#DeleteVolume</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/deploy.xml b/src/main/resources/project/ui_forms/deploy.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#Deploy</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#Deploy</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/deploy_DE.xml b/src/main/resources/project/ui_forms/deploy_DE.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#_DeployDE</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#_DeployDE</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/detach_volume.xml b/src/main/resources/project/ui_forms/detach_volume.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#DetachVolume</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#DetachVolume</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/extend_volume.xml b/src/main/resources/project/ui_forms/extend_volume.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#ExtendVolume</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#ExtendVolume</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/grow.xml b/src/main/resources/project/ui_forms/grow.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CloudManagerGrow</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CloudManagerGrow</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/reboot.xml b/src/main/resources/project/ui_forms/reboot.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#Reboot</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#Reboot</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/release.ip.xml b/src/main/resources/project/ui_forms/release.ip.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#ReleaseIP</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#ReleaseIP</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/shrink.xml b/src/main/resources/project/ui_forms/shrink.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CloudManagerShrink</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CloudManagerShrink</help>
     <formElement>
         <type>entry</type>
         <label>Configuration:</label>

diff --git a/src/main/resources/project/ui_forms/sync.xml b/src/main/resources/project/ui_forms/sync.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#CloudManagerSync</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#CloudManagerSync</help>
     <formElement>
         <type>entry</type>
         <label>Configuration:</label>

diff --git a/src/main/resources/project/ui_forms/teardown.xml b/src/main/resources/project/ui_forms/teardown.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-  <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#Teardown</help>
+  <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#Teardown</help>
   <formElement>
     <label>Configuration:</label>
     <!-- Improvements for CEV-18687 -->

diff --git a/src/main/resources/project/ui_forms/update_stack.xml b/src/main/resources/project/ui_forms/update_stack.xml
@@ -16,7 +16,7 @@
 
 -->
 <editor>
-    <help>/commander/pages/@PLUGIN_NAME@/@PLUGIN_KEY@_help?s=Administration&amp;ss=Plugins#UpdateStack</help>
+    <help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-openstack#UpdateStack</help>
     <formElement>
         <label>Configuration:</label>
         <!-- Improvements for CEV-18687 -->