Add more information and structure on standards and certification (#76)

* add init pages and nav structure Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix relative links Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix links Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix lint Signed-off-by: Max Wolfs <mail@maxwolfs.com> * remove links Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix linting issue Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix single quotes Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix trailing comma Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix js linting Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix lint rules Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix image Signed-off-by: Max Wolfs <mail@maxwolfs.com> * remove duplicate dev-docs instance Signed-off-by: Max Wolfs <mail@maxwolfs.com> * update nav and structure Signed-off-by: Max Wolfs <mail@maxwolfs.com> * update image Signed-off-by: Max Wolfs <mail@maxwolfs.com> * add overview pages and descriptions Signed-off-by: Max Wolfs <mail@maxwolfs.com> * add new overview pages with intro and tables Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix lint Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix relative path link check failure Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix links Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix links Signed-off-by: Max Wolfs <mail@maxwolfs.com> * fix link Signed-off-by: Max Wolfs <mail@maxwolfs.com> * clean up and fixes Signed-off-by: Max Wolfs <mail@maxwolfs.com> * Apply suggestions from code review Co-authored-by: anjastrunk <119566837+anjastrunk@users.noreply.github.com> Signed-off-by: Max Wolfs <mail@maxwolfs.com> * update image Signed-off-by: Max Wolfs <mail@maxwolfs.com> * Replace 'subject' with 'scope' Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * Typos found by @anjastrunk Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * Fix (likely) typo found by @anjastrunk Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * Attempt to streamline documentation on certification and standardization Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * Bugfix: wrong type in docusaurus sidebar Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * Bugfix: multiple h1 headings within one document Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * Fix typo Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> * update image Signed-off-by: Max Wolfs <mail@maxwolfs.com> --------- Signed-off-by: Max Wolfs <mail@maxwolfs.com> Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com> Co-authored-by: anjastrunk <119566837+anjastrunk@users.noreply.github.com> Co-authored-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
SovereignCloudStack · Nov 1, 2023 · fb5d5c5 · fb5d5c5
1 parent 955a920
commit fb5d5c5
Show file tree

Hide file tree

Showing 42 changed files with 1,048 additions and 361 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -15,5 +15,10 @@ module.exports = {
     ecmaVersion: 'latest',
     sourceType: 'module'
   },
-  plugins: ['react']
+  plugins: ['react'],
+  rules: [
+    {
+      'space-before-function-paren': 'never'
+    }
+  ]
 }
diff --git a/.gitignore b/.gitignore
@@ -6,7 +6,7 @@
 /docs/03-container/components
 /docs/04-operating-scs/components
 /docs/06-releases
-/standards
+/standards/*.md
 
 # Dependencies
 node_modules

diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -4,6 +4,7 @@
     "MD013": false,
     "MD033": { "allowed_elements": ["li", "ul"] }, // only allowing ul, li elements for checkboxes within md tables
     "MD024": false,
+    "relative-links": false,
     "search-replace": {
       "rules": [
         {
@@ -50,6 +51,10 @@
       ]
     }
   },
-  "customRules": ["markdownlint-rule-search-replace"],
-  "ignores": ["node_modules", ".github", "docs"]
+  "customRules": [
+    "markdownlint-rule-search-replace",
+    "markdownlint-rule-relative-links"
+  ],
+  "ignores": ["node_modules", ".github", "docs"],
+  "globs": ["**/*.{md}"]
 }
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,3 +1,6 @@
 {
-    "bracketSameLine": true
-}
+  "bracketSameLine": true,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "semi": false
+}
diff --git a/babel.config.js b/babel.config.js
@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')]
+}
diff --git a/dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md b/dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md
@@ -354,5 +354,5 @@ Example playbook:
 - hosts: all
   tasks:
     - debug:
