Merge branch 'main' into feat/add-certification-process2

Signed-off-by: Kurt Garloff <kurt@garloff.de>
SovereignCloudStack · Oct 13, 2024 · a92e2b0 · a92e2b0
2 parents 034de5c + 6ed445a
commit a92e2b0
Show file tree

Hide file tree

Showing 11 changed files with 174 additions and 116 deletions.
diff --git a/.gitignore b/.gitignore
@@ -19,6 +19,7 @@
 /standards/*/*.md
 /standards/*/*.mdx
 /standards/scs-*.yaml
+/user-docs/application-examples
 
 # Dependencies
 node_modules

diff --git a/docs.package.json b/docs.package.json
@@ -135,5 +135,11 @@
     "source": ["documentation/overview.md"],
     "target": "docs/turnkey-solution",
     "label": ""
+  },
+  {
+    "repo": "SovereignCloudStack/opendesk-on-scs",
+    "source": "docs/*",
+    "target": "user-docs/application-examples",
+    "label": "opendesk-on-scs"
   }
 ]
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -81,6 +81,16 @@ const config = {
         // ... other options
       }
     ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'user-docs',
+        path: 'user-docs',
+        routeBasePath: 'user-docs',
+        sidebarPath: require.resolve('./sidebarsUserDocs.js')
+        // ... other options
+      }
+    ],
     [
       '@docusaurus/plugin-content-docs',
       {
@@ -120,6 +130,11 @@ const config = {
             label: 'For Contributors',
             position: 'left'
           },
+          {
+            to: '/user-docs',
+            label: 'For Users',
+            position: 'left'
+          },
           { to: '/community', label: 'Community', position: 'left' },
           { to: '/docs/faq', label: 'FAQ', position: 'left' },
           {
@@ -194,12 +209,19 @@ const config = {
       // @ts-ignore
       ({
         hashed: true,
-        docsDir: ['docs', 'community', 'standards', 'contributor-docs'],
+        docsDir: [
+          'docs',
+          'community',
+          'standards',
+          'contributor-docs',
+          'user-docs'
+        ],
         docsRouteBasePath: [
           'docs',
           'community',
           'standards',
-          'contributor-docs'
+          'contributor-docs',
+          'user-docs'
         ]
       })
     ]

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
     "typecheck": "tsc",
-    "postinstall": "node getDocs.js && node populateStds.js && node populateCerts.js",
+    "postinstall": "node getDocs.js && node populateStds.js && node populateCerts.js && node populateClouds.js",
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint:md": "markdownlint-cli2 \"**/*.md\"",
     "fix:md": "markdownlint-cli2-fix \"**/*.md\"",
@@ -54,6 +54,7 @@
     "lint-staged": "^13.1.2",
     "markdownlint-cli2": "^0.7.1",
     "markdownlint-rule-search-replace": "^1.0.9",
+    "node-fetch": "^2.7.0",
     "prettier": "^2.8.4",
     "prism-react-renderer": "^2.3.1",
     "react": "^18.2.0",

diff --git a/populateCerts.js b/populateCerts.js
@@ -1,108 +1,46 @@
+const fetch = require('node-fetch')
 const fs = require('fs')
 const YAML = require('yaml')
 
+async function fetchScopeTable(uuid, title, path) {
+  const response = await fetch(
+    `https://compliance.sovereignit.cloud/markdown/scope/${uuid}`
+  )
+  var text = await response.text()
+  text = `# ${title}\n\n${text}`
+  fs.writeFileSync(path, text, 'utf8')
+}
+
 // how many outdated versions of any scope to include
 const MAX_OLD = 1
 
 const filenames = fs
-    .readdirSync('standards/')
-    .filter((fn) => fn.startsWith('scs-') && fn.endsWith('.yaml'))
+  .readdirSync('standards/')
+  .filter((fn) => fn.startsWith('scs-') && fn.endsWith('.yaml'))
 
 const scopes = filenames.map((filename) => {
-    return {
-        ...YAML.parseDocument(fs.readFileSync(`standards/${filename}`, 'utf8')).toJSON(),
-        filename,
-        id: filename.substring(0, filename.length - 5),
-    }
+  return {
+    ...YAML.parseDocument(
+      fs.readFileSync(`standards/${filename}`, 'utf8')
+    ).toJSON(),
+    filename,
+    id: filename.substring(0, filename.length - 5)
+  }
 })
 
 const today = new Date().toISOString().slice(0, 10)
 
 const sidebarItems = scopes.map((scope) => {
-    const matrix = {}
-    const versionsShown = {}
-    var numOld = 0
-    var modules = {}
-    scope.modules.forEach((module) => {
-        modules[module.id] = module
-        module.prettyName = module.id.startsWith('scs-') ? `${module.id}: ${module.name}` : module.name
-    })
-    scope.timeline.sort((a, b) => b.date.localeCompare(a.date))
-    const current = scope.timeline.filter((entry) => entry.date <= today)
-    const lookup = current.length ? current[0].versions : {}
-    // sort in descending order, so we get the MAX_OLD most recent obsolete versions
-    scope.versions.sort((a, b) => b.version.localeCompare(a.version));
-    scope.versions.forEach((version) => {
-        version.state = lookup[version.version] || 'deprecated'
-        version.isStable = version.stabilized_at !== undefined && version.stabilized_at <= today
-        version.isEffective = version.state == 'effective'
-        if (['warn', 'effective', 'draft'].indexOf(version.state) == -1) {
-            numOld += 1
-            if (numOld > MAX_OLD) return
-        }
-        if (version.include === undefined) return
-        versionsShown[version.version] = version
-        version.include.forEach((include) => {
-            if (include.ref === undefined) {
-                include = {ref: include, parameters: {}}
-            }
-            const module = modules[include.ref]
-            if (matrix[module.id] === undefined) {
-                matrix[module.id] = {
-                    name: module.prettyName,
-                    columns: {},
-                    url: module.url,
-                }
-            }
-            matrix[module.id].columns[version.version] = {
-                parameters: include.parameters,
-            }
-        })
-    })
-
-    const rows = Object.values(matrix)
-    const columns = Object.keys(versionsShown)
-    rows.sort((a, b) => a.name.localeCompare(b.name));
-    columns.sort((a, b) => a.localeCompare(b));
-
-    lines = [`# ${scope.name}
-
-Note that the state _Stable_ is shown here if _stabilized at_ is in the future, whereas _Effective_ is shown here if _stabilized at_ is in the past and _deprecated at_ is unset or in the future.
-`]
-    lines.push('| Scope versions ->  | ' + columns.join('  | ') + '  |')
-    lines.push('| :-- | ' + columns.map(() => ':--').join(' | ') + ' |')
-    lines.push('| State              | ' + columns.map((c) => versionsShown[c].state).join('  | ') + '  |')
-    lines.push('| Stabilized at      | ' + columns.map((c) => versionsShown[c].stabilized_at || '').join('  | ') + '  |')
-    // lines.push('| Deprecated at      | ' + columns.map((c) => versionsShown[c].deprecated_at || '').join('  | ') + '  |')
-    // md doesn't allow intermediate header rows
-    // lines.push('| :-- | ' + columns.map(() => ':--').join(' | ') + ' |')
-    lines.push('| **Modules**        | ' + columns.map((c) => ' '.repeat(c.length)).join('  | ') + '  |')
-    // md doesn't allow intermediate header rows
-    // lines.push('| :-- | ' + columns.map(() => ':--').join(' | ') + ' |')
-    rows.forEach((row) => {
-        lines.push(`| [${row.name}](${row.url})  | ` + columns.map((c) => row.columns[c]).map((col) => {
-            if (col === undefined) {
-                // this version of the cert does not include this standard
-                return ''
-            }
-            let params = Object.entries(col.parameters || {}).map((entry) =>
-                entry[1].startsWith('https://') ? `[${entry[0]}](${entry[1]})` : `${entry[0]}=${entry[1]}`
-            ).join(', ')
-            if (params.length) {
-                params = ` (${params})`
-            }
-            return `X${params}`
-        }).join('  | ') + '  |')
-    })
-    lines.push('')  // file should end with a single newline character
-    fs.writeFileSync(`standards/${scope.id}.md`, lines.join('\n'), 'utf8')
-
-    const state = columns.filter((c) => versionsShown[c].isEffective).length ? '📜' : '✏️'
-    return {
-        type: 'doc',
-        label: scope.name,
-        id: scope.id,
+  fetchScopeTable(scope.uuid, scope.name, `standards/${scope.id}.md`).catch(
+    (e) => {
+      console.log(e)
     }
+  )
+  return {
+    type: 'doc',
+    label: scope.name,
+    id: scope.id
+  }
 })
 
 var newSidebars = `module.exports = ${JSON.stringify(sidebarItems, null, '  ')}`

diff --git a/populateClouds.js b/populateClouds.js
@@ -0,0 +1,18 @@
+const fetch = require('node-fetch')
+const fs = require('fs')
+
+async function insertCloudTable(pathIn, pathOut) {
+  const template = fs.readFileSync(pathIn, 'utf8')
+  const response = await fetch(
+    `https://compliance.sovereignit.cloud/markdown/table`
+  )
+  const text = template.replace('<!--CLOUDS-->', await response.text())
+  fs.writeFileSync(pathOut, text, 'utf8')
+}
+
+insertCloudTable(
+  `standards/certification/overview.template.md`,
+  `standards/certification/overview.md`
+).catch((e) => {
+  console.log(e)
+})
diff --git a/sidebarsUserDocs.js b/sidebarsUserDocs.js
@@ -0,0 +1,32 @@
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  userDocs: [
+    'index',
+    {
+      type: 'category',
+      label: 'Application Examples',
+      items: [
+        {
+          type: 'category',
+          label: 'OpenDesk on SCS',
+          link: {
+            type: 'generated-index'
+          },
+          items: [
+            'application-examples/opendesk-on-scs/overview',
+            'application-examples/opendesk-on-scs/quickstart',
+            'application-examples/opendesk-on-scs/requirements',
+            'application-examples/opendesk-on-scs/getting_started',
+            'application-examples/opendesk-on-scs/configuration',
+            'application-examples/opendesk-on-scs/user-import',
+            'application-examples/opendesk-on-scs/contribute'
+          ]
+        }
+      ]
+    }
+  ]
+}
+
+module.exports = sidebars