Script metadata work

Author: agnetemoos

_config.yml

@@ -35,6 +35,7 @@ defaults:
       layout: "docs"
       submodules:
         - "/assets/os2borgerpc-scripts/"
+        - "/docs/scripts/core_scripts/"
 
 
 translations:

_includes/script_metadata.html

@@ -1,7 +1,7 @@
 {% if page.source %}
   <p><strong>Source:</strong>
-    <a href="{{ page.source | relative_url }}" target="_blank">Download script</a>
-    <button onclick="copyToClipboard('{{ page.source | relative_url }}')">Copy to Clipboard</button>
+    <a href="{% script_url %}" target="_blank">Download script</a>
+    <button onclick="copyToClipboard('{% script_url %}')">Copy to Clipboard</button>
   </p>
 
   <p><strong>Last Updated:</strong> {% last_modified_at %}</p>

_plugins/last_modified_at.rb

@@ -10,18 +10,29 @@ def render(context)
       # Access frontmatter variables
       site_source = context.registers[:site].source
       page = context.registers[:page]
+      page_url = page['url']
       source = page['source']
       submodules = page['submodules']
+      submodule = ""
+
+      if submodules
+        submodules.each do |sub|
+          if page_url.include?(sub)
+            submodule = sub
+          end
+        end
+      end
+
+      # Concatenate submodule and source
+      concatenated_path = submodule + source
 
       # Script-repos are accesible as submodules
       # Locate the root of the submodule and the relative path to the script
-      submodule_path, script_path = find_submodule_path(submodules, source)
-
       # Use ruby-git to access the git log of the submodule
-      if submodule_path
-        submodule_source = File.join(site_source, submodule_path)
+      if submodule
+        submodule_source = File.join(site_source, submodule)
         submodule_repo = Git.open(submodule_source)
-        log = submodule_repo.log.path(script_path).first
+        log = submodule_repo.log.path(source).first
 
         if log
           formatted_date = log.date.strftime("%-d. %B %Y")
@@ -34,19 +45,6 @@ def render(context)
       puts "Debug: Error - #{e.message}"
       "Unknown"
     end
-
-    private
-
-    def find_submodule_path(submodules, source)
-      submodules.each do |submodule|
-        if source.include?(submodule)
-          script_path = source.split(submodule, 2).last
-          return submodule, script_path
-        end
-      end
-      [nil, nil]
-    end
-
   end
 end
 

_plugins/read_script_content.rb

@@ -8,9 +8,23 @@ def render(context)
       # Access frontmatter variables
       site_source = context.registers[:site].source
       page = context.registers[:page]
+      page_url = page['url']
       source = page['source']
+      submodules = page['submodules']
+      submodule = ""
 
-      file_path = File.join(site_source, source)
+      if submodules
+        submodules.each do |sub|
+          if page_url.include?(sub)
+            submodule = sub
+          end
+        end
+      end
+
+      # Concatenate submodule and source
+      concatenated_path = submodule + source
+
+      file_path = File.join(site_source, concatenated_path)
       if File.exist?(file_path)
         File.read(file_path)
       else

_plugins/script_url.rb

@@ -0,0 +1,35 @@
+module Jekyll
+  class ScriptUrlTag < Liquid::Tag
+    def initialize(tag_name, _text, tokens)
+      super
+    end
+
+    def render(context)
+      # Access frontmatter variables
+      site_source = context.registers[:site].source
+      page = context.registers[:page]
+      page_url = page['url']
+      source = page['source']
+      submodules = page['submodules']
+      submodule = ""
+
+      if submodules
+        submodules.each do |sub|
+          if page_url.include?(sub)
+            submodule = sub
+          end
+        end
+      end
+
+      # Concatenate submodule and source
+      concatenated_path = submodule + source
+
+      # Use the relative_url filter
+      relative_url = Liquid::Template.parse("{{ '#{concatenated_path}' | relative_url }}").render(context)
+
+      relative_url
+    end
+  end
+end
+
+Liquid::Template.register_tag('script_url', Jekyll::ScriptUrlTag)

docs/scripts/22_04_opgradering/index.md

@@ -1,6 +1,6 @@
 ---
 title: "Opgradering til 22.04"
-parent: Scripts
+parent: Script bibliotek
 summary: |
          Opgrader BorgerPC og Kiosk maskiner fra Ubuntu 20.04 til 22.04 via scripts.
 ---

docs/scripts/browser/index.md

@@ -1,5 +1,5 @@
 ---
 title: Browser
-parent: Scripts
+parent: Script bibliotek
 ---
 Browser

docs/scripts/core_scripts

@@ -1,5 +1,5 @@
 ---
 title: Desktop
-parent: Scripts
+parent: Script bibliotek
 ---
 Desktop

docs/scripts/desktop/index.md

@@ -1,5 +1,5 @@
 ---
 title: Fejlfinding
-parent: Scripts
+parent: Script bibliotek
 ---
 Fejlfinding

docs/scripts/fejlfinding/index.md

@@ -1,4 +1,4 @@
 ---
-title: Scripts
+title: Script bibliotek
 ---
-Scripts
+Script bibliotek

docs/scripts/index.md

