docs:change titles (#6582)

* Modified quick start guide to reflect the new onboarding changes.

* Modified titles to optimize indexing. Left thet titles in title case for now.

* Added side bar labels and also made minor changes to titles.

* Update docs/docs/apis/openidoauth/endpoints.mdx

Co-authored-by: Fabi <[email protected]>

---------

Co-authored-by: Fabi <[email protected]>
This commit is contained in:
Dakshitha Ratnayake
2023-09-19 13:50:00 +02:00
committed by GitHub
co-authored by Fabi
parent a5decda201
commit 599a1ddd78
137 changed files with 304 additions and 201 deletions
+53 -32
View File
@@ -1,5 +1,6 @@
---
title: Quick start guide
title: The ZITADEL Quick Start Guide
sidebar_label: Quick Start Guide
---
import VSCodeFolderView from "../../../static/img/guides/quickstart/vscode1.png";
@@ -66,45 +67,55 @@ The order of creation for the above components may vary depending on the specifi
### 1. Sign up for the ZITADEL Cloud customer portal and register your organization
1. Go to [zitadel.com](http://zitadel.com) and click on “Start for FREE”.
1. Go to [zitadel.com](http://zitadel.com) and click “Start for FREE”.
![Home Page](/img/guides/quickstart/1.png)
![Home Page](/img/guides/quickstart/v3_1.png)
2. Enter your details as shown below and click the "Let's go" button.
![Registration Page](/img/guides/quickstart/2.png)
2. You can sign up by entering your email address or via social login, e.g., Google. Let's sign up using an email address. Enter your email address and click "Sign in with Email".
3. You will receive a verification email to verify the user for the Customer Portal. Click the “Sign in” button.
![Registration Page](/img/guides/quickstart/v3_2.png)
![Congratulations Page](/img/guides/quickstart/3.png)
4. You will be prompted for a code, which has been emailed to you.
3. Next, complete your details and click "Continue".
![Code](/img/guides/quickstart/4.png)
![Congratulations Page](/img/guides/quickstart/v3_3.png)
5. Check your inbox for the code. You can either click the “Finish initialization” button in the email itself or copy the code and return to the previous page. In this guide, we will copy the code and then continue from where we left off.
![Inbox](/img/guides/quickstart/5.png)
4. Add a password as shown below. Adhere to the password requirements, agree to the terms of service and privacy policy by selecting the checkbox, and click the "Get started" button.
6. Paste the code and add a password as shown below. Click on the “next” button.
![Code](/img/guides/quickstart/v3_4.png)
![Code](/img/guides/quickstart/6.png)
7. The user is now activated. Click on “next” to log in.
5. Enter your login data. Provide the password you just created. Click "next".
![User Activated](/img/guides/quickstart/7.png)
![Inbox](/img/guides/quickstart/v3_5.png)
8. Login with the username and password that you provided. Click “next”.
![Login](/img/guides/quickstart/8.png)
6. You will now have to verify your email address.
9. You should set up 2-factor authentication. However, we will skip this step for now. Click on “skip”.
![Verify Email](/img/guides/quickstart/v3_17.png)
![2-factor Authentication](/img/guides/quickstart/9.png)
10. You will now be asked to create an instance.
6. Go to your inbox and open the email from ZITADEL and click the "Verify email" button.
![Code](/img/guides/quickstart/v3_6.png)
7. The user is now activated. Click the "login" button.
![User Activated](/img/guides/quickstart/v3_7.png)
8. Now you will have to log in with the username and password that you provided. Click “Sign in with Email”.
![Login](/img/guides/quickstart/v3_8.png)
9. You will now be asked to create an instance.
![2-factor Authentication](/img/guides/quickstart/v3_9.png)
![Create Instance](/img/guides/quickstart/10.png)
### 2. Create your first instance
@@ -112,41 +123,51 @@ As a user of the ZITADEL Cloud Customer Portal, you now can create multiple inst
1. Let’s create an instance. Click on “Create new instance”.
![Create Instance](/img/guides/quickstart/10.png)
![2-factor Authentication](/img/guides/quickstart/v3_9.png)
2. Provide a name for your instance, select the “Free” plan and click on the “Continue” button at the bottom of this screen.
![Select Tier](/img/guides/quickstart/v2_1.png)
![Select Tier](/img/guides/quickstart/v3_10.png)
3. Next, you should see the following screen. Add a username and password for the instance manager and click "Create".
![Instance Details](/img/guides/quickstart/v2_2.png)
![Instance Details](/img/guides/quickstart/v3_11.png)
4. The instance creation process will take a few seconds.
![Instance Details](/img/guides/quickstart/v2_3.png)
![Instance Details](/img/guides/quickstart/v3_12.png)
5. Now you will see the details of your first instance. You can click on "Visit" at the top right to go to your instance.
![Instance Details](/img/guides/quickstart/v2_4.png)
![Instance Details](/img/guides/quickstart/v3_13.png)
6. To log in to your instance, provide the username and password, and click “next”.
![Instance Details](/img/guides/quickstart/v2_5.png)
![Instance Details](/img/guides/quickstart/v3_14.png)
7. Skip the 2-factor authentication for now by clicking “skip”.
![Instance Details](/img/guides/quickstart/v2_6.png)
![Instance Details](/img/guides/quickstart/v3_15.png)
10. And there you go! You now have access to your instance.
8. And there you go! You now have access to your instance.
![Instance Details](/img/guides/quickstart/v3_16.png)
![Access Instance](/img/guides/quickstart/v2_7.png)
### 3. Create your first project
1. To create a project in the instance you just created, click on “Create Project”.
1. To create a project in the instance you just created, click on “Create a project”.
![Create Project](/img/guides/quickstart/v3_16.png)
![Create Project](/img/guides/quickstart/19.png)
2. Insert “Project1” (or any name of your choice) as the project’s name and click the “Continue” button.