Merge pull request #28 from flexera-public/ADD_DOC_LINK

Add doc_link to Lessons

Author: XOmniverse

.dangerfile/policy_parser.rb

@@ -1,7 +1,7 @@
 class PolicyParser
   DEFINITION_REGEX = /^[[:blank:]]*define[[:blank:]]*([\w_\.]+)[[:blank:]]*\([@$\w _,]*\)[[:blank:]]*.*do/.freeze
 
-  attr_reader :parsed_info,  :parsed_category, :parsed_name, :parsed_severity, :parsed_long_description, :parsed_short_description, :parsed_default_frequency
+  attr_reader :parsed_info, :parsed_category, :parsed_name, :parsed_severity, :parsed_doc_link, :parsed_long_description, :parsed_short_description, :parsed_default_frequency
 
   def parse(file)
     source = File.read(file)
@@ -28,6 +28,10 @@ def severity(severity)
     @parsed_severity = severity
   end
 
+  def doc_link(doc_link)
+    @parsed_doc_link = doc_link
+  end
+
   def long_description(long_description)
     @parsed_long_description = long_description
   end

exercises/01_summation/solution/summation.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Sum of Two Numbers"
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/exercises/01_summation"
 category "Tutorial"
 severity "low"
 default_frequency "weekly"

exercises/02_tutorial_templates/solution/tutorial_templates.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Lists all tutorial policy templates."
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/exercises/02_tutorial_templates"
 severity "low"
 category "Tutorial"
 default_frequency "weekly"

exercises/03_employees/solution/employees.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Lists all employees, their teams, their departments, and their department heads."
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/exercises/03_employees"
 severity "low"
 category "Tutorial"
 default_frequency "weekly"

exercises/04_departments/solution/departments.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Lists all departments, including employee count and budgets."
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/exercises/04_departments"
 severity "low"
 category "Tutorial"
 default_frequency "weekly"

exercises/05_employees_table/solution/employees_table.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Lists all employees, their teams, their departments, and their department heads."
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/exercises/05_employees_table"
 severity "low"
 category "Tutorial"
 default_frequency "weekly"

lessons/02_hello_world/README.md

@@ -18,6 +18,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Hello World"
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/lessons/02_hello_world"
 category "Tutorial"
 severity "low"
 default_frequency "weekly"
@@ -33,6 +34,7 @@ To briefly go over what each of these defines:
 * `type` simply indicates that this is a policy template and should always be set to "policy"
 * `short_description` is a brief description of what the policy template does. This will appear in Flexera One underneath the name when the policy template is uploaded.
 * `long_description` is defunct and should always be an empty string.
+* `doc_link` contains a link to documentation for the policy template. In this case, we're linking to this lesson.
 * `category` is the category of the policy template. In most cases, this will be something like "Cost", "Compliance", "Security", etc.
 * `severity` is the default severity level of any incidents raised by the policy template.
 * `default_frequency` is the default schedule for the policy template to execute.

lessons/02_hello_world/solution/hello_world.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Hello World"
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/lessons/02_hello_world"
 category "Tutorial"
 severity "low"
 default_frequency "weekly"

lessons/03_parameters/solution/hello_world.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Hello World"
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/lessons/02_hello_world"
 category "Tutorial"
 severity "low"
 default_frequency "weekly"

lessons/04_escalations/solution/hello_world.pt

@@ -3,6 +3,7 @@ rs_pt_ver 20180301
 type "policy"
 short_description "Hello World"
 long_description ""
+doc_link "https://github.com/flexera-public/policy_engine_training/tree/main/lessons/02_hello_world"
 category "Tutorial"
 severity "low"
 default_frequency "weekly"