@@ -1,5 +1,5 @@
 ---
 title: Login
-parent: Scripts
+parent: Script bibliotek
 ---
 Login

docs/scripts/login/index.md

@@ -1,5 +1,5 @@
 ---
 title: Lyd
-parent: Scripts
+parent: Script bibliotek
 ---
 Lyd

docs/scripts/lyd/index.md

@@ -1,5 +1,5 @@
 ---
 title: Kiosk
-parent: Scripts
+parent: Script bibliotek
 ---
 OS2BorgerPC Kiosk

docs/scripts/os2borgerpc_kiosk/index.md

@@ -1,5 +1,5 @@
 ---
 title: Printer
-parent: Scripts
+parent: Script bibliotek
 ---
 Printer

docs/scripts/printer/index.md

@@ -1,5 +1,5 @@
 ---
 title: Programmer
-parent: Scripts
+parent: Script bibliotek
 ---
 Programmer

docs/scripts/programmer/index.md

@@ -1,5 +1,5 @@
 ---
 title: Sikkerhed
-parent: Scripts
+parent: Script bibliotek
 ---
 Sikkerhed

docs/scripts/sikkerhed/index.md

@@ -1,5 +1,5 @@
 ---
 title: Skanner
-parent: Scripts
+parent: Script bibliotek
 ---
 Skanner

docs/scripts/skanner/index.md

@@ -1,5 +1,5 @@
 ---
 title: System
-parent: Scripts
+parent: Script bibliotek
 ---
 System

docs/scripts/system/index.md

@@ -1,5 +1,5 @@
 ---
 title: Udfases
-parent: Scripts
+parent: Script bibliotek
 ---
 Udfases

docs/scripts/udfases/index.md

@@ -1,4 +1,5 @@
 ---
 title: Admin Site
+parent: Teknisk dokumentation
 ---
 Admin Site

docs/admin_site/Governancerapport.md renamed to docs/teknisk dokumentation/admin_site/Governancerapport.md

@@ -0,0 +1,5 @@
+---
+title: Core scripts
+parent: Teknisk dokumentation
+---
+Core scripts er de 

docs/admin_site/index.md renamed to docs/teknisk dokumentation/admin_site/index.md

@@ -0,0 +1,4 @@
+---
+title: Teknisk dokumentation
+---
+Teknisk dokumentation

docs/admin_site/technical_documentation.md renamed to docs/teknisk dokumentation/admin_site/technical_documentation.md

@@ -0,0 +1,45 @@
+---
+title: Script metadata syntax
+parent: Teknisk dokumentation
+---
+
+Each OS2borgerpc script must have a corresponding metadata-file. 
+
+The metadata-file is needed:
+- to load scripts into the admin-site
+- to generate the script library documentation. 
+
+The metadata is stored in the Markdown format with a [front matter](https://jekyllrb.com/docs/front-matter/) section at the beginning. The front matter section must contain a set of variables in a YAML format.
+
+## Markdown document requirements
+The metadata document is a text file with an .md extension written in Markdown. Using the same name for the metadata-file and the script is a good idea, but not required. (F. ex. `reboot_now.md` ~ `reboot_now.sh`) 
+
+At the top of the metadata-file there must be a front matter section containg a set of variables in the YAML format. A front matter section starts and ends with three dashes:
+```
+---
+# Here goes the YAML
+---
+```
+
+Below the front matter section you must provide a script description written using standard Markdown syntax. 
+
+Please include:
+- the use case for the script
+- any technical limitations or issues
+- dependencies on other scripts
+- partners who have contributed to writing or testing the script
+
+## YAML section requirements
+Script metadata variables
+
+| Variable      | Description                                                  | Required |
+| ------------- | ------------------------------------------------------------ | --------- |
+| `title`         | The title of the script.                                      | Required |
+| `parent`        | The script category. There can be only one. Supported values are: `Browser`, `Desktop`, `Fejlfinding`, `Kiosk`, `Login`, `Lyd`, `Opgradering`, `Printer`, `Programmer`, `Sikkerhed`, `Skanner`, `System`, `Udfases`| Required |
+| `source`        | The relative path to the script-file (.sh/.py) from the metadata-file.              | Required |
+| `parameters`    | The list of parameters that the script expects to receive.  <br> Each parameter is described by an array of 4 key/value pairs. <br> - `name`: The name of the parameter<br>   - `type`: Supported values are `boolean`, `string`, `int`, `text_field`, `file`, `password`<br>  - `default`: Default value of the parameter. `null` if none.<br>   - `mandatory`: Required parameter? `true` or `false`  <br>  If the script expects leave the parameters-variable empty.      | Required |
+| `compatibility` | Info about image and version compatibility. Supported values are: `20.04`, `22.04`, `24.04`, `BorgerPC` and `Kiosk`. More than one value can be supplied.| Optional  |
+| `nav_exclude`   | Should always be set to `true`. Needed by Just the docs for desired rendering. | Required |
+|`in_image`| Sometimes scripts get absorbed by the images, meaning that the script functionality is built into the image (borgerpc/kiosk) thereby making the script obsolete. When this happens please provide the image name and version tag here.| Optional |
+
+