TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-11-14 14:53:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(documentation): documentation and manuals for ZITADEL (#710)

Browse Source 
* chore: cleanup old docs folder

* remove docs path trigger

* wip docs structure

* chore: ignore site changes in ci

* add manuals route

* new structure

* structure

* Use correct title

* remove trigger for code scan for static site generator

* change names

* add lorem ipsum to test styling

* use h3 to deeplink

* add site to dependabot

* lint readme.md

* remove not needed file

* ignore site on pull request code scan

* add initial contrib

* Minor correction

* Added section Developer & Integration

* Changed link list layout, added labels, added translations

* Added missing <li> tags

* Added correct link to section Developer & Integration

* Fixing list style

* Overhauling description texts and translations

* outline

* teaser go

* outline

* wip

* rework

* wip

* wip

* wip

* hop

* wip

* first draft for "administrate" done

* init outline

* fix deploy step

* lint

* commit wip

* commit wip

* md lint

* Link

* fix: path to edit (#711)

* wip

* wip

* wip

* what are...

* use only features

* wip docs

* Update 00-user.en.md

* project

* uppercase en

* wip

* wip

* wip

* policies rework

* improve text

* correct typo

* update readme

* correct styling

* add link to docs guides

* make the linter happy

* rename

* wip

* move api to own file

* correct links and lint

* wip roles and integration

* add pkce

* reduce padding and margin

* wip scope and claims

* wip claim & scopes

* make the linter happy

* insert links where possible

* wip

* wip roles & providers

* Update README.md

* Update 00-user.en.md

* minor text improvements

* use master branch to deploy

* use proper ci file

* Apply suggestions from code review

Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com>

Co-authored-by: Matthias M. Schneider <mati@matimax.info>
Co-authored-by: Max Peintner <max@caos.ch>
Co-authored-by: Fabi <38692350+fgerschwiler@users.noreply.github.com>
This commit is contained in:
Florian Forster
2020-10-16 14:13:02 +02:00
committed by GitHub
parent b1d61afc8f
commit ef3b7482cd
70 changed files with 1143 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
site/src/components/Docs.svelte
View File

@@ -4,8 +4,8 @@
import Icon from "./Icon.svelte";
import manifest from '../../static/manifest.json';
export let owner = "caos";
export let project = "zitadel/site";
export let path = "/docs";
export let project = "zitadel";
export let path = "site/docs";
export let dir = "";
export let edit_title = "edit this section";
export let sections;
@@ -201,7 +201,7 @@
}
.content h2 {
margin-top: 8rem;
margin-top: 4rem;
padding: 2rem 1.6rem 4rem 0.2rem;
border-top: var(--border-w) solid #6767785b; /* based on --second */
color: var(--text);
@@ -265,8 +265,8 @@
.content :global(h3),
.content :global(h3 > code) {
margin: 6.4rem 0 0 0;
padding: 2rem 1.6rem 5.6rem 0.2rem;
margin: 2.0rem 0 0 0;
padding: 2rem 1.6rem 2.0rem 0.2rem;
color: var(--text);
border-top: var(--border-w) solid #6767781f; /* based on --second */
background: transparent;
@@ -292,7 +292,7 @@
font-weight: 500;
font-size: 2.4rem;
color: var(--text);
margin: 6.4rem 0 1.6rem 0;
margin: 2.0rem 0 1.6rem 0;
padding-left: 0;
background: transparent;
line-height: 1;

22
site/src/messages/de.json
View File

@@ -1,8 +1,16 @@
{
"title": "Zitadel Identity and Access Management",
"description":"Die meisten Apps müssen die Identität eines Benutzers kennen. Wenn Sie die Identität eines Benutzers kennen, kann eine App Benutzerdaten sicher speichern und auf allen Geräten des Benutzers dieselbe personalisierte Erfahrung bieten.",
"description2":"Die Zitadel-Authentifizierung bietet Backend-Dienste, benutzerfreundliche SDKs und vorgefertigte UI-Bibliotheken zur Authentifizierung von Benutzern bei Ihrer App. Es unterstützt die Authentifizierung mithilfe von Passwörtern und bietet weitere Sicherheitsmechanismen, wie einen zweiten Faktor über OTP um einen sicheren Zugang zu gewährleisten.",
"description3":"Zitadel nutzt Industriestandards wie OAuth 2.0 und OpenID Connect, sodass sie problemlos in Ihr benutzerdefiniertes Backend integriert werden kann.",
"button":"Erfahren Sie wie sie starten",
"toconsole":"Zur Zitadel Konsole"
}
"title": "ZITADEL Identity and Access Management",
"description":"Die meisten Applikationen müssen die Identität eines Benutzers kennen, um Benutzerdaten sicher zu speichern und auf allen Geräten des Benutzers dieselbe personalisierte Erfahrung zu bieten.",
"description2":"Die Authentifizierung von ZITADEL bietet Backend-Dienste, benutzerfreundliche SDKs und vorgefertigte UI-Bibliotheken zur Authentifizierung von Benutzern in Ihrer Applikation. Es unterstützt die Authentifizierung mithilfe von Passwörtern und bietet weitere Sicherheitsmechanismen, wie einen zweiten Faktor beispielsweise über OTP, um einen sicheren Zugang zu gewährleisten.",
"description3":"ZITADEL nutzt Industriestandards wie OAuth 2.0 und OpenID Connect, die leicht in Ihr benutzerdefiniertes Backend integriert werden können.",
"startlink": "Erfahren Sie hier, wie Sie starten",
"integratelink": "Sichern Sie Ihre Applikationen und Schnittstellen",
"administratelink": "Administrieren",
"developlink":"Entwickeln",
"docslink":"Dokumentation",
"uselink":"Benutzer Handbuch",
"toconsole":"ZITADEL Console öffnen"
}

21
site/src/messages/en.json
View File

@@ -1,8 +1,15 @@
{
"title": "Zitadel Identity and Access Management",
"description":"Most apps need to know the identity of a user. Knowing a user's identity allows an app to securely save user data in the cloud and provide the same personalized experience across all of the user's devices.",
"description2":"Zitadel Authentication provides backend services, easy-to-use SDKs, and ready-made UI libraries to authenticate users to your app. It supports authentication using passwords and uses additional Security, like a second Factor over OTP ensure a safe access.",
"description3":"Zitadel Authentication leverages industry standards like OAuth 2.0 and OpenID Connect, so it can be easily integrated with your custom backend.",
"button":"Learn how to get started",
"toconsole":"Go to zitadel console"
}
"title": "ZITADEL Identity and Access Management",
"description":"Most applications need to know the identity of a user allowing to securely store user data in the cloud and provide the same personalised experience across all of the user's devices.",
"description2":"ZITADEL's authentication provides backend services, easy-to-use SDKs, and ready-made UI libraries to authenticate users in your applicqtion. It supports authentication using passwords and applies additional security wirh the help of a second factor, for example OTP, to ensure a safe and secure access.",
"description3":"ZITADEL's authentication leverages industry standards like OAuth 2.0 and OpenID Connect so that it can be easily integrated in your custom backend.",
"startlink": "Start using ZITADEL",
"integratelink": "Secure your applications and apis with ZITADEL",
"administratelink": "Administrate ZITADEL",
"developlink":"Develop with the ZITADEL api's",
"docslink":"ZITADEL Documentations",
"uselink":"User Manuals",
"toconsole":"Open ZITADEL Console"
}

14
site/src/routes/index.svelte
View File

@@ -39,7 +39,7 @@
<svelte:head>
<title>
Caos • Documentation
ZITADEL • Documentation
</title>
</svelte:head>
@@ -51,7 +51,15 @@
<p>{$_('description')}</p>
<p>{$_('description2')}</p>
<p>{$_('description3')}</p>
<a href="/get_started" >{$_('button')}</a>
<ul style="list-style-type: none;">
<li><a href="/start" >{$_('startlink')}</a></li>
<li><a href="/integrate" >{$_('integratelink')}</a></li>
<li><a href="/administrate" >{$_('administratelink')}</a></li>
<li><a href="/develop" >{$_('developlink')}</a></li>
<li><a href="/documentation" >{$_('docslink')}</a></li>
<li><a href="/use" >{$_('uselink')}</a></li>
</ul>
</div>
</Section>