From 30f7ca11a3a91b818be7a4eccca846001446fd64 Mon Sep 17 00:00:00 2001 From: vjohnslhm <145964798+vjohnslhm@users.noreply.github.com> Date: Wed, 16 Oct 2024 16:25:34 +0200 Subject: [PATCH 1/3] update styling + reorganize vitepress docu --- docs/.vitepress/config.mts | 16 ++++++++-------- docs/.vitepress/theme/custom.css | 6 ++++++ docs/.vitepress/theme/index.ts | 1 + docs/src/guides/index.md | 0 .../how-to-create-client-from-open-api-json.md | 0 docs/src/technik/guides/index.md | 3 +++ docs/src/{ => technik}/guides/tips-and-tricks.md | 0 7 files changed, 18 insertions(+), 8 deletions(-) create mode 100644 docs/.vitepress/theme/custom.css delete mode 100644 docs/src/guides/index.md rename docs/src/{ => technik}/guides/how-to-create-client-from-open-api-json.md (100%) create mode 100644 docs/src/technik/guides/index.md rename docs/src/{ => technik}/guides/tips-and-tricks.md (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 60897fdc4..69070e23b 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -3,8 +3,8 @@ import {withMermaid} from "vitepress-plugin-mermaid" const PATH_TECHNIK = '/technik/'; const PATH_CODING_CONVENTIONS = PATH_TECHNIK + 'coding_conventions/'; const PATH_ADR = PATH_TECHNIK + 'adr/'; +const PATH_GUIDES = PATH_TECHNIK + '/guides/'; const PATH_FEATURES = '/features/'; -const PATH_GUIDES = '/guides/'; // https://vitepress.dev/reference/site-config export default withMermaid({ @@ -16,10 +16,8 @@ export default withMermaid({ themeConfig: { // https://vitepress.dev/reference/default-theme-config nav: [ - {text: 'Home', link: '/'}, {text: 'About', link: '/about/'}, - {text: 'Features', link: '/features/'}, - {text: 'Guides', link: PATH_GUIDES}, + {text: 'Services', link: '/features/'}, {text: 'Technik', link: PATH_TECHNIK} ], @@ -34,6 +32,12 @@ export default withMermaid({ text: 'Getting Started', link: `${PATH_TECHNIK}get_started/` }, {text: 'Entwicklungsumgebung', link: `${PATH_TECHNIK}development/`}, + { + text: 'Guides', link: `${PATH_GUIDES}`, collapsed: false, items: [ + {text: 'API-Client generieren', link: `${PATH_GUIDES}how-to-create-client-from-open-api-json.md`}, + {text: 'Tips und Tricks', link: `${PATH_GUIDES}tips-and-tricks.md`}, + ] + }, { text: 'Coding Conventions', link: `${PATH_CODING_CONVENTIONS}`, collapsed: true, items: [ {text: 'Naming Convention - Testing', link: `${PATH_CODING_CONVENTIONS}tests_naming`}, @@ -73,10 +77,6 @@ export default withMermaid({ {text: 'Auth-Service', link: `${PATH_FEATURES}auth-service/`}, {text: 'Vorfälle und Vorkommnisse-Service', link: `${PATH_FEATURES}vorfaelleundvorkommnisse-service/`}, ], - [PATH_GUIDES]: [ - {text: 'API-Client generieren', link: `${PATH_GUIDES}how-to-create-client-from-open-api-json.md`}, - {text: 'Tips und Tricks', link: `${PATH_GUIDES}tips-and-tricks.md`}, - ] }, socialLinks: [ diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css new file mode 100644 index 000000000..fc4b4a3a4 --- /dev/null +++ b/docs/.vitepress/theme/custom.css @@ -0,0 +1,6 @@ +/* .vitepress/theme/custom.css */ + +.VPNavBarMenu a.active { + background-color: #f1f1f1f1; + border-radius: 15px; +} \ No newline at end of file diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index 6f30a118f..cdb2c6299 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,6 +1,7 @@ // .vitepress/theme/index.ts import type {Theme} from "vitepress"; import DefaultTheme from "vitepress/theme"; +import './custom.css' import status from "../components/adr/status.vue"; import statusOverview from "../components/adr/status/overview.vue"; diff --git a/docs/src/guides/index.md b/docs/src/guides/index.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/src/guides/how-to-create-client-from-open-api-json.md b/docs/src/technik/guides/how-to-create-client-from-open-api-json.md similarity index 100% rename from docs/src/guides/how-to-create-client-from-open-api-json.md rename to docs/src/technik/guides/how-to-create-client-from-open-api-json.md diff --git a/docs/src/technik/guides/index.md b/docs/src/technik/guides/index.md new file mode 100644 index 000000000..75381322c --- /dev/null +++ b/docs/src/technik/guides/index.md @@ -0,0 +1,3 @@ +# Guides + +Hier werden nützliche Tipps und Tricks gesammelt, sowie Tutorials und Anleitungen für bestimmte Vorgänge. \ No newline at end of file diff --git a/docs/src/guides/tips-and-tricks.md b/docs/src/technik/guides/tips-and-tricks.md similarity index 100% rename from docs/src/guides/tips-and-tricks.md rename to docs/src/technik/guides/tips-and-tricks.md From a109f478e0698f1fe97a33e8dd92fba7178a6011 Mon Sep 17 00:00:00 2001 From: vjohnslhm <145964798+vjohnslhm@users.noreply.github.com> Date: Fri, 25 Oct 2024 11:45:46 +0200 Subject: [PATCH 2/3] =?UTF-8?q?r=C3=BCckmeldung=20aus=20review=20eingearbe?= =?UTF-8?q?itet?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 26 +++++++++---------- docs/.vitepress/theme/custom.css | 6 ----- docs/.vitepress/theme/index.ts | 1 - .../auth-service/index.md | 0 .../basisdaten-service/index.md | 0 .../briefwahl-service/index.md | 0 .../eai-service/index.md | 0 .../ergebnismeldung-service/index.md | 0 docs/src/{features => services}/index.md | 0 .../infomanagement-service/index.md | 0 .../monitoring-service/index.md | 0 .../vorfaelleundvorkommnisse-service/index.md | 0 .../wahlvorstand-service/index.md | 0 13 files changed, 13 insertions(+), 20 deletions(-) delete mode 100644 docs/.vitepress/theme/custom.css rename docs/src/{features => services}/auth-service/index.md (100%) rename docs/src/{features => services}/basisdaten-service/index.md (100%) rename docs/src/{features => services}/briefwahl-service/index.md (100%) rename docs/src/{features => services}/eai-service/index.md (100%) rename docs/src/{features => services}/ergebnismeldung-service/index.md (100%) rename docs/src/{features => services}/index.md (100%) rename docs/src/{features => services}/infomanagement-service/index.md (100%) rename docs/src/{features => services}/monitoring-service/index.md (100%) rename docs/src/{features => services}/vorfaelleundvorkommnisse-service/index.md (100%) rename docs/src/{features => services}/wahlvorstand-service/index.md (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 69070e23b..84edae257 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -4,7 +4,7 @@ const PATH_TECHNIK = '/technik/'; const PATH_CODING_CONVENTIONS = PATH_TECHNIK + 'coding_conventions/'; const PATH_ADR = PATH_TECHNIK + 'adr/'; const PATH_GUIDES = PATH_TECHNIK + '/guides/'; -const PATH_FEATURES = '/features/'; +const PATH_SERVICES = '/services/'; // https://vitepress.dev/reference/site-config export default withMermaid({ @@ -17,7 +17,7 @@ export default withMermaid({ // https://vitepress.dev/reference/default-theme-config nav: [ {text: 'About', link: '/about/'}, - {text: 'Services', link: '/features/'}, + {text: 'Services', link: '/services/'}, {text: 'Technik', link: PATH_TECHNIK} ], @@ -33,7 +33,7 @@ export default withMermaid({ }, {text: 'Entwicklungsumgebung', link: `${PATH_TECHNIK}development/`}, { - text: 'Guides', link: `${PATH_GUIDES}`, collapsed: false, items: [ + text: 'Guides', link: `${PATH_GUIDES}`, collapsed: true, items: [ {text: 'API-Client generieren', link: `${PATH_GUIDES}how-to-create-client-from-open-api-json.md`}, {text: 'Tips und Tricks', link: `${PATH_GUIDES}tips-and-tricks.md`}, ] @@ -66,16 +66,16 @@ export default withMermaid({ ] } ], - [PATH_FEATURES]: [ - {text: 'Briefwahl-Service', link: `${PATH_FEATURES}briefwahl-service/`}, - {text: 'Infomanagement-Service', link: `${PATH_FEATURES}infomanagement-service/`}, - {text: 'EAI-Service', link: `${PATH_FEATURES}eai-service/`}, - {text: 'Basisdaten-Service', link: `${PATH_FEATURES}basisdaten-service/`}, - {text: 'Monitoring-Service', link: `${PATH_FEATURES}monitoring-service/`}, - {text: 'Wahlvorstand-Service', link: `${PATH_FEATURES}wahlvorstand-service/`}, - {text: 'Ergebnismeldung-Service', link: `${PATH_FEATURES}ergebnismeldung-service/`}, - {text: 'Auth-Service', link: `${PATH_FEATURES}auth-service/`}, - {text: 'Vorfälle und Vorkommnisse-Service', link: `${PATH_FEATURES}vorfaelleundvorkommnisse-service/`}, + [PATH_SERVICES]: [ + {text: 'Briefwahl-Service', link: `${PATH_SERVICES}briefwahl-service/`}, + {text: 'Infomanagement-Service', link: `${PATH_SERVICES}infomanagement-service/`}, + {text: 'EAI-Service', link: `${PATH_SERVICES}eai-service/`}, + {text: 'Basisdaten-Service', link: `${PATH_SERVICES}basisdaten-service/`}, + {text: 'Monitoring-Service', link: `${PATH_SERVICES}monitoring-service/`}, + {text: 'Wahlvorstand-Service', link: `${PATH_SERVICES}wahlvorstand-service/`}, + {text: 'Ergebnismeldung-Service', link: `${PATH_SERVICES}ergebnismeldung-service/`}, + {text: 'Auth-Service', link: `${PATH_SERVICES}auth-service/`}, + {text: 'Vorfälle und Vorkommnisse-Service', link: `${PATH_SERVICES}vorfaelleundvorkommnisse-service/`}, ], }, diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css deleted file mode 100644 index fc4b4a3a4..000000000 --- a/docs/.vitepress/theme/custom.css +++ /dev/null @@ -1,6 +0,0 @@ -/* .vitepress/theme/custom.css */ - -.VPNavBarMenu a.active { - background-color: #f1f1f1f1; - border-radius: 15px; -} \ No newline at end of file diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index cdb2c6299..6f30a118f 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,7 +1,6 @@ // .vitepress/theme/index.ts import type {Theme} from "vitepress"; import DefaultTheme from "vitepress/theme"; -import './custom.css' import status from "../components/adr/status.vue"; import statusOverview from "../components/adr/status/overview.vue"; diff --git a/docs/src/features/auth-service/index.md b/docs/src/services/auth-service/index.md similarity index 100% rename from docs/src/features/auth-service/index.md rename to docs/src/services/auth-service/index.md diff --git a/docs/src/features/basisdaten-service/index.md b/docs/src/services/basisdaten-service/index.md similarity index 100% rename from docs/src/features/basisdaten-service/index.md rename to docs/src/services/basisdaten-service/index.md diff --git a/docs/src/features/briefwahl-service/index.md b/docs/src/services/briefwahl-service/index.md similarity index 100% rename from docs/src/features/briefwahl-service/index.md rename to docs/src/services/briefwahl-service/index.md diff --git a/docs/src/features/eai-service/index.md b/docs/src/services/eai-service/index.md similarity index 100% rename from docs/src/features/eai-service/index.md rename to docs/src/services/eai-service/index.md diff --git a/docs/src/features/ergebnismeldung-service/index.md b/docs/src/services/ergebnismeldung-service/index.md similarity index 100% rename from docs/src/features/ergebnismeldung-service/index.md rename to docs/src/services/ergebnismeldung-service/index.md diff --git a/docs/src/features/index.md b/docs/src/services/index.md similarity index 100% rename from docs/src/features/index.md rename to docs/src/services/index.md diff --git a/docs/src/features/infomanagement-service/index.md b/docs/src/services/infomanagement-service/index.md similarity index 100% rename from docs/src/features/infomanagement-service/index.md rename to docs/src/services/infomanagement-service/index.md diff --git a/docs/src/features/monitoring-service/index.md b/docs/src/services/monitoring-service/index.md similarity index 100% rename from docs/src/features/monitoring-service/index.md rename to docs/src/services/monitoring-service/index.md diff --git a/docs/src/features/vorfaelleundvorkommnisse-service/index.md b/docs/src/services/vorfaelleundvorkommnisse-service/index.md similarity index 100% rename from docs/src/features/vorfaelleundvorkommnisse-service/index.md rename to docs/src/services/vorfaelleundvorkommnisse-service/index.md diff --git a/docs/src/features/wahlvorstand-service/index.md b/docs/src/services/wahlvorstand-service/index.md similarity index 100% rename from docs/src/features/wahlvorstand-service/index.md rename to docs/src/services/wahlvorstand-service/index.md From 733df242eac3cbd65d154e9b06cad29cfb2d260e Mon Sep 17 00:00:00 2001 From: vjohnslhm <145964798+vjohnslhm@users.noreply.github.com> Date: Fri, 25 Oct 2024 11:59:35 +0200 Subject: [PATCH 3/3] eliminate dead link --- docs/src/about/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/about/index.md b/docs/src/about/index.md index 621ceba51..a787fb2b4 100644 --- a/docs/src/about/index.md +++ b/docs/src/about/index.md @@ -21,4 +21,4 @@ Dazu gibt es zahlreiche Regeln und Konsistenzprüfungen, die dem Wahlvorstand Fe Das Wahlamt kann über das System den Wahlbezirken wichtige Informationen zukommen lassen. -🚧 Eine detaillierte Beschreibung aller [Funktionen](/features/) folgt im Laufe der Veröffentlichung. \ No newline at end of file +🚧 Eine detaillierte Beschreibung aller [Funktionen](/services/) folgt im Laufe der Veröffentlichung. \ No newline at end of file