Move discovery plugin docs to RDOC and split out advanced parameters

theforeman · Oct 12, 2020 · 08d1d8a · 08d1d8a
1 parent 807b102
commit 08d1d8a
Showing 1 changed file with 11 additions and 9 deletions.
diff --git a/manifests/plugin/discovery.pp b/manifests/plugin/discovery.pp
@@ -1,16 +1,18 @@
-# @summary Install the discovery plugin and images on smart proxies
+# = Foreman Proxy Discovery plugin
 #
-# @param install_images
-#   should the discovery image be downloaded and extracted
+# Install the discovery plugin and images on smart proxies
 #
-# @param tftp_root
-#   tftp root to install image into
+# === Parameters:
 #
-# @param source_url
-#   source URL to download from
+# $install_images::   should the discovery image be downloaded and extracted
 #
-# @param image_name
-#   tarball with images
+# === Advanced parameters:
+#
+# $tftp_root::   tftp root to install image into
+#
+# $source_url::   source URL to download from
+#
+# $image_name::   tarball with images
 #
 class foreman_proxy::plugin::discovery (
   Boolean $install_images = $foreman_proxy::plugin::discovery::params::install_images,