packaging: Add some very basic triggers info

Signed-off-by: Ikey Doherty <ikey@serpentos.com>
serpent-os · Feb 3, 2024 · d811780 · d811780
1 parent 620e3c8
commit d811780
Show file tree

Hide file tree

Showing 13 changed files with 333 additions and 6 deletions.
diff --git a/...aurus-plugin-content-docs/default/category-docs-packagesidebar-category-triggers-867.json b/...aurus-plugin-content-docs/default/category-docs-packagesidebar-category-triggers-867.json
@@ -0,0 +1,16 @@
+{
+  "title": "Triggers",
+  "description": "Triggers are system actions run during package installation",
+  "slug": "/category/triggers",
+  "permalink": "/docs/category/triggers",
+  "navigation": {
+    "previous": {
+      "title": "Package definitions",
+      "permalink": "/docs/packaging/recipes/package_definition"
+    },
+    "next": {
+      "title": "Overview",
+      "permalink": "/docs/packaging/triggers/overview"
+    }
+  }
+}
diff --git a/...us-plugin-content-docs/default/site-docs-packaging-recipes-package-definition-md-7b6.json b/...us-plugin-content-docs/default/site-docs-packaging-recipes-package-definition-md-7b6.json
@@ -19,5 +19,9 @@
   "previous": {
     "title": "Build dependencies",
     "permalink": "/docs/packaging/recipes/build_deps"
+  },
+  "next": {
+    "title": "Triggers",
+    "permalink": "/docs/category/triggers"
   }
 }
diff --git a/.../docusaurus-plugin-content-docs/default/site-docs-packaging-triggers-overview-md-774.json b/.../docusaurus-plugin-content-docs/default/site-docs-packaging-triggers-overview-md-774.json
@@ -0,0 +1,27 @@
+{
+  "id": "packaging/triggers/overview",
+  "title": "Overview",
+  "description": "Serpent OS supports the use of triggers, or actions, that run at the end of package installations.",
+  "source": "@site/docs/packaging/triggers/overview.md",
+  "sourceDirName": "packaging/triggers",
+  "slug": "/packaging/triggers/overview",
+  "permalink": "/docs/packaging/triggers/overview",
+  "draft": false,
+  "unlisted": false,
+  "editUrl": "https://github.com/serpent-os/docs/tree/main/docs/packaging/triggers/overview.md",
+  "tags": [],
+  "version": "current",
+  "sidebarPosition": 1,
+  "frontMatter": {
+    "sidebar_position": 1
+  },
+  "sidebar": "packageSidebar",
+  "previous": {
+    "title": "Triggers",
+    "permalink": "/docs/category/triggers"
+  },
+  "next": {
+    "title": "Transaction Triggers",
+    "permalink": "/docs/packaging/triggers/tx_triggers"
+  }
+}
diff --git a/...cusaurus-plugin-content-docs/default/site-docs-packaging-triggers-tx-triggers-md-d3a.json b/...cusaurus-plugin-content-docs/default/site-docs-packaging-triggers-tx-triggers-md-d3a.json
@@ -0,0 +1,23 @@
+{
+  "id": "packaging/triggers/tx_triggers",
+  "title": "Transaction Triggers",
+  "description": "Transactional scope triggers (tx triggers) are run after the new filesystem transaction has been",
+  "source": "@site/docs/packaging/triggers/tx_triggers.md",
+  "sourceDirName": "packaging/triggers",
+  "slug": "/packaging/triggers/tx_triggers",
+  "permalink": "/docs/packaging/triggers/tx_triggers",
+  "draft": false,
+  "unlisted": false,
+  "editUrl": "https://github.com/serpent-os/docs/tree/main/docs/packaging/triggers/tx_triggers.md",
+  "tags": [],
+  "version": "current",
+  "sidebarPosition": 2,
+  "frontMatter": {
+    "sidebar_position": 2
+  },
+  "sidebar": "packageSidebar",
+  "previous": {
+    "title": "Overview",
+    "permalink": "/docs/packaging/triggers/overview"
+  }
+}
diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json b/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json
@@ -114,6 +114,29 @@
           }
         ],
         "href": "/docs/category/recipes"
+      },
+      {
+        "type": "category",
+        "label": "Triggers",
+        "collapsible": true,
+        "collapsed": true,
+        "items": [
+          {
+            "type": "link",
+            "label": "Overview",
+            "href": "/docs/packaging/triggers/overview",
+            "docId": "packaging/triggers/overview",
+            "unlisted": false
+          },
+          {
+            "type": "link",
+            "label": "Transaction Triggers",
+            "href": "/docs/packaging/triggers/tx_triggers",
+            "docId": "packaging/triggers/tx_triggers",
+            "unlisted": false
+          }
+        ],
+        "href": "/docs/category/triggers"
       }
     ],
     "userSidebar": [
@@ -198,6 +221,18 @@
       "description": "The majority of packages are built using upstream release sources. While it is possible to create packages manually from local assets, the bulk of packages take an upstream tarball and build it.",
       "sidebar": "packageSidebar"
     },
