Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more information and structure on standards and certification #76

Merged
merged 45 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
cdfb313
add init pages and nav structure
maxwolfs Sep 20, 2023
5241f63
Merge branch 'main' into feat/add-standards-information
maxwolfs Sep 20, 2023
3bbfc31
fix relative links
maxwolfs Sep 20, 2023
b6f3f8f
fix links
maxwolfs Sep 20, 2023
bd03bda
fix lint
maxwolfs Sep 20, 2023
ad0053e
Merge branch 'main' into feat/add-standards-information
maxwolfs Sep 20, 2023
61a4535
remove links
maxwolfs Sep 20, 2023
73bbe0f
fix linting issue
maxwolfs Sep 20, 2023
ab4d51f
fix single quotes
maxwolfs Sep 20, 2023
7a5bf5d
fix trailing comma
maxwolfs Sep 20, 2023
4901347
fix js linting
maxwolfs Sep 20, 2023
804cb43
fix lint rules
maxwolfs Sep 20, 2023
d0de3de
Merge branch 'main' into feat/add-standards-information
maxwolfs Sep 21, 2023
e3e6aa8
Merge branch 'main' into feat/add-standards-information
maxwolfs Sep 22, 2023
76aa423
Merge branch 'feat/add-standards-information' of github.com:Sovereign…
maxwolfs Sep 22, 2023
7df53bb
fix image
maxwolfs Sep 22, 2023
7193055
Merge branch 'main' into feat/add-standards-information
maxwolfs Sep 25, 2023
169593f
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 2, 2023
064cfe4
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 2, 2023
4bc0d3a
remove duplicate dev-docs instance
maxwolfs Oct 2, 2023
7b17749
update nav and structure
maxwolfs Oct 5, 2023
3947d23
update image
maxwolfs Oct 6, 2023
c2962f2
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 9, 2023
76caa07
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 10, 2023
f1d75e1
add overview pages and descriptions
maxwolfs Oct 11, 2023
a8501f3
add new overview pages with intro and tables
maxwolfs Oct 12, 2023
d6ffafc
fix lint
maxwolfs Oct 12, 2023
38163c6
fix relative path link check failure
maxwolfs Oct 12, 2023
be7decf
fix links
maxwolfs Oct 12, 2023
8502a11
fix links
maxwolfs Oct 12, 2023
5ad14b5
fix link
maxwolfs Oct 12, 2023
77531f3
clean up and fixes
maxwolfs Oct 19, 2023
1e18cfe
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 19, 2023
0e89ac7
Apply suggestions from code review
maxwolfs Oct 19, 2023
d2eb75e
update image
maxwolfs Oct 20, 2023
bd6f388
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 20, 2023
0fc52f6
Replace 'subject' with 'scope'
mbuechse Oct 20, 2023
616e361
Typos found by @anjastrunk
mbuechse Oct 20, 2023
080cd24
Fix (likely) typo found by @anjastrunk
mbuechse Oct 20, 2023
5903117
Merge branch 'main' into feat/add-standards-information
maxwolfs Oct 25, 2023
24376cf
Attempt to streamline documentation on certification and standardization
mbuechse Oct 27, 2023
8ee745c
Bugfix: wrong type in docusaurus sidebar
mbuechse Oct 27, 2023
d7ab0be
Bugfix: multiple h1 headings within one document
mbuechse Oct 27, 2023
fbc79f8
Fix typo
mbuechse Oct 27, 2023
5d301cc
update image
maxwolfs Nov 1, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,10 @@ module.exports = {
ecmaVersion: 'latest',
sourceType: 'module'
},
plugins: ['react']
plugins: ['react'],
rules: [
{
'space-before-function-paren': 'never'
}
]
}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/docs/03-container/components
/docs/04-operating-scs/components
/docs/06-releases
/standards
/standards/*.md

# Dependencies
node_modules
Expand Down
9 changes: 7 additions & 2 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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}"]
}
7 changes: 5 additions & 2 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"bracketSameLine": true
}
"bracketSameLine": true,
"singleQuote": true,
"trailingComma": "none",
"semi": false
}
4 changes: 2 additions & 2 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
presets: [require.resolve('@docusaurus/core/lib/babel/preset')]
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
204 changes: 102 additions & 102 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion getDocs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 5 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
{
"ignorePatterns": [
{
"pattern": "^/"
}
],
"httpHeaders": [
{
"urls": ["https://opensource.org/"],
Expand Down
Loading
Loading