Merge branch 'main' into 201-add-guidelines-to-write-good-conformance-tests-for-k8s

Author: garloff

.gitignore

@@ -19,6 +19,7 @@
 /standards/*/*.md
 /standards/*/*.mdx
 /standards/scs-*.yaml
+/user-docs/application-examples
 
 # Dependencies
 node_modules

.markdownlint-cli2.jsonc

@@ -55,6 +55,6 @@
     "markdownlint-rule-search-replace",
     "markdownlint-rule-relative-links"
   ],
-  "ignores": ["node_modules", ".github", "docs"],
+  "ignores": ["node_modules", ".github", "docs", "standards"],
   "globs": ["**/*.{md}"]
 }

README.md

@@ -26,3 +26,8 @@ CD in your Terminal to the root directory of the cloned repository. Install all
 npm install
 npm start
 ```
+
+## Linting problems
+
+The repository establishes commit hooks which check the files for correctness and style.
+Have a look at the [linting-guide](https://docs.scs.community/community/contribute/linting-guide/) to get detailed information.

community/contribute/linting-guide.md

@@ -21,6 +21,13 @@ The markdownlint rules are defined in the configuration file `.markdownlint-cli2
 
 Additionally we use [markdownlint-rule-search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) for fixing
 
+## Local Usage for development
+
+```bash
+npm run lint:md <file>
+npm run fix:md  <file>
+```
+
 ## Github Workflows
 
 There are two actions running on every Pull Request on the `main` branch.

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"
   }
 ]

docusaurus.config.js

@@ -9,7 +9,7 @@ const config = {
   tagline: 'Documentation and Community Platform for the Sovereign Cloud Stack',
   url: 'https://docs.scs.community',
   baseUrl: '/',
-  onBrokenLinks: 'throw',
+  onBrokenLinks: 'warn',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
   markdown: {
@@ -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'
         ]
       })
     ]

package-lock.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",