From dc0b8ff85c5b865c547bc820709d03c9a0693869 Mon Sep 17 00:00:00 2001 From: Thomas Georgios Giannos Date: Mon, 13 May 2024 16:59:11 +0300 Subject: [PATCH] Added index pages, giving the option to add documentation on root paths, like in the administration section --- .../documentation/administration/blueprints/index.md | 10 +++++----- .../blueprints/prefilling-configurations.md | 2 +- docs/docs/documentation/administration/introduction.md | 4 ++-- .../documentation/administration/reference-types.md | 2 +- .../documentation/administration/templates/index.md | 2 +- docs/docs/documentation/application/_category_.json | 3 ++- .../application/descriptions/_category_.json | 3 ++- .../documentation/application/descriptions/index.md | 5 +++++ docs/docs/documentation/application/index.md | 5 +++++ .../documentation/application/plans/_category_.json | 3 ++- docs/docs/documentation/application/plans/index.md | 5 +++++ docs/docs/documentation/for-devs/_category_.json | 3 ++- docs/docs/documentation/for-devs/apis/_category_.json | 3 ++- docs/docs/documentation/for-devs/apis/index.md | 5 +++++ .../for-devs/authentication/_category_.json | 3 ++- .../documentation/for-devs/authentication/index.md | 5 +++++ docs/docs/documentation/for-devs/index.md | 5 +++++ .../docs/documentation/getting-started/_category_.json | 3 ++- docs/docs/documentation/getting-started/index.md | 5 +++++ .../supplementary-services/_category_.json | 3 ++- .../docs/documentation/supplementary-services/index.md | 5 +++++ .../notifications/_category_.json | 3 ++- .../supplementary-services/notifications/index.md | 5 +++++ docs/docusaurus.config.ts | 8 ++++---- 24 files changed, 77 insertions(+), 23 deletions(-) create mode 100644 docs/docs/documentation/application/descriptions/index.md create mode 100644 docs/docs/documentation/application/index.md create mode 100644 docs/docs/documentation/application/plans/index.md create mode 100644 docs/docs/documentation/for-devs/apis/index.md create mode 100644 docs/docs/documentation/for-devs/authentication/index.md create mode 100644 docs/docs/documentation/for-devs/index.md create mode 100644 docs/docs/documentation/getting-started/index.md create mode 100644 docs/docs/documentation/supplementary-services/index.md create mode 100644 docs/docs/documentation/supplementary-services/notifications/index.md diff --git a/docs/docs/documentation/administration/blueprints/index.md b/docs/docs/documentation/administration/blueprints/index.md index b77e1b834..5268ecdfe 100644 --- a/docs/docs/documentation/administration/blueprints/index.md +++ b/docs/docs/documentation/administration/blueprints/index.md @@ -6,7 +6,7 @@ In this page, there is a listing where you can view details about all the availa :::info -**Plan Blueprints** describe how a [Plan](/docs/category/plans) is structured. All the sections and fields a Plan is consisting of, are referenced here. More details will follow in the next sections. +**Plan Blueprints** describe how a [Plan](/docs/documentation/application/plans) is structured. All the sections and fields a Plan is consisting of, are referenced here. More details will follow in the next sections. ::: @@ -96,12 +96,12 @@ Every section must have a `System` field of the following types: `Title`, `Descr ### Description Templates form -Each section can have one or more **description templates** attached to it. When you 'attach' a [description template](/docs/documentation/administration/templates/) to a blueprint, every [plan](/docs/category/plans) that inherits from that blueprint must have a [description](/docs/category/descriptions) that inherits from that template. More details will follow. You can add a description template by clicking on the `Add Description Template` button. For every template you add, a new form part appears where you can specify everything about the template attachment. You can also delete one template clicking on the `delete` icon on the right end of its form. +Each section can have one or more **description templates** attached to it. When you 'attach' a [description template](/docs/documentation/administration/templates/) to a blueprint, every [plan](/docs/documentation/application/plans) that inherits from that blueprint must have a [description](/docs/documentation/application/descriptions) that inherits from that template. More details will follow. You can add a description template by clicking on the `Add Description Template` button. For every template you add, a new form part appears where you can specify everything about the template attachment. You can also delete one template clicking on the `delete` icon on the right end of its form. - **Description Template**: The [template](/docs/documentation/administration/templates/) you want to add. - **Label**: A label for the template. -- **Min Multiplicity**: The minimum amount of [descriptions](/docs/category/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/category/plans) based on this blueprint has to have. -- **Max Multiplicity**: The maximum amount of [descriptions](/docs/category/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/category/plans) based on this blueprint has to have. +- **Min Multiplicity**: The minimum amount of [descriptions](/docs/documentation/application/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/documentation/application/plans) based on this blueprint has to have. +- **Max Multiplicity**: The maximum amount of [descriptions](/docs/documentation/application/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/documentation/application/plans) based on this blueprint has to have. :::tip @@ -116,7 +116,7 @@ Let's clarify a little bit more about our description multiplicity options. Ther ### Prefilling Sources form -Here, we specify which of the available prefilling sources will be available for the user to select, when he creates a [plan](/docs/category/plans) using this blueprint. We will explore how these are configured in detail in the [Prefilling Configurations](/docs/documentation/administration/blueprints/prefilling-configurations) section. +Here, we specify which of the available prefilling sources will be available for the user to select, when he creates a [plan](/docs/documentation/application/plans) using this blueprint. We will explore how these are configured in detail in the [Prefilling Configurations](/docs/documentation/administration/blueprints/prefilling-configurations) section. --- diff --git a/docs/docs/documentation/administration/blueprints/prefilling-configurations.md b/docs/docs/documentation/administration/blueprints/prefilling-configurations.md index 6f9de924a..db915480c 100644 --- a/docs/docs/documentation/administration/blueprints/prefilling-configurations.md +++ b/docs/docs/documentation/administration/blueprints/prefilling-configurations.md @@ -5,7 +5,7 @@ description: View details about the prefilling sources # Prefilling Configurations -In this page, there is a listing where you can view details about all the configured prefilling sources. These are data sources coming outside of the platform, in order to help the user with filling out a [plan](/docs/category/plans) form with some basic information. +In this page, there is a listing where you can view details about all the configured prefilling sources. These are data sources coming outside of the platform, in order to help the user with filling out a [plan](/docs/documentation/application/plans) form with some basic information. The information displayed by default is: the `label` of the source, the `status` and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display. diff --git a/docs/docs/documentation/administration/introduction.md b/docs/docs/documentation/administration/introduction.md index 4a82c2ee2..eeec0e6f3 100644 --- a/docs/docs/documentation/administration/introduction.md +++ b/docs/docs/documentation/administration/introduction.md @@ -12,5 +12,5 @@ There are a lot of views in the application available only for users that are gi - **Notification Templates**: Being able to modify the structure of notifications sent to users based on different events. - **Languages**: Being able to add support for more languages or modify existing ones. - **Reference Types**: Being able to configure static or external data sources that are made available as autocomplete fields on the forms of the platform. -- **Plan Blueprints**: Being able to control the blueprints available for [plans](/docs/category/plans). -- **Description Templates**: Being able to control the templates available for [descriptions](/docs/category/descriptions) \ No newline at end of file +- **Plan Blueprints**: Being able to control the blueprints available for [plans](/docs/documentation/application/plans). +- **Description Templates**: Being able to control the templates available for [descriptions](/docs/documentation/application/descriptions) \ No newline at end of file diff --git a/docs/docs/documentation/administration/reference-types.md b/docs/docs/documentation/administration/reference-types.md index a5e24f9a3..85e0b76ad 100644 --- a/docs/docs/documentation/administration/reference-types.md +++ b/docs/docs/documentation/administration/reference-types.md @@ -9,7 +9,7 @@ In this page, there is a listing where you can view details about all the availa :::info -A **reference type** is any type of information that is made available to the users when they fill [plan](/docs/category/plans) forms. This information is either static, or coming from an outside source (*an external API*). These sources are extremely configurable as we will see in this section. +A **reference type** is any type of information that is made available to the users when they fill [plan](/docs/documentation/application/plans) forms. This information is either static, or coming from an outside source (*an external API*). These sources are extremely configurable as we will see in this section. ::: diff --git a/docs/docs/documentation/administration/templates/index.md b/docs/docs/documentation/administration/templates/index.md index 151ff298d..52c6a69f5 100644 --- a/docs/docs/documentation/administration/templates/index.md +++ b/docs/docs/documentation/administration/templates/index.md @@ -8,7 +8,7 @@ In this page, there is a listing where you can view details about all the availa :::info -**Description Templates** describe how a [Description](/docs/category/descriptions) is structured. All the chapters and fields a Description is consisting of, are referenced here. More details will follow in the next sections. +**Description Templates** describe how a [Description](/docs/documentation/application/descriptions) is structured. All the chapters and fields a Description is consisting of, are referenced here. More details will follow in the next sections. ::: diff --git a/docs/docs/documentation/application/_category_.json b/docs/docs/documentation/application/_category_.json index da3331abf..af5b0e5b9 100644 --- a/docs/docs/documentation/application/_category_.json +++ b/docs/docs/documentation/application/_category_.json @@ -2,6 +2,7 @@ "label": "Application", "position": 2, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/_category_.json b/docs/docs/documentation/application/descriptions/_category_.json index 2bb33e9ef..ec3ccecaa 100644 --- a/docs/docs/documentation/application/descriptions/_category_.json +++ b/docs/docs/documentation/application/descriptions/_category_.json @@ -2,6 +2,7 @@ "label": "Descriptions", "position": 6, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/index.md b/docs/docs/documentation/application/descriptions/index.md new file mode 100644 index 000000000..5dd459352 --- /dev/null +++ b/docs/docs/documentation/application/descriptions/index.md @@ -0,0 +1,5 @@ +# Descriptions + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/application/index.md b/docs/docs/documentation/application/index.md new file mode 100644 index 000000000..5ae0f6ba3 --- /dev/null +++ b/docs/docs/documentation/application/index.md @@ -0,0 +1,5 @@ +# Application + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/_category_.json b/docs/docs/documentation/application/plans/_category_.json index 02fcb2623..41d2fd6cb 100644 --- a/docs/docs/documentation/application/plans/_category_.json +++ b/docs/docs/documentation/application/plans/_category_.json @@ -2,6 +2,7 @@ "label": "Plans", "position": 5, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/index.md b/docs/docs/documentation/application/plans/index.md new file mode 100644 index 000000000..dc4983bf9 --- /dev/null +++ b/docs/docs/documentation/application/plans/index.md @@ -0,0 +1,5 @@ +# Plans + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/for-devs/_category_.json b/docs/docs/documentation/for-devs/_category_.json index 394d4ebd2..daf4f5156 100644 --- a/docs/docs/documentation/for-devs/_category_.json +++ b/docs/docs/documentation/for-devs/_category_.json @@ -2,6 +2,7 @@ "label": "For Developers", "position": 5, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/for-devs/apis/_category_.json b/docs/docs/documentation/for-devs/apis/_category_.json index 354f2f640..e45f1b4cc 100644 --- a/docs/docs/documentation/for-devs/apis/_category_.json +++ b/docs/docs/documentation/for-devs/apis/_category_.json @@ -2,6 +2,7 @@ "label": "APIs", "position": 2, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/for-devs/apis/index.md b/docs/docs/documentation/for-devs/apis/index.md new file mode 100644 index 000000000..991d6c997 --- /dev/null +++ b/docs/docs/documentation/for-devs/apis/index.md @@ -0,0 +1,5 @@ +# APIs + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/for-devs/authentication/_category_.json b/docs/docs/documentation/for-devs/authentication/_category_.json index 7334b7853..15a248169 100644 --- a/docs/docs/documentation/for-devs/authentication/_category_.json +++ b/docs/docs/documentation/for-devs/authentication/_category_.json @@ -2,6 +2,7 @@ "label": "Authentication", "position": 1, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/for-devs/authentication/index.md b/docs/docs/documentation/for-devs/authentication/index.md new file mode 100644 index 000000000..a12aea0d0 --- /dev/null +++ b/docs/docs/documentation/for-devs/authentication/index.md @@ -0,0 +1,5 @@ +# Authentication + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/for-devs/index.md b/docs/docs/documentation/for-devs/index.md new file mode 100644 index 000000000..93379b0b8 --- /dev/null +++ b/docs/docs/documentation/for-devs/index.md @@ -0,0 +1,5 @@ +# For Developers + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/getting-started/_category_.json b/docs/docs/documentation/getting-started/_category_.json index 14206eb29..d2d6e6b57 100644 --- a/docs/docs/documentation/getting-started/_category_.json +++ b/docs/docs/documentation/getting-started/_category_.json @@ -2,6 +2,7 @@ "label": "Getting Started", "position": 1, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } diff --git a/docs/docs/documentation/getting-started/index.md b/docs/docs/documentation/getting-started/index.md new file mode 100644 index 000000000..b6ed6fec3 --- /dev/null +++ b/docs/docs/documentation/getting-started/index.md @@ -0,0 +1,5 @@ +# Getting Started + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/supplementary-services/_category_.json b/docs/docs/documentation/supplementary-services/_category_.json index a39ecc7b7..02c0bbe45 100644 --- a/docs/docs/documentation/supplementary-services/_category_.json +++ b/docs/docs/documentation/supplementary-services/_category_.json @@ -2,6 +2,7 @@ "label": "Supplementary Services", "position": 3, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/supplementary-services/index.md b/docs/docs/documentation/supplementary-services/index.md new file mode 100644 index 000000000..46dfdd3aa --- /dev/null +++ b/docs/docs/documentation/supplementary-services/index.md @@ -0,0 +1,5 @@ +# Supplementary Services + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docs/documentation/supplementary-services/notifications/_category_.json b/docs/docs/documentation/supplementary-services/notifications/_category_.json index c55d472b4..f40e3ffca 100644 --- a/docs/docs/documentation/supplementary-services/notifications/_category_.json +++ b/docs/docs/documentation/supplementary-services/notifications/_category_.json @@ -2,6 +2,7 @@ "label": "Notifications", "position": 1, "link": { - "type": "generated-index" + "type": "doc", + "id": "index" } } \ No newline at end of file diff --git a/docs/docs/documentation/supplementary-services/notifications/index.md b/docs/docs/documentation/supplementary-services/notifications/index.md new file mode 100644 index 000000000..10cccfbb7 --- /dev/null +++ b/docs/docs/documentation/supplementary-services/notifications/index.md @@ -0,0 +1,5 @@ +# Notifications + +import DocCardList from '@theme/DocCardList'; + + \ No newline at end of file diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index e8ee9765a..a8d352188 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -91,15 +91,15 @@ const config: Config = { items: [ { label: 'Getting Started', - to: '/docs/category/getting-started', + to: '/docs/documentation/getting-started', }, { label: 'Application', - to: '/docs/category/application', + to: '/docs/documentation/application', }, { label: 'Supplementary Services', - to: '/docs/category/supplementary-services', + to: '/docs/documentation/supplementary-services', }, { label: 'Administration', @@ -107,7 +107,7 @@ const config: Config = { }, { label: 'For Developers', - to: '/docs/category/for-developers', + to: '/docs/documentation/for-devs', }, ], },