Initial commit

catenax-eV · Jun 12, 2024 · 04f5a57 · 04f5a57
commit 04f5a57
Show file tree

Hide file tree

Showing 170 changed files with 22,446 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,7 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+# *       @global-owner1 @global-owner2
+
+*        @catenax-eV/cx-github-owner
diff --git a/.github/workflows/build-and-deploy-gh-pages.yaml b/.github/workflows/build-and-deploy-gh-pages.yaml
@@ -0,0 +1,38 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Build website
+        run: npm run build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/verify-build.yaml b/.github/workflows/verify-build.yaml
@@ -0,0 +1,28 @@
+name: Verify website build
+
+on:
+  pull_request:
+    branches:
+      - main
+
+# This job will try to build the website to find potential issues
+# before actually merging and deploying the page.
+# There are cases, where for example broken links will break the build, but
+# checking it on the local development server (npm start) will work smoothely.
+jobs:
+  test-deploy:
+    name: Build static website
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint
+        run: npm run lint
+      - name: Test build website
+        run: npm run build
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,23 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.idea
+.vscode/
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,13 @@
+{
+  "default": true,
+  "MD013": false,
+  "MD040": false,
+  "MD024": {
+    "siblings_only": true
+  },
+  "MD033": {
+    "allowed_elements": [
+      "br"
+    ]
+  }
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# Website
+
+This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
+
+## How to deploy
+
+This deploys through github actions!
+
+## How to use locally
+
+- `npm install` (only initially needed)
+- `npm start`
+
+### Verify build before pushing remote
+
+If there are any issues with wrong/outdated links, the github action will fail. To reduce the feedback loop, build it locally before pushing.
+
+`npm run build`
+
+## How to use the documentation repository
+
+> TBD
+
+- Documentation is written as a markdown file. Contributions are done via pull request
+- We use [markdownlint](https://www.npmjs.com/package/markdownlint) in a pre-commit hook.
+
+### How to configure markdown rules
+
+[https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)
+Rules are configured in a file named `.markdownlint.json`
+for more detailed rules have a look at [this site](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md) as an example.
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
@@ -0,0 +1,44 @@
+---
+slug: long-blog-post
+title: Long Blog Post
+authors: endi
+tags: [hello, docusaurus]
+---
+
+This is the summary of a very long blog post,
+
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+
+<!--truncate-->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
@@ -0,0 +1,20 @@
+---
+slug: mdx-blog-post
+title: MDX Blog Post
+authors: [slorber]
+tags: [docusaurus]
+---
+
+Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+
+:::tip
+
+Use the power of React to create interactive blog posts.
+
+```js
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+```
+
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+
+:::
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
@@ -0,0 +1,25 @@
+---
+slug: welcome
+title: Welcome
+authors: [slorber, yangshun]
+tags: [facebook, hello, docusaurus]
+---
+
+[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+
+Simply add Markdown files (or folders) to the `blog` directory.
+
+Regular blog authors can be added to `authors.yml`.
+
+The blog post date can be extracted from filenames, such as:
+
+- `2019-05-30-welcome.md`
+- `2019-05-30-welcome/index.md`
+
+A blog post folder can be convenient to co-locate blog post images:
+
+![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+
+The blog supports tags as well!
+
+**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
diff --git a/blog/authors.yml b/blog/authors.yml
@@ -0,0 +1,17 @@
+endi:
+  name: Endilie Yacop Sucipto
+  title: Maintainer of Docusaurus
+  url: https://github.com/endiliey
+  image_url: https://github.com/endiliey.png
+
+yangshun:
+  name: Yangshun Tay
+  title: Front End Engineer @ Facebook
+  url: https://github.com/yangshun
+  image_url: https://github.com/yangshun.png
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png
diff --git a/blog/tags.yml b/blog/tags.yml
@@ -0,0 +1,16 @@
+facebook:
+  label: Facebook
+  permalink: /facebook
+  description: Facebook tag description
+hello:
+  label: Hello
+  permalink: /hello
+  description: Hello tag description
+docusaurus:
+  label: Docusaurus
+  permalink: /docusaurus
+  description: Docusaurus tag description
+hola:
+  label: Hola
+  permalink: /hola
+  description: Hola tag description
diff --git a/docs/operating-model/appendix/_category_.json b/docs/operating-model/appendix/_category_.json
@@ -0,0 +1,6 @@
+{
+    "label": "Appendix",
+    "position": 11,
+    "collapsible": true,
+    "collapsed": true
+}
diff --git a/docs/operating-model/appendix/appendix.md b/docs/operating-model/appendix/appendix.md
@@ -0,0 +1,32 @@
+---
+sidebar_position: 1
+---
+# Appendix
+
+## Role Relationships
+
+Overview of mandatory (M) and optional (O) relationships between roles (release 23.09)
+
+![Role Relationships](./assets/role-relationships.png)
+*Role Relationships*
+
+Overview of mandatory and optional relationships between roles.
+
+| Relationship     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| IAM-Sync         | The IdP is a service responsible for storing and verifying user   identities. Its objective is to enable user access to all IAMs of Catena-X   operators as soon as they onboard themselves and receive a user in an IAM.   Achieving this requires synchronization of each IAM with every other one, a   process known as Identity-Sync, which involves both regular users and   technical clients.                                                                                                                                                                                                                                                                                                                                             |
+| Integration      | Technical integration is required to use Core Services Section B of the   CSP-B. The other parties must have access to the services to be able to offer   their services. The technical integration refers to an API. This includes   documentation, access data, definition of commercial aspects and SLAs. To   fully utilize Core Services B of the CSP-B, it is required to perform   technical integration with the related APIs. This integration is necessary   for enabling other data space participants to access the services to provide   their own services. This also includes to provide documentation, access   credentials, and define commercial aspects and SLAs for other related   services to ensure smooth functionality. |
+| Onboarding       | The onboarding enables either existing customers in other networks or   interested parties to access the Catena-X data space (Trusted Access Point).   This is the technical connection and registration of the participants. With   the successful completion of the onboarding, the participant is part of   Catena-X and can use the network.                                                                                                                                                                                                                                                                                                                                                                                                 |
+| Certification    | When certified by a CAB, the party is audited against the Catena-X   standards. These independent third parties ensure security and   in-teroperability.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Nomination       | The nomination process is designed to ensure neutrality and trustworthy   execution of selected roles and tasks within the Catena-X ecosystem. The   various rights and obligations of the operator are described in the Request   for Tender (RFT).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| Qualification    | With the qualification, the Catena-X Association ensures that there is a   uniform level of quality and service of the various providers. This creates   security and trust for the users of the services.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| Trademark Rights | With the different qualifications and certifications, the respective   parties receive different Catena-X labels. With these they can identify   themselves and use them for illustration. The Catena-X Association holds the   trademark rights to the labels and Catena-X itself                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| Use              | Within Catena-X, a participant can use different offers from service   providers (AP, ESP, BAP). These are certified applications. Alternatively,   they can certify and operate them by themselves, but then it would not use   services. The offers can be SaaS solutions or local deployments.                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+
+## Data Exchange based on SSI - Next Steps
+
+**Catena-X Policies as part of the Data Exchange**
+(please note the image below covers own as well as managed Wallet solutions; the credential request flow is not displayed since no changes are planned so far)
+
+![Further development of the data exchange based on SSI](./assets/further-development-of-the-data-exchange-based-on-ssi.png)
+*Further development of the data exchange based on SSI*
diff --git a/...model/appendix/assets/further-development-of-the-data-exchange-based-on-ssi.png b/...model/appendix/assets/further-development-of-the-data-exchange-based-on-ssi.png
diff --git a/docs/operating-model/appendix/assets/role-relationships.png b/docs/operating-model/appendix/assets/role-relationships.png
diff --git a/docs/operating-model/change-log/_category_.json b/docs/operating-model/change-log/_category_.json
@@ -0,0 +1,6 @@
+{
+    "label": "Change Log",
+    "position": 12,
+    "collapsible": true,
+    "collapsed": true
+}
diff --git a/docs/operating-model/change-log/change-log.md b/docs/operating-model/change-log/change-log.md
@@ -0,0 +1,37 @@
+---
+sidebar_position: 1
+---
+# Change Log
+
+## Added
+
+- Role: Catena-X Automotive Network e.V.
+- Service Map: Onboarding Service Category
+- Data Space Operations: Providing information, guidelines, and premises on how to participate and exchange data in the data space:
+  - General Onboarding Process
+  - Gaia-X Compliance
+  - SSI Issuer Concept
+  - Data Exchange based on SSI
+  - EDC Deployment and Usage Premises
+- Life Cycle Management:
+  - Versioning
+  - Backward Compatibility
+- Data Space Governance:
+  - Qualification Process
+  - Exceptions
+
+## Changed/Updated
+
+- Introduction: clarity and readability improvements
+- Roles:
+  - Re-naming of consulting provider to advisory provider
+  - Detailing the description of all roles with responsibilities, respective relationships, prerequisites, and complements
+- Service Map: Update of service map according to Tractus-X release 23.09
+- Standardization process: reference provided to standardization policy that details the Catena-X standardization process further
+- Certification process: reference provided to Conformity Assessment Framework that details the Catena-X certification process further
+- Labels: Removed distinguishing factors between Certified Operating Company and Certified Partner
+- Outlook: updated according to release 23.09
+
+## Unchanged
+
+- Nomination Process
diff --git a/docs/operating-model/glossary/_category_.json b/docs/operating-model/glossary/_category_.json
@@ -0,0 +1,6 @@
+{
+    "label": "Glossary",
+    "position": 10,
+    "collapsible": true,
+    "collapsed": true
+}