Skip to content

Commit fb5d5c5

Browse files
maxwolfsanjastrunkmbuechse
authored
Add more information and structure on standards and certification (#76)
* add init pages and nav structure Signed-off-by: Max Wolfs <[email protected]> * fix relative links Signed-off-by: Max Wolfs <[email protected]> * fix links Signed-off-by: Max Wolfs <[email protected]> * fix lint Signed-off-by: Max Wolfs <[email protected]> * remove links Signed-off-by: Max Wolfs <[email protected]> * fix linting issue Signed-off-by: Max Wolfs <[email protected]> * fix single quotes Signed-off-by: Max Wolfs <[email protected]> * fix trailing comma Signed-off-by: Max Wolfs <[email protected]> * fix js linting Signed-off-by: Max Wolfs <[email protected]> * fix lint rules Signed-off-by: Max Wolfs <[email protected]> * fix image Signed-off-by: Max Wolfs <[email protected]> * remove duplicate dev-docs instance Signed-off-by: Max Wolfs <[email protected]> * update nav and structure Signed-off-by: Max Wolfs <[email protected]> * update image Signed-off-by: Max Wolfs <[email protected]> * add overview pages and descriptions Signed-off-by: Max Wolfs <[email protected]> * add new overview pages with intro and tables Signed-off-by: Max Wolfs <[email protected]> * fix lint Signed-off-by: Max Wolfs <[email protected]> * fix relative path link check failure Signed-off-by: Max Wolfs <[email protected]> * fix links Signed-off-by: Max Wolfs <[email protected]> * fix links Signed-off-by: Max Wolfs <[email protected]> * fix link Signed-off-by: Max Wolfs <[email protected]> * clean up and fixes Signed-off-by: Max Wolfs <[email protected]> * Apply suggestions from code review Co-authored-by: anjastrunk <[email protected]> Signed-off-by: Max Wolfs <[email protected]> * update image Signed-off-by: Max Wolfs <[email protected]> * Replace 'subject' with 'scope' Signed-off-by: Matthias Büchse <[email protected]> * Typos found by @anjastrunk Signed-off-by: Matthias Büchse <[email protected]> * Fix (likely) typo found by @anjastrunk Signed-off-by: Matthias Büchse <[email protected]> * Attempt to streamline documentation on certification and standardization Signed-off-by: Matthias Büchse <[email protected]> * Bugfix: wrong type in docusaurus sidebar Signed-off-by: Matthias Büchse <[email protected]> * Bugfix: multiple h1 headings within one document Signed-off-by: Matthias Büchse <[email protected]> * Fix typo Signed-off-by: Matthias Büchse <[email protected]> * update image Signed-off-by: Max Wolfs <[email protected]> --------- Signed-off-by: Max Wolfs <[email protected]> Signed-off-by: Matthias Büchse <[email protected]> Co-authored-by: anjastrunk <[email protected]> Co-authored-by: Matthias Büchse <[email protected]>
1 parent 955a920 commit fb5d5c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1048
-361
lines changed

‎.eslintrc.js

+6-1
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,10 @@ module.exports = {
1515
ecmaVersion: 'latest',
1616
sourceType: 'module'
1717
},
18-
plugins: ['react']
18+
plugins: ['react'],
19+
rules: [
20+
{
21+
'space-before-function-paren': 'never'
22+
}
23+
]
1924
}

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
/docs/03-container/components
77
/docs/04-operating-scs/components
88
/docs/06-releases
9-
/standards
9+
/standards/*.md
1010

1111
# Dependencies
1212
node_modules

‎.markdownlint-cli2.jsonc

+7-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"MD013": false,
55
"MD033": { "allowed_elements": ["li", "ul"] }, // only allowing ul, li elements for checkboxes within md tables
66
"MD024": false,
7+
"relative-links": false,
78
"search-replace": {
89
"rules": [
910
{
@@ -50,6 +51,10 @@
5051
]
5152
}
5253
},
53-
"customRules": ["markdownlint-rule-search-replace"],
54-
"ignores": ["node_modules", ".github", "docs"]
54+
"customRules": [
55+
"markdownlint-rule-search-replace",
56+
"markdownlint-rule-relative-links"
57+
],
58+
"ignores": ["node_modules", ".github", "docs"],
59+
"globs": ["**/*.{md}"]
5560
}