-        msg: "Debug print my secrets! {{ secretName.secretValue }}" # do not do this as it will expose your secrets
+        msg: 'Debug print my secrets! {{ secretName.secretValue }}' # do not do this as it will expose your secrets
 ```
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,199 +1,199 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+const darkCodeTheme = require('prism-react-renderer/themes/dracula')
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: "One platform — standardized, built and operated by many.",
-  tagline: "Documentation and Community Platform for the Sovereign Cloud Stack",
-  url: "https://docs.scs.community",
-  baseUrl: "/",
-  onBrokenLinks: "throw",
-  onBrokenMarkdownLinks: "warn",
-  favicon: "img/favicon.ico",
+  title: 'One platform — standardized, built and operated by many.',
+  tagline: 'Documentation and Community Platform for the Sovereign Cloud Stack',
+  url: 'https://docs.scs.community',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon.ico',
   markdown: {
-    mermaid: true,
+    mermaid: true
   },
-  organizationName: "SovereignCloudStack", // Usually your GitHub org/user name.
-  projectName: "docs", // Usually your repo name.
+  organizationName: 'SovereignCloudStack', // Usually your GitHub org/user name.
+  projectName: 'docs', // Usually your repo name.
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want
   // to replace "en" with "zh-Hans".
   i18n: {
-    defaultLocale: "en",
-    locales: ["en"],
+    defaultLocale: 'en',
+    locales: ['en']
   },
   presets: [
     [
-      "classic",
+      'classic',
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
-          sidebarPath: require.resolve("./sidebarsDocs.js"),
-          editUrl: "https://github.com/SovereignCloudStack/docs/tree/main/",
+          sidebarPath: require.resolve('./sidebarsDocs.js'),
+          editUrl: 'https://github.com/SovereignCloudStack/docs/tree/main/'
         },
         blog: {
           showReadingTime: true,
-          editUrl: "https://github.com/SovereignCloudStack/docs/tree/main/",
+          editUrl: 'https://github.com/SovereignCloudStack/docs/tree/main/'
         },
         theme: {
-          customCss: [require.resolve("./src/css/custom.css")],
-        },
-      }),
-    ],
+          customCss: [require.resolve('./src/css/custom.css')]
+        }
+      })
+    ]
   ],
   plugins: [
     [
-      "@docusaurus/plugin-client-redirects",
+      '@docusaurus/plugin-client-redirects',
       {
         redirects: [
           {
-            to: "/docs/iaas/deployment-examples/testbed",
-            from: "/docs/category/osism-testbed/",
-          },
+            to: '/docs/iaas/deployment-examples/testbed',
+            from: '/docs/category/osism-testbed/'
+          }
         ],
         createRedirects(existingPath) {
-          if (existingPath.includes("/community")) {
-            return [existingPath.replace("/community", "/community/community")];
+          if (existingPath.includes('/community')) {
+            return [existingPath.replace('/community', '/community/community')]
           }
-          return undefined; // Return a falsy value: no redirect created
-        },
-      },
+          return undefined // Return a falsy value: no redirect created
+        }
+      }
     ],
     [
-      "@docusaurus/plugin-content-docs",
+      '@docusaurus/plugin-content-docs',
       {
-        id: "community",
-        path: "community",
-        routeBasePath: "community",
-        sidebarPath: require.resolve("./sidebarsCommunity.js"),
+        id: 'community',
+        path: 'community',
+        routeBasePath: 'community',
+        sidebarPath: require.resolve('./sidebarsCommunity.js')
         // ... other options
-      },
+      }
     ],
     [
-      "@docusaurus/plugin-content-docs",
+      '@docusaurus/plugin-content-docs',
       {
-        id: "dev-docs",
-        path: "dev-docs",
-        routeBasePath: "dev-docs",
-        sidebarPath: require.resolve("./sidebarsDevDocs.js"),
+        id: 'dev-docs',
+        path: 'dev-docs',
+        routeBasePath: 'dev-docs',
+        sidebarPath: require.resolve('./sidebarsDevDocs.js')
         // ... other options
-      },
+      }
     ],
     [
-      "@docusaurus/plugin-content-docs",
+      '@docusaurus/plugin-content-docs',
       {
-        id: "standards",
-        path: "standards",
-        routeBasePath: "standards",
-        sidebarPath: require.resolve("./sidebarsStandards.js"),
-      },
+        id: 'standards',
+        path: 'standards',
+        routeBasePath: 'standards',
+        sidebarPath: require.resolve('./sidebarsStandards.js')
+      }
     ],
-    "./src/plugins/docusaurus-plugin-matomo-analytics/index.js",
+    './src/plugins/docusaurus-plugin-matomo-analytics/index.js'
   ],
 
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
       metadata: [
         {
-          title: "One platform — standardized, built and operated by many.",
+          title: 'One platform — standardized, built and operated by many.',
           description:
-            "Documentation and Community Platform for the Sovereign Cloud Stack",
-        },
+            'Documentation and Community Platform for the Sovereign Cloud Stack'
+        }
       ],
-      image: "img/summit-social.png",
+      image: 'img/summit-social.png',
       navbar: {
-        title: "",
+        title: '',
         logo: {
-          alt: "SCS",
-          src: "img/logo.svg",
+          alt: 'SCS',
+          src: 'img/logo.svg'
         },
         items: [
           //   { to: '/blog', label: 'Blog', position: 'left' },
-          { to: "/standards", label: "Standards", position: "left" },
-          { to: "/docs", label: "For Operators", position: "left" },
-          { to: "/dev-docs", label: "For Developers", position: "left" },
-          { to: "/community", label: "Community", position: "left" },
-          { to: "/docs/faq", label: "FAQ", position: "left" },
+          { to: '/standards', label: 'Standards', position: 'left' },
+          { to: '/docs', label: 'For Operators', position: 'left' },
+          { to: '/dev-docs', label: 'For Developers', position: 'left' },
+          { to: '/community', label: 'Community', position: 'left' },
+          { to: '/docs/faq', label: 'FAQ', position: 'left' },
           {
-            href: "https://github.com/SovereignCloudStack/docs",
-            label: "GitHub",
-            position: "right",
-          },
-        ],
+            href: 'https://github.com/SovereignCloudStack/docs',
+            label: 'GitHub',
+            position: 'right'
+          }
+        ]
       },
       footer: {
-        style: "light",
+        style: 'light',
         links: [
           {
-            title: "Docs",
+            title: 'Docs',
             items: [
               {
-                label: "Contribute",
-                to: "/docs",
-              },
-            ],
+                label: 'Contribute',
+                to: '/docs'
+              }
+            ]
           },
           {
-            title: "Community",
+            title: 'Community',
             items: [
               {
-                label: "Matrix",
-                href: "https://matrix.to/#/!TiDqlLmEUaXqTemaLc:matrix.org?via=matrix.org",
+                label: 'Matrix',
+                href: 'https://matrix.to/#/!TiDqlLmEUaXqTemaLc:matrix.org?via=matrix.org'
               },
               {
-                label: "Mastodon",
-                href: "https://fosstodon.org/@sovereigncloudstack",
-              },
-            ],
+                label: 'Mastodon',
+                href: 'https://fosstodon.org/@sovereigncloudstack'
+              }
+            ]
           },
           {
-            title: "More",
+            title: 'More',
             items: [
               // {
               //   label: 'Blog',
               //   to: '/blog'
               // },
               {
-                label: "GitHub",
-                href: "https://github.com/SovereignCloudStack/docs",
-              },
-            ],
-          },
+                label: 'GitHub',
+                href: 'https://github.com/SovereignCloudStack/docs'
+              }
+            ]
+          }
         ],
         copyright:
-          "Sovereign Cloud Stack, SCS and the logo are registered trademarks of the Open Source Business Alliance e.V. — Other trademarks are property of their respective owners.",
+          'Sovereign Cloud Stack, SCS and the logo are registered trademarks of the Open Source Business Alliance e.V. — Other trademarks are property of their respective owners.'
       },
       prism: {
         theme: darkCodeTheme,
         darkTheme: darkCodeTheme,
-        additionalLanguages: ["powershell", "ruby"],
+        additionalLanguages: ['powershell', 'ruby']
       },
       matomoAnalytics: {
-        matomoUrl: "https://matomo.scs.community/",
-        siteId: "2",
-        phpLoader: "matomo.php",
-        jsLoader: "matomo.js",
-        disableCookies: true,
-      },
+        matomoUrl: 'https://matomo.scs.community/',
+        siteId: '2',
+        phpLoader: 'matomo.php',
+        jsLoader: 'matomo.js',
+        disableCookies: true
+      }
     }),
 
   themes: [
-    "@docusaurus/theme-mermaid",
+    '@docusaurus/theme-mermaid',
     [
       // @ts-ignore
-      "@easyops-cn/docusaurus-search-local",
+      '@easyops-cn/docusaurus-search-local',
       /** @type {import('@easyops-cn/docusaurus-search-local').PluginOptions} */
       // @ts-ignore
       ({
         hashed: true,
-        docsDir: ["docs", "community", "standards", "dev-docs"],
-        docsRouteBasePath: ["docs", "community", "standards", "dev-docs"],
-      }),
-    ],
-  ],
-};
+        docsDir: ['docs', 'community', 'standards', 'dev-docs'],
+        docsRouteBasePath: ['docs', 'community', 'standards', 'dev-docs']
+      })
+    ]
+  ]
+}
 
-module.exports = config;
+module.exports = config
diff --git a/getDocs.js b/getDocs.js
@@ -2,7 +2,9 @@ const fs = require('fs')
 const { execSync } = require('child_process')
 
 // Read the contents of the "docs.package.json" file and remove all whitespace
-const reposJson = fs.readFileSync('./docs.package.json', 'utf8').replace(/\s/g, '')
+const reposJson = fs
+  .readFileSync('./docs.package.json', 'utf8')
+  .replace(/\s/g, '')
 
 // Parse the JSON and create an array of repositories
 const repos = JSON.parse(reposJson)

diff --git a/mlc_config.json b/mlc_config.json
@@ -1,4 +1,9 @@
 {
+  "ignorePatterns": [
+    {
+      "pattern": "^/"
+    }
+  ],
   "httpHeaders": [
     {
       "urls": ["https://opensource.org/"],