+    "packaging/triggers/overview": {
+      "id": "packaging/triggers/overview",
+      "title": "Overview",
+      "description": "Serpent OS supports the use of triggers, or actions, that run at the end of package installations.",
+      "sidebar": "packageSidebar"
+    },
+    "packaging/triggers/tx_triggers": {
+      "id": "packaging/triggers/tx_triggers",
+      "title": "Transaction Triggers",
+      "description": "Transactional scope triggers (tx triggers) are run after the new filesystem transaction has been",
+      "sidebar": "packageSidebar"
+    },
     "users/intro": {
       "id": "users/intro",
       "title": "Introduction",

diff --git a/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json b/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json
@@ -286,6 +286,10 @@
               "previous": {
                 "title": "Build dependencies",
                 "permalink": "/docs/packaging/recipes/build_deps"
+              },
+              "next": {
+                "title": "Triggers",
+                "permalink": "/docs/category/triggers"
               }
             },
             {
@@ -315,6 +319,56 @@
                 "permalink": "/docs/packaging/recipes/metadata"
               }
             },
+            {
+              "id": "packaging/triggers/overview",
+              "title": "Overview",
+              "description": "Serpent OS supports the use of triggers, or actions, that run at the end of package installations.",
+              "source": "@site/docs/packaging/triggers/overview.md",
+              "sourceDirName": "packaging/triggers",
+              "slug": "/packaging/triggers/overview",
+              "permalink": "/docs/packaging/triggers/overview",
+              "draft": false,
+              "unlisted": false,
+              "editUrl": "https://github.com/serpent-os/docs/tree/main/docs/packaging/triggers/overview.md",
+              "tags": [],
+              "version": "current",
+              "sidebarPosition": 1,
+              "frontMatter": {
+                "sidebar_position": 1
+              },
+              "sidebar": "packageSidebar",
+              "previous": {
+                "title": "Triggers",
+                "permalink": "/docs/category/triggers"
+              },
+              "next": {
+                "title": "Transaction Triggers",
+                "permalink": "/docs/packaging/triggers/tx_triggers"
+              }
+            },
+            {
+              "id": "packaging/triggers/tx_triggers",
+              "title": "Transaction Triggers",
+              "description": "Transactional scope triggers (tx triggers) are run after the new filesystem transaction has been",
+              "source": "@site/docs/packaging/triggers/tx_triggers.md",
+              "sourceDirName": "packaging/triggers",
+              "slug": "/packaging/triggers/tx_triggers",
+              "permalink": "/docs/packaging/triggers/tx_triggers",
+              "draft": false,
+              "unlisted": false,
+              "editUrl": "https://github.com/serpent-os/docs/tree/main/docs/packaging/triggers/tx_triggers.md",
+              "tags": [],
+              "version": "current",
+              "sidebarPosition": 2,
+              "frontMatter": {
+                "sidebar_position": 2
+              },
+              "sidebar": "packageSidebar",
+              "previous": {
+                "title": "Overview",
+                "permalink": "/docs/packaging/triggers/overview"
+              }
+            },
             {
               "id": "users/intro",
               "title": "Introduction",
@@ -422,6 +476,28 @@
                   "slug": "/category/recipes",
                   "permalink": "/docs/category/recipes"
                 }
+              },
+              {
+                "type": "category",
+                "label": "Triggers",
+                "collapsible": true,
+                "collapsed": true,
+                "items": [
+                  {
+                    "type": "doc",
+                    "id": "packaging/triggers/overview"
+                  },
+                  {
+                    "type": "doc",
+                    "id": "packaging/triggers/tx_triggers"
+                  }
+                ],
+                "link": {
+                  "type": "generated-index",
+                  "description": "Triggers are system actions run during package installation",
+                  "slug": "/category/triggers",
+                  "permalink": "/docs/category/triggers"
+                }
               }
             ],
             "userSidebar": [

diff --git a/.docusaurus/globalData.json b/.docusaurus/globalData.json
@@ -69,6 +69,16 @@
               "path": "/docs/packaging/recipes/upstreams",
               "sidebar": "packageSidebar"
             },
