Skip to content

Commit ae0ffb6

Browse files
mbuechsejklare
authored andcommitted
Adapt docs after introduction of Scopes track
Signed-off-by: Matthias Büchse <matthias.buechse@alasca.cloud>
1 parent f74d56a commit ae0ffb6

5 files changed

Lines changed: 5 additions & 61 deletions

File tree

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"write-translations": "docusaurus write-translations",
3030
"write-heading-ids": "docusaurus write-heading-ids",
3131
"typecheck": "tsc",
32-
"postinstall": "node getDocs.js && node populateStds.js && node populateCerts.js && node populateClouds.js",
32+
"postinstall": "node getDocs.js && node populateStds.js && node populateClouds.js",
3333
"test": "echo \"Error: no test specified\" && exit 1",
3434
"lint:md": "markdownlint-cli2 \"**/*.md\"",
3535
"fix:md": "markdownlint-cli2-fix \"**/*.md\"",

populateCerts.js

Lines changed: 0 additions & 47 deletions
This file was deleted.

populateStds.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const trackIntros = {
1212
'KaaS': 'Standards in this track are concerned with Kubernetes as a Service layer, outlining norms and best practices for deploying, managing, and operating Kubernetes clusters. These standards aim to ensure that the orchestration of containers is streamlined, secure, and compatible across various cloud environments and platforms.',
1313
'IAM': 'This track revolves around Identity and Access Management (IAM) standards, providing guidelines for ensuring secure and efficient user authentication, authorization, and administration. It addresses issues related to user identity, permissions, roles, and policies, aiming to safeguard and streamline access to cloud resources and services.',
1414
'Ops': 'Operational Tooling Standards cover the protocols and guidelines associated with tools and utilities used for monitoring, management, and maintenance of the cloud environment. This includes standards for status pages, alerts, logs, and other operational tools, aiming to optimize the reliability, performance, and security of cloud services and resources.',
15+
'Scopes': 'This track contains certificate scopes. A certificate scope is a standard that has to be fulfilled in order for a certificate to be awarded. It usually refers to other standards in regards to actual subject matter — what properties the subject has to satisfy —, and it contains regulations regarding the testing regime.'
1516
}
1617
const legend =`
1718
<p>*Legend to the column headings and entries:</p>\n
@@ -249,4 +250,4 @@ lines.push('') // file should end with a single newline character
249250
fs.writeFileSync(`standards/standards/overview.mdx`, lines.join('\n'), 'utf8')
250251

251252
var newSidebars = `module.exports = ${JSON.stringify(sidebarItems, null, ' ')}`
252-
fs.writeFileSync('./sidebarsStandardsItems.js', newSidebars, 'utf8')
253+
fs.writeFileSync('./sidebarsStandardsItems.js', newSidebars, 'utf8')

sidebarsStandards.js

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,6 @@ const sidebars = {
1010
id: 'certification/overview'
1111
},
1212
items: [
13-
{
14-
type: 'category',
15-
label: 'Scopes and Versions',
16-
link: {
17-
type: 'doc',
18-
id: 'certification/scopes-versions'
19-
},
20-
items: require('./sidebarsCertificationItems.js') // this file will be generated entirely by `populateCerts.js` via npm post-install hook found in the package.json
21-
},
2213
{
2314
type: 'doc',
2415
label: 'Compliance Check Pipeline',

standards/certification/overview.template.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
<!-- markdownlint-disable -->
22
# Certification
33

4-
SCS provides a certification framework with various scopes.
5-
See [Scopes and Versions](scopes-versions.md) for details.
4+
SCS provides a certification framework with various [scopes](https://docs.scs.community/standards/scopes/).
65

76
## Becoming certified
87

9-
In order to obtain a certification, all standards of the respective scope must be adhered to.
8+
In order to obtain a certification for a certain scope, the corresponding scope standard must be adhered to.
109
This is tested at regular intervals, and the results of these tests will be made available publicly.
1110
There are various types of certifications, which are described below.
1211

0 commit comments

Comments
 (0)