diff --git a/docs/getting-started/authentication.mdx b/docs/getting-started/authentication.mdx index 3a57f6cef87cd8c00aff23323ac3a124ee13b917..5db48559bea8377cf4f73163e6b5c3368b5a7b3a 100644 --- a/docs/getting-started/authentication.mdx +++ b/docs/getting-started/authentication.mdx @@ -5,6 +5,10 @@ import TabItem from '@theme/TabItem' Nachfolgend wird der Abruf von Access Tokens beim OAuth-Dienst sowie der Zugriff auf die FIT-Connect Submission API mittels Access Tokens beschrieben. +:::note Hinweis +Als Voraussetzungen hierfür ist es notwendig, Accounts für [API-Clients im Self-Service-Portal zu registrieren](../account.mdx). +::: + ## Abruf von Access Tokens beim OAuth-Dienst Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden. diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md index c4a99f5816d3c852089ba5b85bb36b5cbd971347..82ba14f3528e69b993a0edeae491cb6a9432c025 100644 --- a/docs/getting-started/overview.md +++ b/docs/getting-started/overview.md @@ -1,10 +1,10 @@ -# Überblick +# Erste Schritte Im folgenden "Getting Started"-Guide wird beschrieben, wie die ersten Interaktionen mit FIT-Connect ablaufen und FIT-Connect integriert werden kann. -In den nächsten Abschnitten wird beschrieben, wie man sich gegenüber FIT-Connect authentifiziert, Daten für die Übertragung ver- und entschlüsselt werden, sowie welche Schritte für das Einreichen bzw. Empfangen von Einreichungen notwendig sind. +In den nächsten Abschnitten wird beschrieben, wie man sich [gegenüber FIT-Connect authentifiziert](./authentication), Daten für die Übertragung [ver- und entschlüsselt](./encryption) werden, sowie welche Schritte für das [Einreichen](./sending/overview) bzw. [Empfangen](./receiving/overview) von Einreichungen notwendig sind. -:::note Hinweis -Als Voraussetzungen hierfür ist es notwendig einen Account zu besitzen, wie in "[Registrierung und Account-Verwaltung](../account.mdx)" beschrieben ist. +:::note Zielgruppe +Die folgenden Seiten beinhalten teils sehr technische Detailinformationen zur Umsetzung einer Anbindung an die FIT-Connect-Schnittstellen. Zielgruppe der folgenden Seiten sind vorangig Entwickler:innen. ::: Kern von FIT-Connect ist der Zustelldienst, der sendende und empfangende Systeme einer Einreichung verbindet. diff --git a/docs/overview.md b/docs/intro.md similarity index 100% rename from docs/overview.md rename to docs/intro.md diff --git a/docs/sidebar.js b/docs/sidebar.js index 31d85d1b119cd20ec9a51d87459a3c047cf6dded..82d7d15723d9dc0ebc8d97e050ebdb90654f7b77 100644 --- a/docs/sidebar.js +++ b/docs/sidebar.js @@ -11,7 +11,7 @@ module.exports = { defaultSidebar: [ - 'overview', + 'intro', 'roadmap', 'changelog', 'account',