Added translations

This commit is contained in:
Nicolai Ort 2021-02-15 18:00:35 +01:00
parent c3fec8b375
commit 769251c062
4 changed files with 129 additions and 40 deletions

View File

@ -3,6 +3,8 @@
The documentation for the LfK! 'Läufersystem'.
Powered by Vuepress.
The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school).
## Quickstart 🐳
> Use this to run the documentation server via docker.

View File

@ -1,8 +1,18 @@
const { description } = require('../../package')
module.exports = {
title: 'LfK! Dokumentation',
description: description,
locales: {
'/': {
lang: 'de-DE',
title: 'LfK! Dokumentation',
description: 'Dokumentation für das Lauf für Kaya! Läufersystem'
},
'/en/': {
lang: 'en-US',
title: 'LfK! Documentation',
description: 'The official documentation for the LfK! "Läufersystem"'
}
},
head: [
['meta', { name: 'theme-color', content: '#3eaf7c' }],
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
@ -15,46 +25,97 @@ module.exports = {
docsDir: '',
editLinkText: '',
lastUpdated: false,
nav: [
{
text: 'Für Nutzer',
link: '/users/',
locales: {
'/': {
selectText: 'Sprachen',
label: 'Deutsch (German)',
nav: [
{
text: 'Für Nutzer',
link: '/users/',
},
{
text: 'Für Admins',
link: '/admins/'
},
{
text: 'Source Code',
link: 'https://git.odit.services/lfk'
}
],
sidebar: {
'/users/': [
{
title: 'Nutzerdokumentation',
collapsable: false,
children: [
'',
'accounts',
'organizations',
'teams',
'runners',
'runner_import'
]
}
],
'/admins/': [
{
title: 'Administrative Dokumentation',
collapsable: false,
children: [
'',
'quickstart',
'installation'
]
}
],
}
},
{
text: 'Für Admins',
link: '/admins/'
},
{
text: 'Source Code',
link: 'https://git.odit.services/lfk'
'/en/': {
selectText: 'Languages',
label: 'English',
nav: [
{
text: 'For Users',
link: '/en/users/',
},
{
text: 'For Admins',
link: '/en/admins/'
},
{
text: 'Source Code',
link: 'https://git.odit.services/lfk'
}
],
sidebar: {
'/en/users/': [
{
title: 'User documentation',
collapsable: false,
children: [
'',
'accounts',
'organizations',
'teams',
'runners',
'runner_import'
]
}
],
'/en/admins/': [
{
title: 'Administrative Dokumentation',
collapsable: false,
children: [
'',
'quickstart',
'installation'
]
}
],
}
}
],
sidebar: {
'/users/': [
{
title: 'Nutzerdokumentation',
collapsable: false,
children: [
'',
'accounts',
'organizations',
'teams',
'runners',
'runner_import'
]
}
],
'/admins/': [
{
title: 'Administrative Dokumentation',
collapsable: false,
children: [
'',
'quickstart',
'installation'
]
}
],
}
},
plugins: [

15
src/en/index.md Normal file
View File

@ -0,0 +1,15 @@
---
home: true
heroImage: https://v1.vuepress.vuejs.org/hero.png
tagline: The documentatio für the LfK! "Läufersystem".
actionText: Quickstart for users →
actionLink: ./users/
features:
- title: Feature 1 Title
details: Feature 1 Description
- title: Feature 2 Title
details: Feature 2 Description
- title: Feature 3 Title
details: Feature 3 Description
footer: Made by with ❤️
---

11
src/en/users/README.md Normal file
View File

@ -0,0 +1,11 @@
# Introduction
This part of the documentation describes the interaction with the system for normal users.
If you're interested in installing, configuring or administrating the system take a look at the [admin](../admins) section.
## FAQ
> A couple of frequently asked questiones.
### Why can't i see the page XY?
Users can only see pages if they have the right permissions.
If you can't view a page that you need to, please contact your administrator.