From fb422d8a123d9588a227cf023a0da4b9bdd0c55d Mon Sep 17 00:00:00 2001 From: Marco Holz <marco.holz@fitko.de> Date: Fri, 20 Aug 2021 08:01:54 +0000 Subject: [PATCH] =?UTF-8?q?Update=20title=20of=20"=C3=9Cberblick"=20pages?= =?UTF-8?q?=20+=20additional=20hints?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/getting-started/authentication.mdx | 4 ++++ docs/getting-started/overview.md | 8 ++++---- docs/{overview.md => intro.md} | 0 docs/sidebar.js | 2 +- 4 files changed, 9 insertions(+), 5 deletions(-) rename docs/{overview.md => intro.md} (100%) diff --git a/docs/getting-started/authentication.mdx b/docs/getting-started/authentication.mdx index 3a57f6cef..5db48559b 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 c4a99f581..82ba14f35 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 31d85d1b1..82d7d1572 100644 --- a/docs/sidebar.js +++ b/docs/sidebar.js @@ -11,7 +11,7 @@ module.exports = { defaultSidebar: [ - 'overview', + 'intro', 'roadmap', 'changelog', 'account', -- GitLab