diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index cf2d70f2bf056c040b0cde4d897682893aa703d9..7209b971b50c7ed6ab60257af2c55ea40eef2337 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -7,16 +7,15 @@ - echo "$UBERSPACE_KNOWN_HOST" >> ~/.ssh/known_hosts .doc-changelist: &doc-changelist - changes: - - docs/* - - versioned_docs/* - - versioned_sidebars/* - - src/* - - static/* - - docusaurus.config.js - - sidebars.js - - versions.json - - .gitlab-ci.yml + - docs/* + - versioned_docs/* + - versioned_sidebars/* + - src/* + - static/* + - docusaurus.config.js + - sidebars.js + - versions.json + - .gitlab-ci.yml stages: - lint @@ -64,19 +63,39 @@ build:doc: - build/ expire_in: 30 days rules: - - *doc-changelist + - changes: *doc-changelist -upload:doc: +upload:doc:review: stage: upload image: $CI_REGISTRY/alpine:latest needs: [ 'build:doc' ] + environment: + name: review/$CI_COMMIT_REF_NAME + on_stop: stop:doc:review + auto_stop_in: 2 week + url: https://docs.fitko.de/preview/fit-connect/$CI_COMMIT_REF_SLUG rules: - - *doc-changelist + - if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH + changes: *doc-changelist before_script: - *pre-deploy-uber-space-setup script: - - DEPLOY_PATH="fit-connect" && [[ "$CI_COMMIT_REF_NAME" != "main" ]] && DEPLOY_PATH="preview/fit-connect/$CI_COMMIT_REF_SLUG" - - rsync -rLvz --size-only --checksum -e "ssh -o CheckHostIP=no" --ipv4 --progress ./build/. fitko@dorado.uberspace.de:html/$DEPLOY_PATH + - rsync -rLvz --size-only --checksum -e "ssh -o CheckHostIP=no" --ipv4 --progress ./build/. fitko@dorado.uberspace.de:html/preview/fit-connect/$CI_COMMIT_REF_SLUG + +upload:doc:production: + stage: upload + image: $CI_REGISTRY/alpine:latest + needs: [ 'build:doc' ] + environment: + name: production + url: https://docs.fitko.de/fit-connect/ + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + changes: *doc-changelist + before_script: + - *pre-deploy-uber-space-setup + script: + - rsync -rLvz --size-only --checksum -e "ssh -o CheckHostIP=no" --ipv4 --progress ./build/. fitko@dorado.uberspace.de:html/fit-connect upload:spec: stage: upload @@ -94,6 +113,19 @@ upload:spec: - sed -i "s,API_VERSION,$CI_COMMIT_TAG,g" dist/antragsmetadaten.schema.json - rsync -rLvz --size-only --checksum -e "ssh -o CheckHostIP=no" --ipv4 --progress ./dist/. fitko@dorado.uberspace.de:html/$CI_COMMIT_TAG/ +stop:doc:review: + stage: .post + environment: + name: review/$CI_COMMIT_REF_NAME + action: stop + rules: + - if: $CI_MERGE_REQUEST_ID + when: manual + before_script: + - *pre-deploy-uber-space-setup + script: + - ssh fitko@dorado.uberspace.de "rm -rf html/preview/fit-connect/$CI_COMMIT_REF_SLUG" + #release-new-api-version: # stage: release # image: registry.gitlab.com/gitlab-org/release-cli:latest diff --git a/README.md b/README.md index fcb767a115254002fc7b05c7b4781f2504a94bcc..eaf6454de4b3a433cd9a8d4d3b41c7304d677b0f 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,21 @@ TBD - 📄`babel.config.js` - 📄`sidebars.js` +#### Development / Local execution + +```bash +$ yarn install +$ yarn start +``` + +#### Build for production + +```bash +$ yarn build +# Optional: Preview production build +$ yarn serve +``` + ### Metadatenschema - ðŸ“`static` diff --git a/docs/getting-started/authentication.mdx b/docs/getting-started/authentication.mdx index 6e6ddc9b0ffcd06a7b54095fdd34b7fc3d233c73..67c078f102d0abc9283611776a40ec9302013bde 100644 --- a/docs/getting-started/authentication.mdx +++ b/docs/getting-started/authentication.mdx @@ -1,4 +1,4 @@ -# 💬 OAuth Authentifizierung +# OAuth Authentifizierung import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' diff --git a/docs/getting-started/encryption.md b/docs/getting-started/encryption.md index 991347c11343efa683967ba18bbd22f83396cfeb..9da79b124119ca49ba13662c15b9a2ed4b8dfe2d 100644 --- a/docs/getting-started/encryption.md +++ b/docs/getting-started/encryption.md @@ -97,16 +97,13 @@ Attribute gemäß [RFC 7517](https://tools.ietf.org/html/rfc7517#section-4) verf | Feld | Inhalt | **Erläuterung** | | ------- | ----------------------------------------- | ------------------------------------------------------------ | -| kty | "RSA" | Keytype gemäß [RFC 7517, Abschnitt 4](https://tools.ietf.org/html/rfc7517#section-4) | -| key_ops | ["wrapKey"] | Funktion des Keys (Verschlüsselung des symmetrischen Verschlüsselungskeys) gemäß [RFC 7517, Abschnitt 4.3](https://tools.ietf.org/html/rfc7517#section-4.3) | -| alg | "RSA-OAEP-256" | Vorgesehener Algorithmus zur Ver- und Entschlüsselung in Kombination mit diesem JWK. Vorgabe gemäß [BSI TR-02102-1, Abschnitt 3.6](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR02102/BSI-TR-02102.html) | -| x5c | *Die gemäß RFC kodierte -Zertifikatskette* | Zertifikatskette vom Teilnehmer:innen-Zertifikat bis zum Wurzelzertifikat einschließlich aller Zwischenzertifikate gemäß [Abschnitt 4.7 RFC 7518](https://tools.ietf.org/html/rfc7517#section-4.7). Hinweis: Gemäß RFC muss das erste Zertifikat der hinterlegten Zertifikatskette dem Teilnehmer:innen-Zertifikat entsprechen. | -| kid | *Eindeutige ID des -Keys* | Eindeutige ID zur Referenzierung des JSON Web Key gemäß [RFC 7516, Abschnitt 4.1.6](https://tools.ietf.org/html/rfc7516#section-4.1.6) dar. Es wird empfohlen, hierfür eine UUID gemäß [RFC 4122](https://tools.ietf.org/html/rfc4122) zu verwenden. | -| n | *Modulus des Public Key zum -Zertifikat* | Der Modulus des Public Key gemäß [RFC 7518, Abschitt 6.3.1.1](https://tools.ietf.org/html/rfc7518.html#section-6.3.1.1) ("Base64urlUInt" enkodiert) | -| e | "AQAB" | Der Exponent des Public Key gemäß [RFC 7518, Abschitt 6.3.1.2](https://tools.ietf.org/html/rfc7518.html#section-6.3.1.2)) | +| kty | `RSA` | Keytype gemäß [RFC 7517, Abschnitt 4](https://tools.ietf.org/html/rfc7517#section-4) | +| key_ops | `["wrapKey"]` | Funktion des Keys (Verschlüsselung des symmetrischen Verschlüsselungskeys) gemäß [RFC 7517, Abschnitt 4.3](https://tools.ietf.org/html/rfc7517#section-4.3) | +| alg | `RSA-OAEP-256` | Vorgesehener Algorithmus zur Ver- und Entschlüsselung in Kombination mit diesem JWK. Vorgabe gemäß [BSI TR-02102-1, Abschnitt 3.6](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR02102/BSI-TR-02102.html) | +| x5c | *Die gemäß RFC kodierte Zertifikatskette* | Zertifikatskette vom Teilnehmer:innen-Zertifikat bis zum Wurzelzertifikat einschließlich aller Zwischenzertifikate gemäß [Abschnitt 4.7 RFC 7518](https://tools.ietf.org/html/rfc7517#section-4.7). Hinweis: Gemäß RFC muss das erste Zertifikat der hinterlegten Zertifikatskette dem Teilnehmer:innen-Zertifikat entsprechen. | +| kid | *Eindeutige ID des Keys* | Eindeutige ID zur Referenzierung des JSON Web Key gemäß [RFC 7516, Abschnitt 4.1.6](https://tools.ietf.org/html/rfc7516#section-4.1.6) dar. Es wird empfohlen, hierfür eine UUID gemäß [RFC 4122](https://tools.ietf.org/html/rfc4122) zu verwenden. | +| n | *Modulus des Public Key zum Zertifikat* | Der Modulus des Public Key gemäß [RFC 7518, Abschitt 6.3.1.1](https://tools.ietf.org/html/rfc7518.html#section-6.3.1.1) ("Base64urlUInt" enkodiert) | +| e | `AQAB` | Der Exponent des Public Key gemäß [RFC 7518, Abschitt 6.3.1.2](https://tools.ietf.org/html/rfc7518.html#section-6.3.1.2)) | Das bedeutet, der JSON Web Key zur Verschlüsselung muss diesem Format entsprechen: diff --git a/docs/getting-started/sending/data.mdx b/docs/getting-started/sending/data.mdx index c8438d645402d7740cfc5f5da13c6672ae98aa59..88b8cde1065bb3bfe312322658a586c4944cf8a0 100644 --- a/docs/getting-started/sending/data.mdx +++ b/docs/getting-started/sending/data.mdx @@ -1,7 +1,8 @@ --- -title: Fachdaten +title: 🚧 Fachdaten sidebar_position: 4 --- -- Wie werden Fachdaten erstellt? -- Wie werden Fachdaten genutzt? +:::caution +Die neue Version des Fachschemas befindet sich noch in der Konzeption und ist daher noch nicht dokumentiert. +::: diff --git a/docs/getting-started/sending/query-status.mdx b/docs/getting-started/sending/query-status.mdx index 0a57c9add7ad80ec5605b25e8c38515f8062f01e..57f292a43f5511e6384d1a4bcceb6c48b1dc6127 100644 --- a/docs/getting-started/sending/query-status.mdx +++ b/docs/getting-started/sending/query-status.mdx @@ -1,5 +1,5 @@ --- -title: Status abfragen +title: 🚧 Status abfragen sidebar_position: 7 --- diff --git a/docs/getting-started/sending/submit.mdx b/docs/getting-started/sending/submit.mdx index 87f6f8461aeb81f37585a7d69269939fbd300fea..d114dd4a9a9c9703665669e7a1d2330967fde329 100644 --- a/docs/getting-started/sending/submit.mdx +++ b/docs/getting-started/sending/submit.mdx @@ -1,5 +1,5 @@ --- -title: Einreichung abschließen +title: Einreichung versenden sidebar_position: 6 --- diff --git a/docusaurus.config.js b/docusaurus.config.js index 56f46587f5db0b0477612a45091fdf35627b2b50..50ab22031ddc433d8005bb358465edca6a2825ec 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -28,12 +28,12 @@ module.exports = { src: '/images/logo-fitko.svg', }, items: [ - { + /*{ type: 'docsVersionDropdown', position: 'right', dropdownActiveClassDisabled: true, docsPluginId: 'default', - }, + },*/ ], }, footer: {