Skip to content

Commit

Permalink
Merge pull request #495 from it-at-m/update-docu
Browse files Browse the repository at this point in the history
update der vitepress doku
  • Loading branch information
vjohnslhm authored Nov 6, 2024
2 parents f0b316f + 47b3095 commit 8810f24
Show file tree
Hide file tree
Showing 16 changed files with 24 additions and 21 deletions.
40 changes: 20 additions & 20 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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_FEATURES = '/features/';
const PATH_GUIDES = '/guides/';
const PATH_GUIDES = PATH_TECHNIK + '/guides/';
const PATH_SERVICES = '/services/';

// https://vitepress.dev/reference/site-config
export default withMermaid({
Expand All @@ -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: '/services/'},
{text: 'Technik', link: PATH_TECHNIK}
],

Expand All @@ -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: 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`},
]
},
{
text: 'Coding Conventions', link: `${PATH_CODING_CONVENTIONS}`, collapsed: true, items: [
{text: 'Naming Convention - Testing', link: `${PATH_CODING_CONVENTIONS}tests_naming`},
Expand Down Expand Up @@ -62,22 +66,18 @@ 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/`},
{text: 'Admin-Service', link: `${PATH_FEATURES}admin-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/`},
{text: 'Admin-Service', link: `${PATH_SERVICES}admin-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: [
Expand Down
2 changes: 1 addition & 1 deletion docs/src/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
🚧 Eine detaillierte Beschreibung aller [Funktionen](/services/) folgt im Laufe der Veröffentlichung.
Empty file removed docs/src/guides/index.md
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/src/technik/guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Guides

Hier werden nützliche Tipps und Tricks gesammelt, sowie Tutorials und Anleitungen für bestimmte Vorgänge.
File renamed without changes.

0 comments on commit 8810f24

Please sign in to comment.