From b7c4afa7afb95a0637d369df9a8f3e77834106cc Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Tue, 12 Oct 2021 00:16:48 +0200
Subject: [PATCH] sysutils/puppet-agent: add introduction page

---
 sysutils/puppet-agent/pkg-descr               |  1 +
 .../app/views/OPNsense/PuppetAgent/index.volt | 51 +++++++++++++------
 2 files changed, 37 insertions(+), 15 deletions(-)

diff --git a/sysutils/puppet-agent/pkg-descr b/sysutils/puppet-agent/pkg-descr
index 959369790..64ec7afe9 100644
--- a/sysutils/puppet-agent/pkg-descr
+++ b/sysutils/puppet-agent/pkg-descr
@@ -13,6 +13,7 @@ Plugin Changelog
 
 Added:
 * add log file
+* add introduction page
 
 0.1
 
diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/views/OPNsense/PuppetAgent/index.volt b/sysutils/puppet-agent/src/opnsense/mvc/app/views/OPNsense/PuppetAgent/index.volt
index 10b93ddf7..7e0d533c5 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/views/OPNsense/PuppetAgent/index.volt
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/views/OPNsense/PuppetAgent/index.volt
@@ -1,5 +1,6 @@
 {#
 
+OPNsense® is Copyright © 2021 Frank Wall
 OPNsense® is Copyright © 2021 Jan Winkler
 OPNsense® is Copyright © 2014 – 2015 by Deciso B.V.
 All rights reserved.
@@ -47,20 +48,40 @@ POSSIBILITY OF SUCH DAMAGE.
     });
 </script>
 
-<div class="alert alert-info hidden" role="alert" id="responseMsg">
+<ul class="nav nav-tabs" role="tablist" id="maintabs">
+    <li class="active"><a data-toggle="tab" id="settings-introduction" href="#subtab_settings-introduction"><b>{{ lang._('Introduction') }}</b></a></li>
+    <li><a data-toggle="tab" id="settings-tab" href="#settings"><b>{{ lang._('Settings') }}</b></a></li>
+</ul>
+
+<div class="content-box tab-content">
+
+    <div id="subtab_settings-introduction" class="tab-pane fade in active">
+        <div class="col-md-12">
+            <h1>{{ lang._('Quick Start Guide') }}</h1>
+            <p>{{ lang._("Welcome to the Puppet Agent plugin! This plugin allows you to integrate OPNsense with your Puppet environment.") }}</p>
+            <p>{{ lang._("Keep in mind that you should not treat OPNsense like any other operating system. Most notably you should not modify system files or packages. Instead use the OPNsense API to make configuration changes and to manage plugins. The following tools are a good starting point when trying to automate OPNsense with Puppet:") }}</p>
+            <ul>
+              <li>{{ lang._("%sopn-cli:%s A command line client to configure OPNsense core and plugin components through their respective APIs.") | format('<a href="https://github.com/andeman/opn-cli" target="_blank">', '</a>') }}</li>
+              <li>{{ lang._("%spuppet/opnsense:%s A read-to-use Puppet module for automating the OPNsense firewall.") | format('<a href="https://github.com/andeman/puppet-opnsense" target="_blank">', '</a>') }}</li>
+            </ul>
+            <p>{{ lang._("Note that these tools are not directly related to this plugin. Please report issues and missing features directly to the author.") }}</p>
+        </div>
+    </div>
+
+    <div id="settings" class="tab-pane fade">
+        {{ partial("layout_partials/base_form",['fields':generalForm,'id':'frm_GeneralSettings'])}}
+
+        <div class="col-md-12">
+            <hr/>
+            <button class="btn btn-primary"  id="saveAct"
+                data-endpoint='/api/puppetagent/service/reconfigure'
+                data-label="{{ lang._('Save') }}"
+                data-service-widget="puppetagent"
+                data-error-title="{{ lang._('Error reconfiguring puppetagent') }}"
+                type="button">
+            </button>
+            <br/>
+        </div>
+    </div>
 
 </div>
-
-<div  class="col-md-12">
-    {{ partial("layout_partials/base_form",['fields':generalForm,'id':'frm_GeneralSettings'])}}
-</div>
-
-<div class="col-md-12">
-    <button class="btn btn-primary"  id="saveAct"
-        data-endpoint='/api/puppetagent/service/reconfigure'
-        data-label="{{ lang._('Save') }}"
-        data-service-widget="puppetagent"
-        data-error-title="{{ lang._('Error reconfiguring puppetagent') }}"
-        type="button"
-    ></button>
-</div>