‎.prettierrc.json

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"bracketSameLine": true
3-
}
2+
"bracketSameLine": true,
3+
"singleQuote": true,
4+
"trailingComma": "none",
5+
"semi": false
6+
}

‎babel.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module.exports = {
2-
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3-
};
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')]
3+
}

‎dev-docs/operations/operations/zuul-ci-cd-quickstart-user-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -354,5 +354,5 @@ Example playbook:
354354
- hosts: all
355355
tasks:
356356
- debug:
357-
msg: "Debug print my secrets! {{ secretName.secretValue }}" # do not do this as it will expose your secrets
357+
msg: 'Debug print my secrets! {{ secretName.secretValue }}' # do not do this as it will expose your secrets
358358
```

‎docusaurus.config.js

+102-102
Original file line numberDiff line numberDiff line change
@@ -1,199 +1,199 @@
11
// @ts-check
22
// Note: type annotations allow type checking and IDEs autocompletion
33

4-
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
4+
const darkCodeTheme = require('prism-react-renderer/themes/dracula')
55

66
/** @type {import('@docusaurus/types').Config} */
77
const config = {
8-
title: "One platform — standardized, built and operated by many.",
9-
tagline: "Documentation and Community Platform for the Sovereign Cloud Stack",
10-
url: "https://docs.scs.community",
11-
baseUrl: "/",
12-
onBrokenLinks: "throw",
13-
onBrokenMarkdownLinks: "warn",
14-
favicon: "img/favicon.ico",
8+
title: 'One platform — standardized, built and operated by many.',
9+
tagline: 'Documentation and Community Platform for the Sovereign Cloud Stack',
10+
url: 'https://docs.scs.community',
11+
baseUrl: '/',
12+
onBrokenLinks: 'throw',
13+
onBrokenMarkdownLinks: 'warn',
14+
favicon: 'img/favicon.ico',
1515
markdown: {
16-
mermaid: true,
16+
mermaid: true
1717
},
18-
organizationName: "SovereignCloudStack", // Usually your GitHub org/user name.
19-
projectName: "docs", // Usually your repo name.
18+
organizationName: 'SovereignCloudStack', // Usually your GitHub org/user name.
19+
projectName: 'docs', // Usually your repo name.
2020
// Even if you don't use internalization, you can use this field to set useful
2121
// metadata like html lang. For example, if your site is Chinese, you may want
2222
// to replace "en" with "zh-Hans".
2323
i18n: {
24-
defaultLocale: "en",
25-
locales: ["en"],
24+
defaultLocale: 'en',
25+
locales: ['en']
2626
},
2727
presets: [
2828
[
29-
"classic",
29+
'classic',
3030
/** @type {import('@docusaurus/preset-classic').Options} */
3131
({
3232
docs: {
33-
sidebarPath: require.resolve("./sidebarsDocs.js"),
34-
editUrl: "https://github.com/SovereignCloudStack/docs/tree/main/",
33+
sidebarPath: require.resolve('./sidebarsDocs.js'),
34+
editUrl: 'https://github.com/SovereignCloudStack/docs/tree/main/'
3535
},
3636
blog: {
3737
showReadingTime: true,
38-
editUrl: "https://github.com/SovereignCloudStack/docs/tree/main/",
38+
editUrl: 'https://github.com/SovereignCloudStack/docs/tree/main/'
3939
},
4040
theme: {
41-
customCss: [require.resolve("./src/css/custom.css")],
42-
},
43-
}),
44-
],
41+
customCss: [require.resolve('./src/css/custom.css')]
42+
}
43+
})
44+
]
4545
],
4646
plugins: [
4747
[
48-
"@docusaurus/plugin-client-redirects",
48+
'@docusaurus/plugin-client-redirects',
4949
{
5050
redirects: [
5151
{
52-
to: "/docs/iaas/deployment-examples/testbed",
53-
from: "/docs/category/osism-testbed/",
54-
},
52+
to: '/docs/iaas/deployment-examples/testbed',
53+
from: '/docs/category/osism-testbed/'
54+
}
5555
],
5656
createRedirects(existingPath) {
57-
if (existingPath.includes("/community")) {
58-
return [existingPath.replace("/community", "/community/community")];
57+
if (existingPath.includes('/community')) {
58+
return [existingPath.replace('/community', '/community/community')]
5959
}
60-
return undefined; // Return a falsy value: no redirect created
61-
},
62-
},
60+
return undefined // Return a falsy value: no redirect created
61+
}
62+
}
6363
],
6464
[
65-
"@docusaurus/plugin-content-docs",
65+
'@docusaurus/plugin-content-docs',
6666
{
67-
id: "community",
68-
path: "community",
69-
routeBasePath: "community",
70-
sidebarPath: require.resolve("./sidebarsCommunity.js"),
67+
id: 'community',
68+
path: 'community',
69+
routeBasePath: 'community',
70+
sidebarPath: require.resolve('./sidebarsCommunity.js')
7171
// ... other options
72-
},
72+
}
7373
],
7474
[
75-
"@docusaurus/plugin-content-docs",
75+
'@docusaurus/plugin-content-docs',
7676
{
77-
id: "dev-docs",
78-
path: "dev-docs",
79-
routeBasePath: "dev-docs",
80-
sidebarPath: require.resolve("./sidebarsDevDocs.js"),
77+
id: 'dev-docs',
78+
path: 'dev-docs',
79+
routeBasePath: 'dev-docs',
80+
sidebarPath: require.resolve('./sidebarsDevDocs.js')
8181
// ... other options
82-
},
82+
}
8383
],
8484
[
85-
"@docusaurus/plugin-content-docs",
85+
'@docusaurus/plugin-content-docs',
8686
{
87-
id: "standards",
88-
path: "standards",
89-
routeBasePath: "standards",
90-
sidebarPath: require.resolve("./sidebarsStandards.js"),
91-
},
87+
id: 'standards',
88+
path: 'standards',
89+
routeBasePath: 'standards',
90+
sidebarPath: require.resolve('./sidebarsStandards.js')
91+
}
9292
],
93-
"./src/plugins/docusaurus-plugin-matomo-analytics/index.js",
93+
'./src/plugins/docusaurus-plugin-matomo-analytics/index.js'
9494
],
9595

9696
themeConfig:
9797
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
9898
({
9999
metadata: [
100100
{
101-
title: "One platform — standardized, built and operated by many.",
101+
title: 'One platform — standardized, built and operated by many.',
102102
description:
103-
"Documentation and Community Platform for the Sovereign Cloud Stack",
104-
},
103+
'Documentation and Community Platform for the Sovereign Cloud Stack'
104+
}
105105
],
106-
image: "img/summit-social.png",
106+
image: 'img/summit-social.png',
107107
navbar: {
108-
title: "",
108+
title: '',
109109
logo: {
110-
alt: "SCS",
111-
src: "img/logo.svg",
110+
alt: 'SCS',
111+
src: 'img/logo.svg'
112112
},
113113
items: [
114114
// { to: '/blog', label: 'Blog', position: 'left' },
115-
{ to: "/standards", label: "Standards", position: "left" },
116-
{ to: "/docs", label: "For Operators", position: "left" },
117-
{ to: "/dev-docs", label: "For Developers", position: "left" },
118-
{ to: "/community", label: "Community", position: "left" },
119-
{ to: "/docs/faq", label: "FAQ", position: "left" },
115+
{ to: '/standards', label: 'Standards', position: 'left' },
116+
{ to: '/docs', label: 'For Operators', position: 'left' },
117+
{ to: '/dev-docs', label: 'For Developers', position: 'left' },
118+
{ to: '/community', label: 'Community', position: 'left' },
119+
{ to: '/docs/faq', label: 'FAQ', position: 'left' },
120120
{
121-
href: "https://github.com/SovereignCloudStack/docs",
122-
label: "GitHub",
123-
position: "right",
124-
},
125-
],
121+
href: 'https://github.com/SovereignCloudStack/docs',
122+
label: 'GitHub',
123+
position: 'right'
124+
}
125+
]
126126
},
127127
footer: {
128-
style: "light",
128+
style: 'light',
129129
links: [
130130
{
131-
title: "Docs",
131+
title: 'Docs',
132132
items: [
133133
{
134-
label: "Contribute",
135-
to: "/docs",
136-
},
137-
],
134+
label: 'Contribute',
135+
to: '/docs'
136+
}
137+
]
138138
},
139139
{
140-
title: "Community",
140+
title: 'Community',
141141
items: [
142142
{
143-
label: "Matrix",
144-
href: "https://matrix.to/#/!TiDqlLmEUaXqTemaLc:matrix.org?via=matrix.org",
143+
label: 'Matrix',
144+
href: 'https://matrix.to/#/!TiDqlLmEUaXqTemaLc:matrix.org?via=matrix.org'
145145
},
146146
{
147-
label: "Mastodon",
148-
href: "https://fosstodon.org/@sovereigncloudstack",
149-
},
150-
],
147+
label: 'Mastodon',
148+
href: 'https://fosstodon.org/@sovereigncloudstack'
149+
}
150+
]
151151
},
152152
{
153-
title: "More",
153+
title: 'More',
154154
items: [
155155
// {
156156
// label: 'Blog',
157157
// to: '/blog'
158158
// },
159159
{
160-
label: "GitHub",
161-
href: "https://github.com/SovereignCloudStack/docs",
162-
},
163-
],
164-
},
160+
label: 'GitHub',
161+
href: 'https://github.com/SovereignCloudStack/docs'
162+
}
163+
]
164+
}
165165
],
166166
copyright:
167-
"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.",
167+
'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.'
168168
},
169169
prism: {
170170
theme: darkCodeTheme,
171171
darkTheme: darkCodeTheme,
172-
additionalLanguages: ["powershell", "ruby"],
172+
additionalLanguages: ['powershell', 'ruby']
173173
},
174174
matomoAnalytics: {
175-
matomoUrl: "https://matomo.scs.community/",
176-
siteId: "2",
177-
phpLoader: "matomo.php",
178-
jsLoader: "matomo.js",
179-
disableCookies: true,
180-
},
175+
matomoUrl: 'https://matomo.scs.community/',
176+
siteId: '2',
177+
phpLoader: 'matomo.php',
178+
jsLoader: 'matomo.js',
179+
disableCookies: true
180+
}
181181
}),
182182

183183
themes: [
184-
"@docusaurus/theme-mermaid",
184+
'@docusaurus/theme-mermaid',
185185
[
186186
// @ts-ignore
187-
"@easyops-cn/docusaurus-search-local",
187+
'@easyops-cn/docusaurus-search-local',
188188
/** @type {import('@easyops-cn/docusaurus-search-local').PluginOptions} */
189189
// @ts-ignore
190190
({
191191
hashed: true,
192-
docsDir: ["docs", "community", "standards", "dev-docs"],
193-
docsRouteBasePath: ["docs", "community", "standards", "dev-docs"],
194-
}),
195-
],
196-
],
197-
};
192+
docsDir: ['docs', 'community', 'standards', 'dev-docs'],
193+
docsRouteBasePath: ['docs', 'community', 'standards', 'dev-docs']
194+
})
195+
]
196+
]
197+
}
198198

199-
module.exports = config;
199+
module.exports = config

‎getDocs.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ const fs = require('fs')
22
const { execSync } = require('child_process')
33

44
// Read the contents of the "docs.package.json" file and remove all whitespace
5-
const reposJson = fs.readFileSync('./docs.package.json', 'utf8').replace(/\s/g, '')
5+
const reposJson = fs
6+
.readFileSync('./docs.package.json', 'utf8')
7+
.replace(/\s/g, '')
68

79
// Parse the JSON and create an array of repositories
810
const repos = JSON.parse(reposJson)

‎mlc_config.json

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^/"
5+
}
6+
],
27
"httpHeaders": [
38
{
49
"urls": ["https://opensource.org/"],

0 commit comments

Comments
 (0)