Skip to content

Commit

Permalink
chore: replace docs links (#4843)
Browse files Browse the repository at this point in the history
* chore: replace docs links

* Update index.js

* prettier
  • Loading branch information
fforootd committed Dec 6, 2022
1 parent a1dfe02 commit 5c6971a
Show file tree
Hide file tree
Showing 18 changed files with 58 additions and 72 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Help shaping the future of ZITADEL:
[Contribute](#how-to-contribute)

- [Contribute code](#contribute)
- If you found a mistake on our [docs page](https://docs.zitadel.com) or something is missing please read [the docs section](#contribute-docs)
- If you found a mistake on our [docs page](https://zitadel.com/docs) or something is missing please read [the docs section](#contribute-docs)
- [Translate](#contribute-internationalization) and improve texts

Follow [@zitadel](https://twitter.com/zitadel) on twitter
Expand Down Expand Up @@ -290,7 +290,7 @@ You may edit the texts in these files or create a new file for additional langua
## Want to start ZITADEL?

You can find an installation guide for all the different environments here:
[https://docs.zitadel.com/docs/guides/deploy/overview](https://docs.zitadel.com/docs/guides/deploy/overview)
[https://zitadel.com/docs/guides/deploy/overview](https://zitadel.com/docs/guides/deploy/overview)

## **Did you find a security flaw?**

Expand Down
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,21 @@ With ZITADEL you can rely on a hardened and extensible turnkey solution to solve

---

**[🏡 Website](https://zitadel.com) [💬 Chat](https://zitadel.com/chat) [📋 Docs](https://docs.zitadel.com/) [🧑‍💻 Blog](https://zitadel.com/blog) [📞 Contact](https://zitadel.com/contact/)**
**[🏡 Website](https://zitadel.com) [💬 Chat](https://zitadel.com/chat) [📋 Docs](https://zitadel.com/docs/) [🧑‍💻 Blog](https://zitadel.com/blog) [📞 Contact](https://zitadel.com/contact/)**

## Get started

### Deploy ZITADEL (Self-Hosted)

Deploying ZITADEL locally takes less than 3 minutes. So go ahead and give it a try!

* [Linux](https://docs.zitadel.com/docs/guides/deploy/linux)
* [MacOS](https://docs.zitadel.com/docs/guides/deploy/macos)
* [Docker compose](https://docs.zitadel.com/docs/guides/deploy/compose)
* [Knative](https://docs.zitadel.com/docs/guides/deploy/knative)
* [Kubernetes](https://docs.zitadel.com/docs/guides/deploy/kubernetes)
* [Linux](https://zitadel.com/docs/guides/deploy/linux)
* [MacOS](https://zitadel.com/docs/guides/deploy/macos)
* [Docker compose](https://zitadel.com/docs/guides/deploy/compose)
* [Knative](https://zitadel.com/docs/guides/deploy/knative)
* [Kubernetes](https://zitadel.com/docs/guides/deploy/kubernetes)

See all guides [here](https://docs.zitadel.com/docs/guides/deploy/overview)
See all guides [here](https://zitadel.com/docs/guides/deploy/overview)

> If you are interested to get professional support for your self-hosted ZITADEL [please reach out to us](https://zitadel.com/contact)!
Expand All @@ -71,11 +71,11 @@ Learn more about the [pay-as-you-go pricing](https://zitadel.com/pricing).
We built ZITADEL with a complex multi-tenancy architecture in mind and provide the best solution to handle B2B customers and partners.
Yet it offers everything you need for a customer identity (CIAM) use case.

- [API-first approach](https://docs.zitadel.com/docs/apis/introduction)
- Strong audit trail thanks to [event sourcing](https://docs.zitadel.com/docs/concepts/eventstore/overview) as storage pattern
- [Actions](https://docs.zitadel.com/docs/concepts/features/actions) to react on events with custom code and extended ZITADEL for you needs
- [Branding](https://docs.zitadel.com/docs/guides/manage/customize/branding) for a uniform user experience across multiple organizations
- [Self-service](https://docs.zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators
- [API-first approach](https://zitadel.com/docs/apis/introduction)
- Strong audit trail thanks to [event sourcing](https://zitadel.com/docs/concepts/eventstore/overview) as storage pattern
- [Actions](https://zitadel.com/docs/concepts/features/actions) to react on events with custom code and extended ZITADEL for you needs
- [Branding](https://zitadel.com/docs/guides/manage/customize/branding) for a uniform user experience across multiple organizations
- [Self-service](https://zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators
- [CockroachDB](https://www.cockroachlabs.com/) or a [Postgres](https://www.postgresql.org/) database as reliable and widespread storage option

## Features
Expand All @@ -84,30 +84,30 @@ Yet it offers everything you need for a customer identity (CIAM) use case.
- Passwordless with FIDO2 support (Including Passkeys)
- Username / Password
- Multifactor authentication with OTP, U2F
- [Identity Brokering](https://docs.zitadel.com/docs/guides/integrate/identity-brokering)
- [Machine-to-machine (JWT profile)](https://docs.zitadel.com/docs/guides/integrate/serviceusers)
- [Identity Brokering](https://zitadel.com/docs/guides/integrate/identity-brokering)
- [Machine-to-machine (JWT profile)](https://zitadel.com/docs/guides/integrate/serviceusers)
- Personal Access Tokens (PAT)
- Role Based Access Control (RBAC)
- [Delegate role management to third-parties](https://docs.zitadel.com/docs/guides/manage/console/projects)
- [Self-registration](https://docs.zitadel.com/docs/concepts/features/selfservice#registration) including verification
- [Self-service](https://docs.zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators
- [OpenID Connect certified](https://openid.net/certification/#OPs) => [OIDC Endpoints](https://docs.zitadel.com/docs/apis/openidoauth/endpoints), [OIDC Integration Guides](https://docs.zitadel.com/docs/guides/integrate/auth0-oidc)
- [SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) => [SAML Endpoints](https://docs.zitadel.com/docs/apis/saml/endpoints), [SAML Integration Guides](https://docs.zitadel.com/docs/guides/integrate/auth0-saml)
- [Postgres](https://docs.zitadel.com/docs/guides/manage/self-hosted/database#postgres) (version >= 14) or [CockroachDB](https://docs.zitadel.com/docs/guides/manage/self-hosted/database#cockroach) (version >= 22.0)
- [Delegate role management to third-parties](https://zitadel.com/docs/guides/manage/console/projects)
- [Self-registration](https://zitadel.com/docs/concepts/features/selfservice#registration) including verification
- [Self-service](https://zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators
- [OpenID Connect certified](https://openid.net/certification/#OPs) => [OIDC Endpoints](https://zitadel.com/docs/apis/openidoauth/endpoints), [OIDC Integration Guides](https://zitadel.com/docs/guides/integrate/auth0-oidc)
- [SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) => [SAML Endpoints](https://zitadel.com/docs/apis/saml/endpoints), [SAML Integration Guides](https://zitadel.com/docs/guides/integrate/auth0-saml)
- [Postgres](https://zitadel.com/docs/guides/manage/self-hosted/database#postgres) (version >= 14) or [CockroachDB](https://zitadel.com/docs/guides/manage/self-hosted/database#cockroach) (version >= 22.0)

Track upcoming features on our [roadmap](https://zitadel.com/roadmap).

## Integrate your application

### Quickstarts

Get started with your preferred language with our [Quickstarts](https://docs.zitadel.com/docs/examples/introduction).
Get started with your preferred language with our [Quickstarts](https://zitadel.com/docs/examples/introduction).

> If you miss something please feel free to [join the Discussion](https://github.com/zitadel/zitadel/discussions/1717)
### Example applications

Clone one of our [example applications](https://docs.zitadel.com/docs/examples/introduction#clone-a-sample-project) or deploy them directly to Vercel.
Clone one of our [example applications](https://zitadel.com/docs/examples/introduction#clone-a-sample-project) or deploy them directly to Vercel.

### OpenID Connect RP Libraries

Expand All @@ -127,7 +127,7 @@ As certified OpenID Provider, ZITADEL is compatible with any of the implementati
| Python | 🚧 [WIP](https://github.com/zitadel/zitadel/issues/3675) ||| | TBD |
| Javascript |||| | Maybe you? |

(\*) Automatically authenticate service accounts with [JWT Profile](https://docs.zitadel.com/docs/apis/openidoauth/grant-types#json-web-token-jwt-profile).
(\*) Automatically authenticate service accounts with [JWT Profile](https://zitadel.com/docs/apis/openidoauth/grant-types#json-web-token-jwt-profile).
(\*\*) Automatically check if the access token is valid and claims match

## How To Contribute
Expand All @@ -151,13 +151,13 @@ Use our login widget to allow easy and secure access to your applications and en
- works on all modern platforms, devices, and browsers
- phishing resistant alternative
- requires only one gesture by the user
- easy [enrollment](https://docs.zitadel.com/docs/manuals/user-profile) of the device during registration
- easy [enrollment](https://zitadel.com/docs/manuals/user-profile) of the device during registration

![passwordless-windows-hello](https://user-images.githubusercontent.com/1366906/118765435-5d419780-b87b-11eb-95bf-55140119c0d8.gif)

### Admin Console

Use [Console](https://docs.zitadel.com/docs/manuals/introduction) or our [APIs](https://docs.zitadel.com/docs/apis/introduction) to setup organizations, projects and applications.
Use [Console](https://zitadel.com/docs/manuals/introduction) or our [APIs](https://zitadel.com/docs/apis/introduction) to setup organizations, projects and applications.

[![Console Showcase](http://img.youtube.com/vi/RPpHktAcCtk/0.jpg)](http://www.youtube.com/watch?v=RPpHktAcCtk "Console Showcase")

Expand Down
4 changes: 2 additions & 2 deletions cmd/defaults.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -419,8 +419,8 @@ DefaultInstance:
SecondFactorCheckLifetime: 18h
MultiFactorCheckLifetime: 12h
PrivacyPolicy:
TOSLink: https://docs.zitadel.com/docs/legal/terms-of-service
PrivacyLink: https://docs.zitadel.com/docs/legal/privacy-policy
TOSLink: https://zitadel.com/docs/legal/terms-of-service
PrivacyLink: https://zitadel.com/docs/legal/privacy-policy
HelpLink: ""
LabelPolicy:
PrimaryColor: "#5469d4"
Expand Down
2 changes: 1 addition & 1 deletion console/src/app/modules/header/header.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@

<span class="fill-space"></span>

<a class="doc-link" href="https://docs.zitadel.com" mat-stroked-button target="_blank">
<a class="doc-link" href="https://zitadel.com/docs" mat-stroked-button target="_blank">
{{ 'MENU.DOCUMENTATION' | translate }}
</a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
>
<p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'PROJECT.MEMBER.DESCRIPTION' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.com/docs/concepts/structure/managers" target="_blank">
<a mat-icon-button href="https://zitadel.com/docs/concepts/structure/managers" target="_blank">
<i class="las la-info-circle"></i>
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion console/src/app/pages/domains/domains.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<h1>{{ 'ORG.DOMAINS.TITLE' | translate }}</h1>
<a
mat-icon-button
href="https://docs.zitadel.com/docs/guides/manage/console/organizations#how-zitadel-handles-usernames"
href="https://zitadel.com/docs/guides/manage/console/organizations#how-zitadel-handles-usernames"
rel="noreferrer"
target="_blank"
>
Expand Down
11 changes: 3 additions & 8 deletions console/src/app/pages/home/home.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,21 @@ <h1 class="title" data-e2e="authenticated-welcome">{{ 'HOME.WELCOME' | translate

<span class="fill-space"></span>
<div class="home-grid-container">
<a href="https://docs.zitadel.com" target="_blank" rel="noreferrer" class="grid-item blue">
<a href="https://zitadel.com/docs" target="_blank" rel="noreferrer" class="grid-item blue">
<div class="grid-item-avatar blue">
<i class="icon las la-file-alt"></i>
</div>
<span>{{ 'HOME.DOCUMENTATION.TITLE' | translate }}</span>
</a>

<a
href="https://docs.zitadel.com/docs/guides/start/quickstart"
target="_blank"
rel="noreferrer"
class="grid-item green"
>
<a href="https://zitadel.com/docs/guides/start/quickstart" target="_blank" rel="noreferrer" class="grid-item green">
<div class="grid-item-avatar green">
<i class="icon las la-play"></i>
</div>
<span>{{ 'HOME.GETSTARTED.TITLE' | translate }}</span>
</a>

<a href="https://docs.zitadel.com/docs/examples/introduction" target="_blank" rel="noreferrer" class="grid-item green">
<a href="https://zitadel.com/docs/examples/introduction" target="_blank" rel="noreferrer" class="grid-item green">
<div class="grid-item-avatar green">
<i class="icon las la-play"></i>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<cnsl-detail-layout [hasBackButton]="true" title="{{ 'IAM.MEMBER.TITLE' | translate }}">
<p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'IAM.MEMBER.DESCRIPTION' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.com/docs/concepts/structure/managers" target="_blank">
<a mat-icon-button href="https://zitadel.com/docs/concepts/structure/managers" target="_blank">
<i class="las la-info-circle"></i>
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<cnsl-detail-layout title="{{ org?.name }} {{ 'ORG.MEMBER.TITLE' | translate }}">
<p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'ORG.MEMBER.DESCRIPTION' | translate }}</span>
<a mat-icon-button href="https://docs.zitadel.com/docs/concepts/structure/managers" target="_blank">
<a mat-icon-button href="https://zitadel.com/docs/concepts/structure/managers" target="_blank">
<i class="las la-info-circle"></i>
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<cnsl-top-view
title="{{ app?.name }}"
[hasActions]="isZitadel === false && (['project.app.write:' + projectId, 'project.app.write'] | hasRole | async)"
docLink="https://docs.zitadel.com/docs/guides/manage/console/projects"
docLink="https://zitadel.com/docs/guides/manage/console/projects"
[sub]="app?.oidcConfig ? ('APP.OIDC.APPTYPE.' + app?.oidcConfig?.appType | translate) : app?.apiConfig ? 'API' : 'SAML'"
[isActive]="app?.state === AppState.APP_STATE_ACTIVE"
[isInactive]="app?.state === AppState.APP_STATE_INACTIVE"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<cnsl-top-view
title="{{ project?.projectName }}"
[hasActions]="false"
docLink="https://docs.zitadel.com/docs/guides/manage/console/projects#what-is-a-granted-project"
docLink="https://zitadel.com/docs/guides/manage/console/projects#what-is-a-granted-project"
sub="{{ 'PROJECT.PAGES.TYPE.GRANTED_SINGULAR' | translate }} {{ 'ACTIONS.OF' | translate }} <strong>{{
project?.projectOwnerName
}}</strong>"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<cnsl-top-view
title="{{ project?.name }}"
docLink="https://docs.zitadel.com/docs/guides/manage/console/projects"
docLink="https://zitadel.com/docs/guides/manage/console/projects"
sub="{{ 'PROJECT.PAGES.TYPE.OWNED_SINGULAR' | translate }}"
[isActive]="project?.state === ProjectState.PROJECT_STATE_ACTIVE"
[isInactive]="project?.state === ProjectState.PROJECT_STATE_INACTIVE"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
<cnsl-detail-layout [hasBackButton]="true" title="{{ 'PROJECT.GRANT.DETAIL.TITLE' | translate }}">
<p class="subinfo" sub>
<span class="cnsl-secondary-text">{{ 'PROJECT.GRANT.DETAIL.DESC' | translate }}</span>
<a
mat-icon-button
href="https://docs.zitadel.com/docs/concepts/structure/projects#granted-organizations"
target="_blank"
>
<a mat-icon-button href="https://zitadel.com/docs/concepts/structure/projects#granted-organizations" target="_blank">
<i class="las la-info-circle"></i>
</a>
</p>
Expand Down
7 changes: 1 addition & 6 deletions console/src/app/pages/projects/projects.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@
<div class="enlarged-container">
<div class="project-title-row">
<h1>{{ 'PROJECT.PAGES.LIST' | translate }}</h1>
<a
mat-icon-button
href="https://docs.zitadel.com/docs/guides/manage/console/projects"
rel="noreferrer"
target="_blank"
>
<a mat-icon-button href="https://zitadel.com/docs/guides/manage/console/projects" rel="noreferrer" target="_blank">
<i class="las la-info-circle"></i>
</a>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<cnsl-top-view
*ngIf="user"
title="{{ user.human ? user.human.profile?.displayName : user.machine?.name }}"
docLink="https://docs.zitadel.com/docs/guides/manage/console/projects"
docLink="https://zitadel.com/docs/guides/manage/console/projects"
sub="{{ user.preferredLoginName }}"
[isActive]="user.state === UserState.USER_STATE_ACTIVE"
[isInactive]="user.state === UserState.USER_STATE_INACTIVE"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<ng-container *ngSwitchCase="Type.TYPE_HUMAN">
<div class="users-title-row">
<h1>{{ 'USER.PAGES.LIST' | translate }}</h1>
<a mat-icon-button href="https://docs.zitadel.com/docs/concepts/structure/users" rel="noreferrer" target="_blank">
<a mat-icon-button href="https://zitadel.com/docs/concepts/structure/users" rel="noreferrer" target="_blank">
<i class="las la-info-circle"></i>
</a>
</div>
Expand Down

0 comments on commit 5c6971a

Please sign in to comment.