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

Conversation

maxwolfs
Copy link
Member

@maxwolfs maxwolfs commented Sep 20, 2023

Aim of this PR is to get users of the docs page an overview and detail information about the certification involving the standards and the decision records. In order to understand it is important to expose the process and explain the concept with concise structure and vocabulary.

  • adding better structure, overview with tables and cross references of standards and their metadata such as state, versions, certification and decision records
  • implementing content from @alexander-diab and @mbuechse
  • adding first drafts of visualisations

This first version has a manually edited structure and content. Potential improvement could be to get a lot of this generated via the metadata/frontmatter within the standards.

closes #60 via User Experience

Preview Deployment: https://docs-staging.scs.community/standards

Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
@anjastrunk anjastrunk self-requested a review September 21, 2023 12:44
master-caster pushed a commit that referenced this pull request Sep 28, 2023
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
# Conflicts:
#	docusaurus.config.js
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
@maxwolfs maxwolfs marked this pull request as ready for review October 19, 2023 12:56
maxwolfs and others added 5 commits October 20, 2023 13:00
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
@mbuechse
Copy link
Contributor

@anjastrunk I replaced subject by scope and also fixed the other typos you found: https://github.com/SovereignCloudStack/docs/pull/76/files/bd6f388ec97166d90d4b823743f8114d6a7e1de5..080cd241bdb72dce0f7729c8a03f86e0d8127058

Now on to the actual revision...

Signed-off-by: Max Wolfs <mail@maxwolfs.com>
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
Copy link
Contributor

@mbuechse mbuechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, I couldn't write my suggestions into these tiny fields in Github, so I pushed a commit instead.

To easily review my most recent changes, you can visit this view: https://github.com/SovereignCloudStack/docs/pull/76/files/5903117a6c99896cce93227bc7e93d13d73738dd..fbc79f88b9032667b9c606d055d9e2a65e2713c9

standards/certification/certified-clouds.md Show resolved Hide resolved
standards/certification/get-certified.md Show resolved Hide resolved
standards/certification/image.png Outdated Show resolved Hide resolved
mbuechse and others added 4 commits October 27, 2023 15:43
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
Signed-off-by: Matthias Büchse <matthias.buechse@cloudandheat.com>
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
@maxwolfs maxwolfs requested a review from mbuechse November 1, 2023 07:56
@maxwolfs maxwolfs merged commit fb5d5c5 into main Nov 1, 2023
4 of 6 checks passed
@maxwolfs maxwolfs deleted the feat/add-standards-information branch November 1, 2023 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add interactive overview for standards
3 participants