diff --git a/.glossary.yaml b/.glossary.yaml index 6fdfceb055d377ec1e41cc8df4656407f7e90598..a24b3ad381cfe17942ce5586660c31b53965a5fc 100644 --- a/.glossary.yaml +++ b/.glossary.yaml @@ -1,3 +1,6 @@ HTML: HyperText Markup Language API: Application Programming Interface -URL: Uniform Resource Locator \ No newline at end of file +URL: Uniform Resource Locator +JSON: JavaScript Object Notation +CI pipeline: Continuous Integration Pipeline +TBD: To Be Discussed \ No newline at end of file diff --git a/src/pages/_document.tsx b/src/pages/_document.tsx new file mode 100644 index 0000000000000000000000000000000000000000..138cd8d1028399b44aa1211034b393cfead4e77b --- /dev/null +++ b/src/pages/_document.tsx @@ -0,0 +1,13 @@ +import { Html, Head, Main, NextScript } from 'next/document' + +export default function Document() { + return ( + <Html lang="en"> + <Head /> + <body> + <Main /> + <NextScript /> + </body> + </Html> + ) +} diff --git a/src/pages/_meta.ts b/src/pages/_meta.ts index 0795a1c521751ce490036cf82cb9ccdc4a621ba9..bc5576f65f253dc5b9b82757fd7c5f757eb0b8f5 100644 --- a/src/pages/_meta.ts +++ b/src/pages/_meta.ts @@ -8,4 +8,7 @@ export default { href: 'https://opencode.de/en', newWindow: true, }, + 'declaration-on-accessibility': { + display: 'hidden', + }, } diff --git a/src/pages/concepts/configuration/index.mdx b/src/pages/concepts/configuration/index.mdx index c00e6af4dc0ec0fb13d78f1a8e22ff94d1b3fab4..b7ee36d880bba8f4067ea5ae0a7b6afa1e762769 100644 --- a/src/pages/concepts/configuration/index.mdx +++ b/src/pages/concepts/configuration/index.mdx @@ -6,7 +6,10 @@ import { Callout } from 'nextra/components' You can find the configuration file of the official instance [here →](https://gitlab.opencode.de/open-code/badgebackend/badge-api/-/blob/main/.badge-api.yaml) </Callout> -The `.badge-api.yaml` configuration file defines a list of badges, their levels and their criteria. The file is structured as follows: +The `.badge-api.yaml` configuration file defines a list of badges, their levels and their criteria. The file is structured as follows. + +Find an overview of the implemented checks [here →](/concepts/implemented-checks).<br /> +Details about manual checks can be found [here →](/concepts/configuration/manual-checks). ```yaml filename=".badge-api.yaml" copy badges: diff --git a/src/pages/declaration-on-accessibility.mdx b/src/pages/declaration-on-accessibility.mdx new file mode 100644 index 0000000000000000000000000000000000000000..f226dc8998cac7e0aadbd117f06434570d50714c --- /dev/null +++ b/src/pages/declaration-on-accessibility.mdx @@ -0,0 +1,5 @@ +# Declaration on accessibility +The Center for Digital Sovereignty of Public Administration (ZenDiS) GmbH endeavors +to make its digital offerings accessible in accordance with the provisions of the +Disability Equality Act (BGG) and the Accessible Information Technology Ordinance (BITV 2.0) +for the implementation of Directive (EU) 2016/2102. \ No newline at end of file diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 94f083a0be1c1a0d4c787f26977fb992b4c6543d..9878ad6d64b102021e400f6e0d63b9bb3e6e4e4f 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -5,10 +5,10 @@ title: Introduction # Badge API -<div className="flex justify-center"><img src="/assets/badges/badges-stacked.svg" className="h-32"/></div> +<div className="flex justify-center"><img src="/assets/badges/badges-stacked.svg" alt="Badges" className="h-32"/></div> The Badge API is a service scanning repositories for specific criteria and generating badges based on the results. -The badges are displayed in the Open CoDE software catalog and indicate the status of the repository in terms of **security**, **maintenance**, and **reuse**. +The badges are displayed in the [OpenCode software catalog](https://opencode.de/en/software) and indicate the status of the repository in terms of **security**, **maintenance**, and **reuse**. You can interact with the Badge API by submitting a repository URL and receiving a badge based on the criteria that the repository meets. The API will provide you a detailed explanation of the result too. diff --git a/theme.config.tsx b/theme.config.tsx index 65c66f363f5f51fcb97ed1b0458fe8de294ef84d..8a4cee88924ceaff7ff88b82d4a6b6b2c7359772 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -2,6 +2,8 @@ import React from 'react' import { DocsThemeConfig, useConfig } from 'nextra-theme-docs' import Image from 'next/image' import { useRouter } from 'next/router' +import Link from 'next/link' +import { ExclamationCircleIcon } from '@heroicons/react/24/outline' const config: DocsThemeConfig = { head() { @@ -61,7 +63,7 @@ const config: DocsThemeConfig = { icon: ( <Image src="/opencode-icon.svg" - alt="Open CoDE Icon" + alt="OpenCode Icon" width={32} height={32} /> @@ -95,25 +97,40 @@ const config: DocsThemeConfig = { footer: { content: ( <div className="flex w-full flex-col items-center text-sm sm:items-start"> - <div className="grid grid-cols-2 gap-4"> - <a - className="text-blue-500 hover:text-blue-300" + <div className="flex space-x-6"> + <Link + className="text-blue-600 hover:text-blue-400" title="Impressum" href="https://opencode.de/de/impressum" target="_blank" rel="noopener noreferrer" > - <span>Impressum</span> - </a> - <a - className="text-blue-500 hover:text-blue-300" + Imprint + </Link> + <Link + className="text-blue-600 hover:text-blue-400" title="Datenschutz" href="https://opencode.de/de/datenschutz" target="_blank" rel="noopener noreferrer" > - <span>Datenschutz</span> - </a> + Data Privacy + </Link> + <Link + className="text-blue-600 hover:text-blue-400" + title="Datenschutz" + href="/declaration-on-accessibility" + > + Declaration on accessibility + </Link> + <Link + className="text-blue-600 hover:text-blue-400" + title="Datenschutz" + href="mailto:info@opencode.de" + > + <ExclamationCircleIcon className="-mt-1 mr-1 inline h-4 w-4" /> + Feedback on barriers + </Link> </div> <p className="mt-4"> © {new Date().getFullYear()} Zentrum für Digitale