+            {
+              "id": "packaging/triggers/overview",
+              "path": "/docs/packaging/triggers/overview",
+              "sidebar": "packageSidebar"
+            },
+            {
+              "id": "packaging/triggers/tx_triggers",
+              "path": "/docs/packaging/triggers/tx_triggers",
+              "sidebar": "packageSidebar"
+            },
             {
               "id": "users/intro",
               "path": "/docs/users/intro",
@@ -88,6 +98,11 @@
               "id": "/category/recipes",
               "path": "/docs/category/recipes",
               "sidebar": "packageSidebar"
+            },
+            {
+              "id": "/category/triggers",
+              "path": "/docs/category/triggers",
+              "sidebar": "packageSidebar"
             }
           ],
           "draftIds": [],

diff --git a/.docusaurus/registry.js b/.docusaurus/registry.js
diff --git a/.docusaurus/routes.js b/.docusaurus/routes.js
@@ -39,15 +39,15 @@ export default [
   },
   {
     path: '/docs',
-    component: ComponentCreator('/docs', '01c'),
+    component: ComponentCreator('/docs', 'a02'),
     routes: [
       {
         path: '/docs',
-        component: ComponentCreator('/docs', '19d'),
+        component: ComponentCreator('/docs', '834'),
         routes: [
           {
             path: '/docs',
-            component: ComponentCreator('/docs', '01f'),
+            component: ComponentCreator('/docs', '687'),
             routes: [
               {
                 path: '/docs/category/recipes',
@@ -61,6 +61,12 @@ export default [
                 exact: true,
                 sidebar: "devSidebar"
               },
+              {
+                path: '/docs/category/triggers',
+                component: ComponentCreator('/docs/category/triggers', '1a1'),
+                exact: true,
+                sidebar: "packageSidebar"
+              },
               {
                 path: '/docs/category/v1',
                 component: ComponentCreator('/docs/category/v1', '6d4'),
@@ -138,6 +144,18 @@ export default [
                 exact: true,
                 sidebar: "packageSidebar"
               },
+              {
+                path: '/docs/packaging/triggers/overview',
+                component: ComponentCreator('/docs/packaging/triggers/overview', '78e'),
+                exact: true,
+                sidebar: "packageSidebar"
+              },
+              {
+                path: '/docs/packaging/triggers/tx_triggers',
+                component: ComponentCreator('/docs/packaging/triggers/tx_triggers', '64b'),
+                exact: true,
+                sidebar: "packageSidebar"
+              },
               {
                 path: '/docs/users/intro',
                 component: ComponentCreator('/docs/users/intro', '420'),

diff --git a/.docusaurus/routesChunkNames.json b/.docusaurus/routesChunkNames.json
@@ -42,17 +42,17 @@
       "plugin": "plugin---docusaurus-debug-8-ae-ccb"
     }
   },
-  "/docs-01c": {
+  "/docs-a02": {
     "__comp": "__comp---theme-docs-root-5-e-9-0b6",
     "__context": {
       "plugin": "plugin---docs-13-c-7c1"
     }
   },
-  "/docs-19d": {
+  "/docs-834": {
     "__comp": "__comp---theme-doc-version-roota-7-b-5de",
     "version": "version---docs-935-398"
   },
-  "/docs-01f": {
+  "/docs-687": {
     "__comp": "__comp---theme-doc-roota-94-67a"
   },
   "/docs/category/recipes-b62": {
@@ -63,6 +63,10 @@
     "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640",
     "categoryGeneratedIndex": "categoryGeneratedIndex---docs-category-stone-format-6-fd-66f"
   },
+  "/docs/category/triggers-1a1": {
+    "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640",
+    "categoryGeneratedIndex": "categoryGeneratedIndex---docs-category-triggers-0-e-5-f10"
+  },
   "/docs/category/v1-6d4": {
     "__comp": "__comp---theme-doc-category-generated-index-page-14-e-640",
     "categoryGeneratedIndex": "categoryGeneratedIndex---docs-category-v-195-b-d8f"
@@ -115,6 +119,14 @@
     "__comp": "__comp---theme-doc-item-178-a40",
     "content": "content---docs-packaging-recipes-upstreamsb-7-a-a37"
   },
+  "/docs/packaging/triggers/overview-78e": {
+    "__comp": "__comp---theme-doc-item-178-a40",
+    "content": "content---docs-packaging-triggers-overview-774-c35"
+  },
+  "/docs/packaging/triggers/tx_triggers-64b": {
+    "__comp": "__comp---theme-doc-item-178-a40",
+    "content": "content---docs-packaging-triggers-tx-triggersd-3-a-25d"
+  },
   "/docs/users/intro-420": {
     "__comp": "__comp---theme-doc-item-178-a40",
     "content": "content---docs-users-intro-7-c-6-878"

diff --git a/docs/packaging/triggers/_category_.json b/docs/packaging/triggers/_category_.json
@@ -0,0 +1,9 @@
+{
+    "label": "Triggers",
+    "position": 3,
+    "link": {
+      "type": "generated-index",
+      "description": "Triggers are system actions run during package installation"
+    }
+  }
+