mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-14 12:48:01 +00:00
feat(documentation): svelte app as document generator (#566)
* check in full site application * rm unused assets components * change base css * i18n * new doc workflow * fix crosslink to doc in github * nav, console link, assets, console brand * edit configjs server * rm go struct references * cleanup input output bindings * working dir * export path * always trigger * rel paths * cname * rev workdir * fix fallbacklanguage, home on large screens * remove mit from site
This commit is contained in:
Max Peintner
8
site/docs/get_started/00-introduction.de.md
Normal file
8
site/docs/get_started/00-introduction.de.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Einführung
|
||||
---
|
||||
|
||||
### Bevor es los geh't
|
||||
|
||||
> Dies ist eine frühe Version unseres Dokumentgenerators. Es können noch einige Dinge ändern, bis wir Version 1.0 erreichen.
|
||||
|
||||
8
site/docs/get_started/00-introduction.en.md
Normal file
8
site/docs/get_started/00-introduction.en.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
### Before we begin
|
||||
|
||||
> This is an early version of our documentation. Some things may change until we hit version 1.0.
|
||||
> This Documentation is and always will be a WIP, and will therefore be updated frequently.
|
||||
14
site/docs/get_started/01-capabilities.de.md
Normal file
14
site/docs/get_started/01-capabilities.de.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Wie fange ich an?
|
||||
description: Dieses Dokument beschreibt die Schlüsselfähigkeiten und führt in verschiedene Startszenarien ein
|
||||
---
|
||||
|
||||
<!-- ## Wo fange ich mit der Zitadel-Authentifizierung an? -->
|
||||
|
||||
### I already have an authentication system
|
||||
|
||||
Wenn Ihre App bereits über eine Anmeldeimplementierung verfügt und Sie diese zur Authentifizierung für Zitadel-Backend-Diensten verwenden möchten, lesen Sie unsere `Migrationsanleitung`.
|
||||
|
||||
### Ich möchte mein Authentifizierungssystem mit Zitadel erstellen
|
||||
|
||||
Wenn Sie eine neue App erstellen oder einer vorhandenen App eine Anmeldung hinzufügen, verfügt Zitadel über Bibliotheken und Dienste, mit denen Sie die sichere Authentifizierung implementieren können, ohne das Authentifizierungs-Backend selbst erstellen zu müssen. Die Zitadel-Authentifizierung ist eine vollständige Backend-Lösung, die die Anmeldung mit Kennwörtern und weiteren Faktoren zur verbesserten Sicherheit ermöglicht
|
||||
14
site/docs/get_started/01-capabilities.en.md
Normal file
14
site/docs/get_started/01-capabilities.en.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Where to start?
|
||||
description: This document explains zitadels key capabilities
|
||||
---
|
||||
|
||||
<!-- ## Where to start? -->
|
||||
|
||||
### I already have an authentication system
|
||||
|
||||
If your app already has a sign-in implementation and you want to use it to authenticate with Zitadel backend services, read our `migration documentation`.
|
||||
|
||||
### I want to build my authentication system with Zitadel
|
||||
|
||||
If you're building a new app or adding sign-in to an existing app, Zitadel has libraries and services that can help you implement secure authentication without having to build the authentication backend yourself. Zitadel Authentication is a complete backend solution for signing in with passwords and additional Factors for enhanced Security.
|
||||
32
site/docs/get_started/02-go-structs.de.md
Normal file
32
site/docs/get_started/02-go-structs.de.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: Go structs
|
||||
---
|
||||
|
||||
### Go structures
|
||||
|
||||
You can reference go struct tables from our go struct generator.
|
||||
Provide a `doc_assets` folder with all generated files in it.
|
||||
Make sure that the `.md` file consists of no other than the table itself and metadata which defines name and description of the struct
|
||||
|
||||
|
||||
| Attribute | Description | Default | Collection |
|
||||
| --------------------------- | ------------------------------------------------------------------------------- | ------- | ---------- |
|
||||
| boomVersion | Version of BOOM which should be reconciled | | |
|
||||
| forceApply | Relative folder path where the currentstate is written to | | |
|
||||
| currentStatePath | Flag if --force should be used by apply of resources | | |
|
||||
| preApply | Spec for the yaml-files applied before applications | | |
|
||||
| postApply | Spec for the yaml-files applied after applicatio | | |
|
||||
| prometheus-operator | Spec for the Prometheus-Operator , | | |
|
||||
| logging-operator | Spec for the Banzaicloud Logging-Operator , | | |
|
||||
| prometheus-node-exporter | Spec for the Prometheus-Node-Exporter , | | |
|
||||
| prometheus-systemd-exporter | Spec for the Prometheus-Systemd-Exporter , | | |
|
||||
| grafana | Spec for the Grafana , [ | | |
|
||||
| ambassador | Spec for the Ambassador , | | |
|
||||
| kube-state-metrics | Spec for the Kube-State-Metrics , | | |
|
||||
| argocd | Spec for the Argo-CD , | | |
|
||||
| prometheus | Spec for the Prometheus instance , | | |
|
||||
| loki | Spec for the Loki instance , | | |
|
||||
|
||||
#### References
|
||||
|
||||
To reference a table ...
|
||||
32
site/docs/get_started/02-go-structs.en.md
Normal file
32
site/docs/get_started/02-go-structs.en.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: Go structs
|
||||
---
|
||||
|
||||
### Go structures
|
||||
|
||||
You can reference go struct tables from our go struct generator.
|
||||
Provide a `doc_assets` folder with all generated files in it.
|
||||
Make sure that the `.md` file consists of no other than the table itself and metadata which defines name and description of the struct
|
||||
|
||||
|
||||
| Attribute | Description | Default | Collection |
|
||||
| --------------------------- | ------------------------------------------------------------------------------- | ------- | ---------- |
|
||||
| boomVersion | Version of BOOM which should be reconciled | | |
|
||||
| forceApply | Relative folder path where the currentstate is written to | | |
|
||||
| currentStatePath | Flag if --force should be used by apply of resources | | |
|
||||
| preApply | Spec for the yaml-files applied before applications | | |
|
||||
| postApply | Spec for the yaml-files applied after applicatio | | |
|
||||
| prometheus-operator | Spec for the Prometheus-Operator , | | |
|
||||
| logging-operator | Spec for the Banzaicloud Logging-Operator , | | |
|
||||
| prometheus-node-exporter | Spec for the Prometheus-Node-Exporter , | | |
|
||||
| prometheus-systemd-exporter | Spec for the Prometheus-Systemd-Exporter , | | |
|
||||
| grafana | Spec for the Grafana , [ | | |
|
||||
| ambassador | Spec for the Ambassador , | | |
|
||||
| kube-state-metrics | Spec for the Kube-State-Metrics , | | |
|
||||
| argocd | Spec for the Argo-CD , | | |
|
||||
| prometheus | Spec for the Prometheus instance , | | |
|
||||
| loki | Spec for the Loki instance , | | |
|
||||
|
||||
#### References
|
||||
|
||||
To reference a table ...
|
||||
5
site/docs/get_started/03-concluding.de.md
Normal file
5
site/docs/get_started/03-concluding.de.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Abschliessendes
|
||||
---
|
||||
|
||||
Das war unsere Dokumentation
|
||||
5
site/docs/get_started/03-concluding.en.md
Normal file
5
site/docs/get_started/03-concluding.en.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Concluding
|
||||
---
|
||||
|
||||
This was our documentation
|
||||
16
site/docs/get_started/seo.json
Normal file
16
site/docs/get_started/seo.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"tags": [
|
||||
{
|
||||
"name": "twitter:title",
|
||||
"content":"Docs demo page"
|
||||
},
|
||||
{
|
||||
"name": "twitter:description",
|
||||
"content":"Docs demo page description"
|
||||
},
|
||||
{
|
||||
"name": "Description",
|
||||
"content":"Docs demo page description"
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user