Add docs content with dual doc-plugin setup
Signed-off-by: Nick Slowinski <nick@nick-slowinski.de>
Dieser Commit ist enthalten in:
Ursprung
4b75b5653c
Commit
e3e65084d2
GPG-Schlüssel-ID:
A28671573AA347CC
51 geänderte Dateien mit 734 neuen und 550 gelöschten Zeilen
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Tutorial Intro
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Get started by **creating a new site**.
|
||||
|
||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||
|
||||
### What you'll need
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
|
||||
## Generate a new site
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**.
|
||||
|
||||
The classic template will automatically be added to your project after you run the command:
|
||||
|
||||
```bash
|
||||
npm init docusaurus@latest my-website classic
|
||||
```
|
||||
|
||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||
|
||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||
|
||||
## Start your site
|
||||
|
||||
Run the development server:
|
||||
|
||||
```bash
|
||||
cd my-website
|
||||
npm run start
|
||||
```
|
||||
|
||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||
|
||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||
|
||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
{
|
||||
"label": "Tutorial - Basics",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn the most important Docusaurus concepts."
|
||||
}
|
||||
}
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Congratulations!
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
||||
|
||||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
||||
|
||||
## What's next?
|
||||
|
||||
- Read the [official documentation](https://docusaurus.io/)
|
||||
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
|
||||
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create a Blog Post
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
|
||||
```md title="blog/2021-02-28-greetings.md"
|
||||
---
|
||||
slug: greetings
|
||||
title: Greetings!
|
||||
authors:
|
||||
- name: Joel Marcey
|
||||
title: Co-creator of Docusaurus 1
|
||||
url: https://github.com/JoelMarcey
|
||||
image_url: https://github.com/JoelMarcey.png
|
||||
- name: Sébastien Lorber
|
||||
title: Docusaurus maintainer
|
||||
url: https://sebastienlorber.com
|
||||
image_url: https://github.com/slorber.png
|
||||
tags: [greetings]
|
||||
---
|
||||
|
||||
Congratulations, you have made your first post!
|
||||
|
||||
Feel free to play around and edit this post as much as you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create a Document
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
- **versioning**
|
||||
|
||||
## Create your first Doc
|
||||
|
||||
Create a Markdown file at `docs/hello.md`:
|
||||
|
||||
```md title="docs/hello.md"
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
|
||||
|
||||
## Configure the Sidebar
|
||||
|
||||
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
||||
|
||||
Add metadata to customize the sidebar label and position:
|
||||
|
||||
```md title="docs/hello.md" {1-4}
|
||||
---
|
||||
sidebar_label: 'Hi!'
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
It is also possible to create your sidebar explicitly in `sidebars.js`:
|
||||
|
||||
```js title="sidebars.js"
|
||||
export default {
|
||||
tutorialSidebar: [
|
||||
'intro',
|
||||
// highlight-next-line
|
||||
'hello',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create a Page
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
- `src/pages/index.js` → `localhost:3000/`
|
||||
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||
- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
|
||||
|
||||
## Create your first React Page
|
||||
|
||||
Create a file at `src/pages/my-react-page.js`:
|
||||
|
||||
```jsx title="src/pages/my-react-page.js"
|
||||
import React from 'react';
|
||||
import Layout from '@theme/Layout';
|
||||
|
||||
export default function MyReactPage() {
|
||||
return (
|
||||
<Layout>
|
||||
<h1>My React page</h1>
|
||||
<p>This is a React page</p>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
|
||||
|
||||
## Create your first Markdown Page
|
||||
|
||||
Create a file at `src/pages/my-markdown-page.md`:
|
||||
|
||||
```mdx title="src/pages/my-markdown-page.md"
|
||||
# My Markdown page
|
||||
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Deploy your site
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
## Build your site
|
||||
|
||||
Build your site **for production**:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
The static files are generated in the `build` folder.
|
||||
|
||||
## Deploy your site
|
||||
|
||||
Test your production build locally:
|
||||
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
|
||||
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
|
||||
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||
|
|
@ -1,152 +0,0 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Markdown Features
|
||||
|
||||
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
|
||||
|
||||
## Front Matter
|
||||
|
||||
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
|
||||
|
||||
```text title="my-doc.md"
|
||||
// highlight-start
|
||||
---
|
||||
id: my-doc-id
|
||||
title: My document title
|
||||
description: My document description
|
||||
slug: /my-custom-url
|
||||
---
|
||||
// highlight-end
|
||||
|
||||
## Markdown heading
|
||||
|
||||
Markdown text with [links](./hello.md)
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
Regular Markdown links are supported, using url paths or relative file paths.
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](/create-a-page).
|
||||
```
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](./create-a-page.md).
|
||||
```
|
||||
|
||||
**Result:** Let's see how to [Create a page](./create-a-page.md).
|
||||
|
||||
## Images
|
||||
|
||||
Regular Markdown images are supported.
|
||||
|
||||
You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
## Code Blocks
|
||||
|
||||
Markdown code blocks are supported with Syntax highlighting.
|
||||
|
||||
````md
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
|
||||
## Admonitions
|
||||
|
||||
Docusaurus has a special syntax to create admonitions and callouts:
|
||||
|
||||
```md
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
```
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
## MDX and React Components
|
||||
|
||||
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
|
||||
|
||||
```jsx
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`)
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
```
|
||||
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"label": "Tutorial - Extras",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
Binäre Datei nicht angezeigt.
|
Vorher Breite: | Höhe: | Größe: 25 KiB |
Binäre Datei nicht angezeigt.
|
Vorher Breite: | Höhe: | Größe: 27 KiB |
|
|
@ -1,55 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Manage Docs Versions
|
||||
|
||||
Docusaurus can manage multiple versions of your docs.
|
||||
|
||||
## Create a docs version
|
||||
|
||||
Release a version 1.0 of your project:
|
||||
|
||||
```bash
|
||||
npm run docusaurus docs:version 1.0
|
||||
```
|
||||
|
||||
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
||||
|
||||
Your docs now have 2 versions:
|
||||
|
||||
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
||||
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
||||
|
||||
## Add a Version Dropdown
|
||||
|
||||
To navigate seamlessly across versions, add a version dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
export default {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'docsVersionDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The docs version dropdown appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Update an existing version
|
||||
|
||||
It is possible to edit versioned docs in their respective folder:
|
||||
|
||||
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
||||
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
||||
|
|
@ -1,88 +0,0 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Translate your site
|
||||
|
||||
Let's translate `docs/intro.md` to French.
|
||||
|
||||
## Configure i18n
|
||||
|
||||
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
export default {
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en', 'fr'],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Translate a doc
|
||||
|
||||
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
||||
|
||||
```bash
|
||||
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
||||
|
||||
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
||||
```
|
||||
|
||||
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
||||
|
||||
## Start your localized site
|
||||
|
||||
Start your site on the French locale:
|
||||
|
||||
```bash
|
||||
npm run start -- --locale fr
|
||||
```
|
||||
|
||||
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
|
||||
|
||||
:::caution
|
||||
|
||||
In development, you can only use one locale at a time.
|
||||
|
||||
:::
|
||||
|
||||
## Add a Locale Dropdown
|
||||
|
||||
To navigate seamlessly across languages, add a locale dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
export default {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'localeDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The locale dropdown now appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Build your localized site
|
||||
|
||||
Build your site for a specific locale:
|
||||
|
||||
```bash
|
||||
npm run build -- --locale fr
|
||||
```
|
||||
|
||||
Or build your site to include all the locales at once:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
|
@ -34,7 +34,9 @@ const config: Config = {
|
|||
'classic',
|
||||
{
|
||||
docs: {
|
||||
sidebarPath: './sidebars.ts',
|
||||
path: 'services',
|
||||
routeBasePath: 'services',
|
||||
sidebarPath: './sidebarsServices.ts',
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
//editUrl:
|
||||
|
|
@ -43,6 +45,8 @@ const config: Config = {
|
|||
blog: {
|
||||
showReadingTime: true,
|
||||
routeBasePath: '/',
|
||||
blogSidebarTitle: 'Beiträge',
|
||||
blogSidebarCount: 'ALL',
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
//editUrl:
|
||||
|
|
@ -54,7 +58,18 @@ const config: Config = {
|
|||
} satisfies Preset.Options,
|
||||
],
|
||||
],
|
||||
|
||||
plugins: [
|
||||
[
|
||||
'@docusaurus/plugin-content-docs',
|
||||
{
|
||||
id: 'info',
|
||||
path: 'info',
|
||||
routeBasePath: 'info',
|
||||
sidebarPath: './sidebarsInfo.ts',
|
||||
// ... other options
|
||||
},
|
||||
],
|
||||
],
|
||||
themeConfig: {
|
||||
// Replace with your project's social card
|
||||
image: 'img/docusaurus-social-card.jpg',
|
||||
|
|
@ -64,9 +79,16 @@ const config: Config = {
|
|||
{to: '/', label: 'Blog', position: 'left'},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'tutorialSidebar',
|
||||
sidebarId: 'servicesSidebar',
|
||||
position: 'left',
|
||||
label: 'Wissenswertes',
|
||||
label: 'Dienste',
|
||||
},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
docsPluginId: 'info',
|
||||
sidebarId: 'infoSidebar',
|
||||
position: 'left',
|
||||
label: 'Informationen',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
|
|
|||
62
info/intro.md
Normale Datei
62
info/intro.md
Normale Datei
|
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
|
||||
---
|
||||
|
||||
# Einleitung
|
||||
|
||||
Willkommen zur Dokumentation von nick-slowinski.de.
|
||||
|
||||
Wir hoffen, dass diese Dokumentation ein guter Einstieg bei Fragen und Problemen ist. Solltest du dennoch eine Frage oder ein Anliegen haben, [kontaktiere uns einfach](/kontakt).
|
||||
|
||||
## Inhalte beitragen
|
||||
|
||||
Diese Dokumentation ist noch relativ neu und weist daher auch Lücken auf, jeder ist eingeladen an dieser Dokumentation mit zu wirken.
|
||||
|
||||
Der Quellcode dieser Dokumentation wird in meiner [Forge](https://forge.nick-slowinski.de/nick-slowinski.de/docs) verwaltet, ein [Konto](/kontoverwaltung) wird benötigt um Inhalte zu verfassen.
|
||||
|
||||
### Fehler melden
|
||||
|
||||
Um Fehler jeglicher Art zu melden kann ein Ticket im [Issuetracker](https://forge.nick-slowinski.de/nick-slowinski.de/docs/issues) meiner Forge erstellt werden. Bitte durchsucht den Issuetracker vor der Erstellung eines Tickets, um eine doppelte Meldung zu vermeiden. Dies ist die bevorzugte Variante der Fehlermeldung um eine schnelle Behebung und korrekte Anerkennung aller beteiligten Parteien zu gewährleisten.
|
||||
|
||||
Natürlich können Fehler ebenfalls über andere Kontaktwege gemeldet werden, allerdings kann es dabei zu einer langsamen Bearbeitung und fehlende Anerkennung kommen.
|
||||
|
||||
**Optional:** Wir sind natürlich sehr dankbar, wenn der/die Fehler(r) direkt von dir behoben wird. Lese bitte die folgenden Abschnitte um zu erfahren, wie du dies bewerkstelligen kannst.
|
||||
|
||||
### Inhalte verbessern
|
||||
|
||||
#### Inhalte schreiben
|
||||
|
||||
Inhalte die dringend eine Überarbeitung benötigen sind mit dem Tag [*"Hilfe benötigt!"*](/tags/hilfe-benotigt) gekennzeichnet, andere Beiträge sind unter Umständen ebenfalls verbesserungswürdig.
|
||||
|
||||
##### Bearbeitung in der Forge (für Anfänger geeignet)
|
||||
|
||||
1. Besuche die Forge, und [forke das Repository](https://forge.nick-slowinski.de/repo/fork/37).
|
||||
2. Öffne den Fork und suche die entsprechende Datei die du bearbeiten möchtest.
|
||||
3. Bearbeite die entsprechenden Stellen, indem du auf den Stift (oben rechts, unterhalb von *"Einstellungen"*) drückst.
|
||||
4. Fülle die Commit-Infos aus und wähle *"Direkt in den Branch 'main' einchecken."* aus. Speichere deine Änderungen mit *"Änderungen committen"*.
|
||||
5. Bei deinem ersten Beitrag: Füge deinen Namen in der Dateien `/docs/contributors.md` am Ende ein, verlinke dabei auf das Profil in der Forge. Beachte dabei die bestehende Formatierung.
|
||||
6. Wenn du alle Dateien bearbeitet hast, kehre zum offiziellen Repository der Dokumentation zurück und [starte einen neuen Pull-Request](https://forge.nick-slowinski.de/nick-slowinski.de/docs/compare/main...main), wähle als Ziel `nick-slowinski.de:main` und als Quelle deine bearbeitete Branch aus deinem Repository (oftmals `<dein Benutzername>:main`)
|
||||
7. Kontrolliere deine Änderungen und ergänze wichtige Informationen, erkläre dabei was du mit deinen Änderungen bezwecken möchtest. Wenn alles stimmt, starte den Pull-Request indem du auf *"Pull-Request erstellen"* drückst.
|
||||
8. Frage Sie eine Review von *"nick-slowinski.de/Owners"* an, indem du in der rechten Spalte auf das Zahnrad neben *"Reviewer"* drückst.
|
||||
9. Mindestens ein Reviewer wird sich deine Änderungen zeitnah anschauen und Feedback geben und wenn alles in Ordnung ist, deine Änderungen mergen.
|
||||
|
||||
##### Bearbeitung über Git (führ erfahrene Nutzer)
|
||||
|
||||
1. Besuche die Forge, und [forke das Repository](https://forge.nick-slowinski.de/repo/fork/37).
|
||||
2. Clone deinen Fork auf deinen Computer
|
||||
3. Bearbeite die entsprechenden Dateien und committe deine Änderungen.
|
||||
4. Pushe deine Commits in deinen Fork.
|
||||
5. Bei deinem ersten Beitrag: Füge deinen Namen in der Dateien `/docs/contributors.md` am Ende ein, verlinke dabei auf das Profil in der Forge. Beachte dabei die bestehende Formatierung.
|
||||
6. Wenn du alle Dateien bearbeitet hast, kehre zum offiziellen Repository der Dokumentation zurück und [starte einen neuen Pull-Request](https://forge.nick-slowinski.de/nick-slowinski.de/docs/compare/main...main), wähle als Ziel `nick-slowinski.de:main` und als Quelle deine bearbeitete Branch aus deinem Repository (oftmals `<dein Benutzername>:main`)
|
||||
7. Kontrolliere deine Änderungen und ergänze wichtige Informationen, erkläre dabei was du mit deinen Änderungen bezwecken möchtest. Wenn alles stimmt, starte den Pull-Request indem du auf *"Pull-Request erstellen"* drückst.
|
||||
8. Frage Sie eine Review von *"nick-slowinski.de/Owners"* an, indem du in der rechten Spalte auf das Zahnrad neben *"Reviewer"* drückst.
|
||||
9. Mindestens ein Reviewer wird sich deine Änderungen zeitnah anschauen und Feedback geben und wenn alles in Ordnung ist, deine Änderungen mergen.
|
||||
|
||||
#### Inhalte übersetzen
|
||||
|
||||
Die Mehrsprachigkeit ist momentan noch nicht eingerichtet, jedoch soll die Dokumentation (in Teilen) auch auf Englisch verfügbar sein. Andere Sprachen können mit Hilfe der Community ebenfalls bereitgestellt werden, jedoch dann ohne offiziellen Support.
|
||||
|
||||
Bis zur Einrichtung der Mehrsprachigkeit soll das Repository einfach geforkt werden und unterhalb der deutschen Version jeweils die englische Übersetzung angehängt werden. Sobald jemand an einer Übersetzung arbeiten möchte, kann die betreffende Person gerne ein Issue erstellen und mich auf seine/ihre Absichten aufklären. Es wird dann zeitnah mit der Einrichtung der Mehrsprachigkeit begonnen.
|
||||
|
||||
Alternativ kann natürlich selbstständig mit der Einrichtung der Mehrsprachigkeit begonnen werden. Beachtet dabei die [offizielle Dokumentation von Docusaurus](https://docusaurus.io/docs/i18n/introduction).
|
||||
10
services/_category_.yml
Normale Datei
10
services/_category_.yml
Normale Datei
|
|
@ -0,0 +1,10 @@
|
|||
position: 4 # float position is supported
|
||||
label: 'Services und Dienste'
|
||||
collapsible: true # make the category collapsible
|
||||
collapsed: false # keep the category open by default
|
||||
className: red
|
||||
link:
|
||||
type: generated-index
|
||||
title: Services und Dienste
|
||||
description: Lernen Sie mehr über unsere Services und Dienste kennen.
|
||||
slug: /services
|
||||
14
services/adguard.md
Normale Datei
14
services/adguard.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
description: Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar.
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
---
|
||||
|
||||
# AdGuard
|
||||
|
||||
:::info
|
||||
|
||||
Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar. Die Einrichtungsphase ist momentan pausiert, da andere Projekte Vorrang haben.
|
||||
|
||||
:::
|
||||
25
services/amp.md
Normale Datei
25
services/amp.md
Normale Datei
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
sidebar_position: 2.5
|
||||
description: Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar.
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Application Management Panel
|
||||
|
||||
:::info
|
||||
|
||||
Der Service ist noch in der Einrichtungsphase, diese ist abgeschlossen, sobald der [Single Sign-on](sso/intro.md) Dienst eingebunden ist.
|
||||
|
||||
:::
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch verbessert werden.
|
||||
|
||||
:::
|
||||
|
||||
Für das Hosting verschiedener Spielserver verwenden wir das Application Management Panel, kurz AMP, von [CubeCoders](https://cubecoders.com/AMP).
|
||||
|
||||
Die Verwaltungsoberfläche von AMP ist unter [amp.nick-slowinski.de](https://amp.nick-slowinski.de) erreichbar und es können dynamisch verschiedene Remote-Server eingebunden werden, welche die eigentlichen Spielserver hosten.
|
||||
7
services/communication/e-mail/_category_.yml
Normale Datei
7
services/communication/e-mail/_category_.yml
Normale Datei
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
position: 8
|
||||
label: 'E-Mail'
|
||||
link:
|
||||
type: generated-index
|
||||
title: E-Mail
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
35
services/communication/e-mail/account.md
Normale Datei
35
services/communication/e-mail/account.md
Normale Datei
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
description: Kontotypen, Erstellung und Löschung
|
||||
---
|
||||
|
||||
# Konto
|
||||
|
||||
Für die Nutzung meines E-Mail-Servers wird ein eigenständiger Login benötigt, welcher nicht mit der Single Sign-on Platform verbunden ist.
|
||||
|
||||
## Erstellung und Löschung
|
||||
|
||||
:::info Info
|
||||
|
||||
Dieser Abschnitt wird später überarbeitet, sobald es ein einfaches Antragsformular gibt.
|
||||
|
||||
:::
|
||||
|
||||
Um einen Zugang zu erhalten, wendet euch bitte im Forum an mich [(@NickSlowinski)](https://community.nick-slowinski.de/new-message?username=NickSlowinski) oder [schreibt mir eine E-Mail](mailto:nick@nick-slowinski.de).
|
||||
|
||||
Für eine Kontolöschung wendet euch bitte [per E-Mail an mich](mailto:nick@nick-slowinski.de) - verwendet dabei die E-Mail-Adresse eurer Haupt-E-Mail (für eine einfache und fehlerfreie Zuordnung).
|
||||
|
||||
## Kontotypen
|
||||
|
||||
### Mailboxbenutzer
|
||||
|
||||
Mailboxbenutzer sind einzelne Benutzer, welche eine oder mehrere E-Mail-Adressen an ihren Account gebunden haben. Ihnen ist mindestens eine E-Mail-Adresse dauerhaft zugewiesen, welche für sämtliche Logins genutzt wird.
|
||||
|
||||
Der Hauptlogin (die Haupt E-Mail) wird dabei auch als Login für andere zugewiesene E-Mail-Adressen verwendet.
|
||||
|
||||
### Domainadministratoren
|
||||
|
||||
Domainadministratoren dienen ausschließlich der Verwaltung von untergeordneten Mailbox-Domains. Sie haben volle Kontrolle über die zugewiesenen E-Mail-Domains, ausgenommen von DNS-Änderungen.
|
||||
|
||||
### Systemadministratoren
|
||||
|
||||
Systemadministratoren haben die volle Kontrolle über das System und können alle Einstellungen vornehmen. Sie verwalten die verschiedenen Domainadministratoren und können auch als Domainadministrator agieren. Auf Grund der sehr hohen Rechte gibt es derzeitig nur einen Systemadministrator - Nick Slowinski.
|
||||
6
services/communication/e-mail/client-config/_category_.yml
Normale Datei
6
services/communication/e-mail/client-config/_category_.yml
Normale Datei
|
|
@ -0,0 +1,6 @@
|
|||
position: 8
|
||||
label: 'Client-Konfiguration'
|
||||
link:
|
||||
type: generated-index
|
||||
title: Client-Konfiguration
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
31
services/communication/e-mail/client-config/android.md
Normale Datei
31
services/communication/e-mail/client-config/android.md
Normale Datei
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Android
|
||||
|
||||
:::note Hinweis
|
||||
|
||||
Nachfolgend wird die Verfahrensweise für den Pixel Launcher von Android 14, dem Android-Skin der Google Pixel Geräte, erklärt. Jeder Androidhersteller kann das Design des Betriebssystems nach seinen Wünschen anpassen - entsprechend können die Menüpunkte anders heißen und/oder an einen anderen Ort zu finden sein.
|
||||
|
||||
:::
|
||||
|
||||
1. Öffnen Sie die Einstellungen.
|
||||
2. Wählen Sie `Passwörter und Konten`.
|
||||
3. Wählen Sie `Konto hinzufügen`.
|
||||
4. Wählen Sie als Typ `Exchange`.
|
||||
5. Geben Sie Ihre Haupt-E-Mail-Adresse ein.
|
||||
|
||||
TBC
|
||||
|
||||
6. Screenshots erstellen :)
|
||||
|
||||
|
||||
### ONLY FOR TESTING
|
||||
|
||||
CSS Attribut: float: start-inline oder left spezifisch
|
||||
|
||||
 Nachfolgend wird die Verfahrensweise für den Pixel Launcher von Android 14, dem Android-Skin der Google Pixel Geräte, erklärt. Jeder Androidhersteller kann das Design des Betriebssystems nach seinen Wünschen anpassen - entsprechend können die Menüpunkte anders heißen und/oder an einen anderen Ort zu finden sein. Nachfolgend wird die Verfahrensweise für den Pixel Launcher von Android 14, dem Android-Skin der Google Pixel Geräte, erklärt. Jeder Androidhersteller kann das Design des Betriebssystems nach seinen Wünschen anpassen - entsprechend können die Menüpunkte anders heißen und/oder an einen anderen Ort zu finden sein. Nachfolgend wird die Verfahrensweise für den Pixel Launcher von Android 14, dem Android-Skin der Google Pixel Geräte, erklärt. Jeder Androidhersteller kann das Design des Betriebssystems nach seinen Wünschen anpassen - entsprechend können die Menüpunkte anders heißen und/oder an einen anderen Ort zu finden sein. Nachfolgend wird die Verfahrensweise für den Pixel Launcher von Android 14, dem Android-Skin der Google Pixel Geräte, erklärt. Jeder Androidhersteller kann das Design des Betriebssystems nach seinen Wünschen anpassen - entsprechend können die Menüpunkte anders heißen und/oder an einen anderen Ort zu finden sein. Nachfolgend wird die Verfahrensweise für den Pixel Launcher von Android 14, dem Android-Skin der Google Pixel Geräte, erklärt. Jeder Androidhersteller kann das Design des Betriebssystems nach seinen Wünschen anpassen - entsprechend können die Menüpunkte anders heißen und/oder an einen anderen Ort zu finden sein.
|
||||
14
services/communication/e-mail/client-config/apple.md
Normale Datei
14
services/communication/e-mail/client-config/apple.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Apple macOS / iOS
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
34
services/communication/e-mail/client-config/manual-config.md
Normale Datei
34
services/communication/e-mail/client-config/manual-config.md
Normale Datei
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
description: ""
|
||||
---
|
||||
|
||||
# Manuelle Konfiguration
|
||||
|
||||
## E-Mail
|
||||
|
||||
| Dienst | Verschlüsselung | Host | Port |
|
||||
|:------:|:---------------:|:----------------------:|:----:|
|
||||
| IMAPS | TLS (SSL) | mail.nick-slowinski.de | 993 |
|
||||
| IMAP | STARTTLS | mail.nick-slowinski.de | 143 |
|
||||
| POP3S | TLS (SSL) | mail.nick-slowinski.de | 995 |
|
||||
| POP3 | STARTTLS | mail.nick-slowinski.de | 110 |
|
||||
| SMTPS | TLS (SSL) | mail.nick-slowinski.de | 465 |
|
||||
| SMTP | STARTTLS | mail.nick-slowinski.de | 587 |
|
||||
|
||||
Bitte verwenden Sie `plain` als Authentifizierungsmechanismus. Entgegen der Annahme werden keine Passwörter im Klartext übertragen, da ohne TLS keine Authentifizierung stattfinden darf.
|
||||
|
||||
## Kontakte und Kalender
|
||||
|
||||
SOGos Standard-URLs für Kalender (CalDAV) und Kontakte (CardDAV):
|
||||
|
||||
:::note Anpassung
|
||||
|
||||
In den folgenden URLs muss `user@example.com` durch Ihre primäre E-Mail-Adresse ersetzt werden.
|
||||
|
||||
:::
|
||||
|
||||
- CalDAV: `https://mail.nick-slowinski.de/SOGo/dav/user@example.com/Calendar/personal/`
|
||||
- CardDAV: `https://mail.nick-slowinski.de/SOGo/dav/user@example.com/Contacts/personal/`
|
||||
|
||||
Einige Anwendungen verlangen möglicherweise die Verwendung von `https://mail.nick-slowinski.de/SOGo/dav/` oder den vollständigen Pfad zu Ihrem Kalender, der in SOGo gefunden und kopiert werden kann.
|
||||
14
services/communication/e-mail/client-config/outlook.md
Normale Datei
14
services/communication/e-mail/client-config/outlook.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Microsoft Outlook
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
14
services/communication/e-mail/client-config/thunderbird.md
Normale Datei
14
services/communication/e-mail/client-config/thunderbird.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Mozilla Thunderbird
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
14
services/communication/e-mail/client-config/windows-mail.md
Normale Datei
14
services/communication/e-mail/client-config/windows-mail.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Windows Mail
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
6
services/communication/e-mail/features/_category_.yml
Normale Datei
6
services/communication/e-mail/features/_category_.yml
Normale Datei
|
|
@ -0,0 +1,6 @@
|
|||
position: 8
|
||||
label: 'Features'
|
||||
link:
|
||||
type: generated-index
|
||||
title: Features
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
9
services/communication/e-mail/features/app-passwords.md
Normale Datei
9
services/communication/e-mail/features/app-passwords.md
Normale Datei
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# App-Passwörter
|
||||
|
||||
App-Passwörter sind alternative Passwörter für den E-Mail-Account, welche für den Zugriff über IMAP, POP3 und SMTP verwendet werden können.
|
||||
11
services/communication/e-mail/features/test.md
Normale Datei
11
services/communication/e-mail/features/test.md
Normale Datei
|
|
@ -0,0 +1,11 @@
|
|||
In einzelnen Seiten werden alle Funktionen und Einstellungsmöglichkeiten von Mailcow erklärt.
|
||||
|
||||
Tagging
|
||||
Verschlüsselungsrichtlinien
|
||||
Server Filterregeln
|
||||
Spamsysten
|
||||
Quarantänesystem
|
||||
ActiveSync, CardDAV,CalDAV
|
||||
temporäre Adressen
|
||||
Sync Jobs
|
||||
App-Passwörter
|
||||
13
services/communication/e-mail/features/vorlage.md
Normale Datei
13
services/communication/e-mail/features/vorlage.md
Normale Datei
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Einleitung
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
13
services/communication/e-mail/intro.md
Normale Datei
13
services/communication/e-mail/intro.md
Normale Datei
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Einleitung
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
14
services/communication/matrix.md
Normale Datei
14
services/communication/matrix.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 10.5
|
||||
description: Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar.
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
---
|
||||
|
||||
# Matrix Server (Element)
|
||||
|
||||
:::info
|
||||
|
||||
Der Service ist noch in der Planungsphase und nicht öffentlich verfügbar. Die Einrichtungsphase ist momentan pausiert, da andere Projekte Vorrang haben.
|
||||
|
||||
:::
|
||||
46
services/communication/teamspeak.md
Normale Datei
46
services/communication/teamspeak.md
Normale Datei
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
sidebar_position: 15
|
||||
description: TeamSpeak ist ein Sprachchat mit einem hohen Maß an Privatsphäre.
|
||||
---
|
||||
|
||||
# TeamSpeak Server
|
||||
|
||||
## Adressen
|
||||
|
||||
:::caution Wichtiger Hinweis
|
||||
|
||||
Es gibt weiter Adressen, unter dem unser TeamSpeak Server erreicht werden kann - jedoch unterstützen wir die direkte Verbindung mittels IP-Adresse oder anderen Adressen nicht.
|
||||
|
||||
:::
|
||||
|
||||
Primäre Adresse: `nick-slowinski.de`<br/>
|
||||
Alternative Adresse: `NicksTS`<br/>
|
||||
Verbindung nur über IPv4: `ipv4.nick-slowinski.de`<br/>
|
||||
Verbindung nur über IPv6: `ipv6.nick-slowinski.de`
|
||||
|
||||
:::tip
|
||||
|
||||
Sollten Sie Verbindungsprobleme haben, versuchen Sie zunächst alle anderen oben erwähnten Verbindungsadressen. Sollte das Problem weiter bestehen, treten Sie bitte mit uns in [Kontakt](/kontakt).
|
||||
|
||||
:::
|
||||
|
||||
## Verfügbarkeit
|
||||
|
||||
Sie erreichen unseren TeamSpeak Server nahezu 24/7, während unseren planmäßigen Wartungsarbeiten kann es kurzfristig zu einer Unterbrechung kommen, um den Server zu aktualisieren oder um Sicherheitsupdates zu installieren.
|
||||
|
||||
Sie können den aktuellen Status unter [status.nick-slowinski.de](https://status.nick-slowinski.de) einsehen.
|
||||
|
||||
## Kapazität
|
||||
|
||||
Unser TeamSpeak Server verfügt über 512 Slots und damit genügend Platz für dich und deine Freunde - dabei ist es egal, ob Ihr unter euch sein wollt oder die Gesellschaft andere Nutzer wahrnehmen möchtet.
|
||||
|
||||
An dieser Stelle möchten wir uns auch bei *TeamSpeak Systems, Inc.* für die Bereitstellung einer NPL-Lizenz bedanken.
|
||||
|
||||
|
||||
## Rechte
|
||||
|
||||
Aktuell können neue Mitglieder keine höheren Rechte bekommen, da diese mit einem nicht mehr existenten Forum synchronisiert wurden. Wir arbeiten aber an einer Lösung. Sollte ein dringender Grund an höheren Rechten bestehen, [kontaktieren](/kontakt) uns bitte.
|
||||
|
||||
## Wünsche
|
||||
|
||||
Falls Sie spezielle Wünsche oder Verbesserungsvorschläge haben, können Sie diese gerne in [unserem Forum](https://community.nick-slowinski.de) mit uns teilen.
|
||||
14
services/community.md
Normale Datei
14
services/community.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Community Forum
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
14
services/data/cloud.md
Normale Datei
14
services/data/cloud.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
description: Dieser Service ist für die Zukunft geplant.
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
---
|
||||
|
||||
# Cloud
|
||||
|
||||
:::info
|
||||
|
||||
Dieser Service ist für die Zukunft geplant und daher noch nicht verfügbar.
|
||||
|
||||
:::
|
||||
17
services/data/download-portal.md
Normale Datei
17
services/data/download-portal.md
Normale Datei
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
sidebar_position: 8
|
||||
description: Downloads.
|
||||
slug: downloads
|
||||
---
|
||||
|
||||
# Download-Portal
|
||||
|
||||
:::caution Achtung
|
||||
|
||||
Mit der Inbetriebnahme der [Cloud](/services/cloud) wird dieser Dienst eingestellt. Die [Cloud](/services/cloud) stellt später die gleiche Funktionalität wie das Download-Portal bereit.
|
||||
|
||||
:::
|
||||
|
||||
Das Download-Portal ist unter [dl.nick-slowinski.de](https://dl.nick-slowinski.de) verfügbar und stellt diverse Downloads über verschiedene Zeiträume bereit. Einzelne Dateien und Ordner können über HTTP-Authentifizierung (HTTP Basic Auth) abgesichert werden.
|
||||
|
||||
Der Upload seitens Benutzern ist derzeitig nicht möglich.
|
||||
15
services/data/s3.md
Normale Datei
15
services/data/s3.md
Normale Datei
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
sidebar_position: 13
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
slug: minio
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# S3-Speicher (Minio)
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
38
services/development/ci-cd.md
Normale Datei
38
services/development/ci-cd.md
Normale Datei
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
description: Dient zum Testen und Veröffentichen von Software.
|
||||
slug: drone
|
||||
---
|
||||
|
||||
# CI/CD (Drone)
|
||||
|
||||
Die CI/CD Plattform basiert auf [Drone](https://www.drone.io) und ist unter [drone.nick-slowinski.de](https://drone.nick-slowinski.de) verfügbar.
|
||||
|
||||
## Zugang
|
||||
|
||||
Unsere Drone-Platform ist momentan nicht für jeden Benutzer verfügbar. Ein Zugang kann in unserem Communityforum mittels einer privaten Nachricht an [NickSlowinski](https://community.nick-slowinski.de/new-message?username=NickSlowinski) angefragt werden. Bitte erklärt dabei folgende Punkte:
|
||||
|
||||
- Für welche Projekte und Repositorys soll der Zugang genutzt werden?
|
||||
- Besteht eine kommerzielle Absicht dahinter? (Verkauf von Softwarelizenzen)
|
||||
- Werden in irgendeiner Art und Weise Geld eingenommen oder ist dies geplant? (z.B. Spenden)
|
||||
- Womit begründen Sie ihr Interesse?
|
||||
|
||||
## Verfügbare Pipelines
|
||||
|
||||
- Docker
|
||||
|
||||
Falls ein SSH Runner benötigt wird, kann dieser über das Communityforum angefragt werden. Momentan ist die Bereitstellung von Digital Ocean, Exec, Kubernetes, Macstadium oder VM Runnern nicht geplant.
|
||||
|
||||
## Verfügbare Plattformen
|
||||
|
||||
- linux/amd64
|
||||
- linux/arm64
|
||||
- linux/arm
|
||||
|
||||
Falls ein SSH Runner angefragt wird, können auch andere [unterstützte Plattformen](https://docs.drone.io/pipeline/ssh/syntax/platform/#supported-platforms) verwendet werden.
|
||||
|
||||
## Konfiguration und Verwendung
|
||||
|
||||
Bitte schaut in der [offiziellen Dokumentation von Drone](https://docs.drone.io) nach genauen Anleitungen für eure Bedürfnisse an. Dabei gibt es auch eine [umfassende Liste](https://docs.drone.io/pipeline/docker/examples/) an Beispielen für diverse Programmiersprachen und häufig genutzte Software.
|
||||
|
||||
Gerne können auch unsere Konfigurationen in den Repositorys eingesehen werden. Wir helfen auch gerne im [Communityforum](https://community.nick-slowinski.de/c/support/5) anderen Nutzern.
|
||||
18
services/development/dbms.md
Normale Datei
18
services/development/dbms.md
Normale Datei
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
description: Verwaltung und Administration von Datenbanken
|
||||
---
|
||||
|
||||
# Datenbankmanagementsysteme
|
||||
|
||||
## pgAdmin4 (PostgreSQL)
|
||||
|
||||
Wir stellen eine pgAdmin4 Oberfläche unter [pgadmin.nick-slowinski.de](https://pgadmin.nick-slowinski.de) bereit, welche zur Administration und Verwaltung von unseren und externen PostgreSQL Servern genutzt werden kann.
|
||||
|
||||
Unsere pgAdmin4 Oberfläche ist momentan nicht direkt für jeden Benutzer verfügbar. Ein Zugang kann in unserem Communityforum mittels einer privaten Nachricht an [NickSlowinski](https://community.nick-slowinski.de/new-message?username=NickSlowinski) angefragt werden.
|
||||
|
||||
## phpMyAdmin (MySQL/MariaDB)
|
||||
|
||||
Wir verwenden derzeitig keine Datenbankserver auf MySQL oder MariaDB Basis, daher ist momentan auch keine phpMyAdmin Oberfläche installiert. Sollte aber Bedarf für eine phpMyAdmin Oberfläche bestehen, so kann diese gerne als privaten Nachricht an [NickSlowinski](https://community.nick-slowinski.de/new-message?username=NickSlowinski) angefragt werden.
|
||||
|
||||
Sollte ein externer Server (nicht einer von unseren Servern) eingebunden werden, wird unbedingt eine funktionstüchtige SSL Verbindung zum MySQL, beziehungsweise MariaDB Server benötigt! Wir unterstützen keine unverschlüsselten Verbindungen außerhalb unseres internen Netzwerks!
|
||||
14
services/development/forge.md
Normale Datei
14
services/development/forge.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Forge
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
15
services/development/translate.md
Normale Datei
15
services/development/translate.md
Normale Datei
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
sidebar_position: 16
|
||||
description: Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar.
|
||||
slug: übersetzungsplatform
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
---
|
||||
|
||||
# Übersetzungsplatform
|
||||
|
||||
:::info
|
||||
|
||||
Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar. Die Einrichtungsphase ist momentan pausiert, da andere Projekte Vorrang haben.
|
||||
|
||||
:::
|
||||
62
services/intro.md
Normale Datei
62
services/intro.md
Normale Datei
|
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
|
||||
---
|
||||
|
||||
# Einleitung
|
||||
|
||||
Willkommen zur Dokumentation von nick-slowinski.de.
|
||||
|
||||
Wir hoffen, dass diese Dokumentation ein guter Einstieg bei Fragen und Problemen ist. Solltest du dennoch eine Frage oder ein Anliegen haben, [kontaktiere uns einfach](/kontakt).
|
||||
|
||||
## Inhalte beitragen
|
||||
|
||||
Diese Dokumentation ist noch relativ neu und weist daher auch Lücken auf, jeder ist eingeladen an dieser Dokumentation mit zu wirken.
|
||||
|
||||
Der Quellcode dieser Dokumentation wird in meiner [Forge](https://forge.nick-slowinski.de/nick-slowinski.de/docs) verwaltet, ein [Konto](/kontoverwaltung) wird benötigt um Inhalte zu verfassen.
|
||||
|
||||
### Fehler melden
|
||||
|
||||
Um Fehler jeglicher Art zu melden kann ein Ticket im [Issuetracker](https://forge.nick-slowinski.de/nick-slowinski.de/docs/issues) meiner Forge erstellt werden. Bitte durchsucht den Issuetracker vor der Erstellung eines Tickets, um eine doppelte Meldung zu vermeiden. Dies ist die bevorzugte Variante der Fehlermeldung um eine schnelle Behebung und korrekte Anerkennung aller beteiligten Parteien zu gewährleisten.
|
||||
|
||||
Natürlich können Fehler ebenfalls über andere Kontaktwege gemeldet werden, allerdings kann es dabei zu einer langsamen Bearbeitung und fehlende Anerkennung kommen.
|
||||
|
||||
**Optional:** Wir sind natürlich sehr dankbar, wenn der/die Fehler(r) direkt von dir behoben wird. Lese bitte die folgenden Abschnitte um zu erfahren, wie du dies bewerkstelligen kannst.
|
||||
|
||||
### Inhalte verbessern
|
||||
|
||||
#### Inhalte schreiben
|
||||
|
||||
Inhalte die dringend eine Überarbeitung benötigen sind mit dem Tag [*"Hilfe benötigt!"*](/tags/hilfe-benotigt) gekennzeichnet, andere Beiträge sind unter Umständen ebenfalls verbesserungswürdig.
|
||||
|
||||
##### Bearbeitung in der Forge (für Anfänger geeignet)
|
||||
|
||||
1. Besuche die Forge, und [forke das Repository](https://forge.nick-slowinski.de/repo/fork/37).
|
||||
2. Öffne den Fork und suche die entsprechende Datei die du bearbeiten möchtest.
|
||||
3. Bearbeite die entsprechenden Stellen, indem du auf den Stift (oben rechts, unterhalb von *"Einstellungen"*) drückst.
|
||||
4. Fülle die Commit-Infos aus und wähle *"Direkt in den Branch 'main' einchecken."* aus. Speichere deine Änderungen mit *"Änderungen committen"*.
|
||||
5. Bei deinem ersten Beitrag: Füge deinen Namen in der Dateien `/docs/contributors.md` am Ende ein, verlinke dabei auf das Profil in der Forge. Beachte dabei die bestehende Formatierung.
|
||||
6. Wenn du alle Dateien bearbeitet hast, kehre zum offiziellen Repository der Dokumentation zurück und [starte einen neuen Pull-Request](https://forge.nick-slowinski.de/nick-slowinski.de/docs/compare/main...main), wähle als Ziel `nick-slowinski.de:main` und als Quelle deine bearbeitete Branch aus deinem Repository (oftmals `<dein Benutzername>:main`)
|
||||
7. Kontrolliere deine Änderungen und ergänze wichtige Informationen, erkläre dabei was du mit deinen Änderungen bezwecken möchtest. Wenn alles stimmt, starte den Pull-Request indem du auf *"Pull-Request erstellen"* drückst.
|
||||
8. Frage Sie eine Review von *"nick-slowinski.de/Owners"* an, indem du in der rechten Spalte auf das Zahnrad neben *"Reviewer"* drückst.
|
||||
9. Mindestens ein Reviewer wird sich deine Änderungen zeitnah anschauen und Feedback geben und wenn alles in Ordnung ist, deine Änderungen mergen.
|
||||
|
||||
##### Bearbeitung über Git (führ erfahrene Nutzer)
|
||||
|
||||
1. Besuche die Forge, und [forke das Repository](https://forge.nick-slowinski.de/repo/fork/37).
|
||||
2. Clone deinen Fork auf deinen Computer
|
||||
3. Bearbeite die entsprechenden Dateien und committe deine Änderungen.
|
||||
4. Pushe deine Commits in deinen Fork.
|
||||
5. Bei deinem ersten Beitrag: Füge deinen Namen in der Dateien `/docs/contributors.md` am Ende ein, verlinke dabei auf das Profil in der Forge. Beachte dabei die bestehende Formatierung.
|
||||
6. Wenn du alle Dateien bearbeitet hast, kehre zum offiziellen Repository der Dokumentation zurück und [starte einen neuen Pull-Request](https://forge.nick-slowinski.de/nick-slowinski.de/docs/compare/main...main), wähle als Ziel `nick-slowinski.de:main` und als Quelle deine bearbeitete Branch aus deinem Repository (oftmals `<dein Benutzername>:main`)
|
||||
7. Kontrolliere deine Änderungen und ergänze wichtige Informationen, erkläre dabei was du mit deinen Änderungen bezwecken möchtest. Wenn alles stimmt, starte den Pull-Request indem du auf *"Pull-Request erstellen"* drückst.
|
||||
8. Frage Sie eine Review von *"nick-slowinski.de/Owners"* an, indem du in der rechten Spalte auf das Zahnrad neben *"Reviewer"* drückst.
|
||||
9. Mindestens ein Reviewer wird sich deine Änderungen zeitnah anschauen und Feedback geben und wenn alles in Ordnung ist, deine Änderungen mergen.
|
||||
|
||||
#### Inhalte übersetzen
|
||||
|
||||
Die Mehrsprachigkeit ist momentan noch nicht eingerichtet, jedoch soll die Dokumentation (in Teilen) auch auf Englisch verfügbar sein. Andere Sprachen können mit Hilfe der Community ebenfalls bereitgestellt werden, jedoch dann ohne offiziellen Support.
|
||||
|
||||
Bis zur Einrichtung der Mehrsprachigkeit soll das Repository einfach geforkt werden und unterhalb der deutschen Version jeweils die englische Übersetzung angehängt werden. Sobald jemand an einer Übersetzung arbeiten möchte, kann die betreffende Person gerne ein Issue erstellen und mich auf seine/ihre Absichten aufklären. Es wird dann zeitnah mit der Einrichtung der Mehrsprachigkeit begonnen.
|
||||
|
||||
Alternativ kann natürlich selbstständig mit der Einrichtung der Mehrsprachigkeit begonnen werden. Beachtet dabei die [offizielle Dokumentation von Docusaurus](https://docusaurus.io/docs/i18n/introduction).
|
||||
16
services/monitoring.md
Normale Datei
16
services/monitoring.md
Normale Datei
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
sidebar_position: 11
|
||||
description: Ist Service XYZ online? Schauen Sie einfach im Monitoring nach.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Monitoring
|
||||
|
||||
## Status Webseite
|
||||
|
||||
Unter [status.nick-slowinski.de](https://status.nick-slowinski.de) ist eine öffentliche Statuswebseite für unsere Dienste verfügbar. Wartungsarbeiten und technische Störungen werden dort ebenfalls angekündigt.
|
||||
|
||||
## ToDo (Docs)
|
||||
|
||||
Unser Monitoring System mit Zabbix, Prometheus und Grafana wird hier später noch im Detail erklärt.
|
||||
14
services/pw-manager.md
Normale Datei
14
services/pw-manager.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 12
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# Passwort-Manager
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
6
services/sso/_category_.yml
Normale Datei
6
services/sso/_category_.yml
Normale Datei
|
|
@ -0,0 +1,6 @@
|
|||
position: 13
|
||||
label: 'Single Sign-on'
|
||||
link:
|
||||
type: generated-index
|
||||
title: Single Sign-on
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
13
services/sso/intro.md
Normale Datei
13
services/sso/intro.md
Normale Datei
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
---
|
||||
|
||||
# Einleitung
|
||||
|
||||
:::info
|
||||
|
||||
Dieser Service ist für die Zukunft geplant und daher noch nicht verfügbar.
|
||||
|
||||
:::
|
||||
14
services/support-tickets.md
Normale Datei
14
services/support-tickets.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 14.5
|
||||
description: Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar.
|
||||
tags:
|
||||
- Zukünftige Dienste
|
||||
---
|
||||
|
||||
# Support Ticketsystem
|
||||
|
||||
:::info
|
||||
|
||||
Der Service ist noch in der Einrichtungsphase und nicht öffentlich verfügbar.
|
||||
|
||||
:::
|
||||
14
services/vpn.md
Normale Datei
14
services/vpn.md
Normale Datei
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
sidebar_position: 17
|
||||
description: Dieser Inhalt muss noch geschrieben werden.
|
||||
tags:
|
||||
- Hilfe benötigt!
|
||||
---
|
||||
|
||||
# VPN
|
||||
|
||||
:::note Notiz
|
||||
|
||||
Dieser Inhalt muss noch geschrieben werden.
|
||||
|
||||
:::
|
||||
|
|
@ -12,7 +12,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
|
|||
*/
|
||||
const sidebars: SidebarsConfig = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||
infoSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
31
sidebarsServices.ts
Normale Datei
31
sidebarsServices.ts
Normale Datei
|
|
@ -0,0 +1,31 @@
|
|||
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
|
||||
|
||||
/**
|
||||
* Creating a sidebar enables you to:
|
||||
- create an ordered group of docs
|
||||
- render a sidebar for each doc of that group
|
||||
- provide next/previous navigation
|
||||
|
||||
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||
|
||||
Create as many sidebars as you want.
|
||||
*/
|
||||
const sidebars: SidebarsConfig = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
servicesSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
'intro',
|
||||
'hello',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
*/
|
||||
};
|
||||
|
||||
export default sidebars;
|
||||
Laden …
In neuem Issue referenzieren