From e775b0d56ce8caea3eaa245f903639f9a4ae2bd1 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Sun, 29 Oct 2023 22:31:34 +0530 Subject: [PATCH 1/6] add getting started Signed-off-by: Pranav Singh --- content/en/Cloud/Getting started/_index.md | 8 +--- .../Getting started/onboarding/_index.md | 5 ++ .../_index.md | 47 +++++++++++++++++++ .../en/Cloud/Identity/organizations/_index.md | 2 +- content/en/Cloud/Overview/_index.md | 2 +- 5 files changed, 56 insertions(+), 8 deletions(-) create mode 100644 content/en/Cloud/Getting started/onboarding/_index.md create mode 100644 content/en/Cloud/Getting started/onboarding/getting-started-with-layer5-account/_index.md diff --git a/content/en/Cloud/Getting started/_index.md b/content/en/Cloud/Getting started/_index.md index dead7e4e..8d2759e0 100644 --- a/content/en/Cloud/Getting started/_index.md +++ b/content/en/Cloud/Getting started/_index.md @@ -1,14 +1,10 @@ --- title: Getting Started -description: What does your user need to know to try your project? - +description: Learn how to effectively manage your organizations, teams, users, workspaces, environments, and more. +weight: 1 --- -{{% pageinfo %}} -This is a placeholder page that shows you how to use this template site. -{{% /pageinfo %}} - Information in this section helps your user try your project themselves. * What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements. diff --git a/content/en/Cloud/Getting started/onboarding/_index.md b/content/en/Cloud/Getting started/onboarding/_index.md new file mode 100644 index 00000000..256b04c9 --- /dev/null +++ b/content/en/Cloud/Getting started/onboarding/_index.md @@ -0,0 +1,5 @@ +--- +title: Onboarding +weight: 1 + +--- \ No newline at end of file diff --git a/content/en/Cloud/Getting started/onboarding/getting-started-with-layer5-account/_index.md b/content/en/Cloud/Getting started/onboarding/getting-started-with-layer5-account/_index.md new file mode 100644 index 00000000..28ddf030 --- /dev/null +++ b/content/en/Cloud/Getting started/onboarding/getting-started-with-layer5-account/_index.md @@ -0,0 +1,47 @@ +--- +title: Getting started with your Layer5 account +description: With a personal account on Layer5 Cloud, you can import or create infrastructural designs, collaborate with others through workspaces and teams, and more. +weight: 1 +--- + +This guide will walk you through setting up your Layer5 account and getting started with Layer5 Cloud's features for collaboration and infrastructure management. + +## Configuring your Layer5 account + +The first steps in starting with Layer5 are to create an account, verify your email, setup an organization and a workspace, and view your profile. + +There are several types of accounts on Layer5. Every person who uses Layer5 Cloud has their own personal account, which can be part of multiple organizations and teams. Your personal account is your identity on Layer5 Cloud and represents you as an individual. + +1. Creating an account + +To sign up for an account on cloud.layer5.io, navigate to and follow the prompts. +You may choose to either signup with your personal email or any of our supported OAuth providers like Github and Gmail. See "OAuth Providers" for more information. + +To keep your Layer5 account secure you should use a strong and unique password. For more information, see "Creating a strong password." + +2. Verifying your email address + +To ensure you can use all the features in your Layer5 plan, verify your email address after signing up for a new account. For more information, see "Verifying your email address." + + + +3. Creating an organization + +Organization are unit of tenant in Layer5 Cloud. Every user on Layer5 Cloud is part of at least one organization. You can create your own organization or join an existing one. By default you are the owner of the organization you create. For more information, see "About organizations." + + +4. Creating a workspace + +Workspaces are logical group of shared set of resources like environments, connections, credentials, infrastructural designs and more. Every user on Layer5 Cloud is part of at least one workspace. You can create your own workspace or join an existing one. By default you are the owner of the workspace you create. You can share access to resouces in your workspaces through teams. For more information, see "About workspaces." + +5. Viewing your Layer5 profile + +Your Layer5 profile tells people the story of your work through the recent activites, and infrastructure designs that you've published to Cloud catalog, the organization memberships you've chosen to publicize. For more information, see "About your profile". + + +## \ No newline at end of file diff --git a/content/en/Cloud/Identity/organizations/_index.md b/content/en/Cloud/Identity/organizations/_index.md index fc377f1f..ae0abd0a 100755 --- a/content/en/Cloud/Identity/organizations/_index.md +++ b/content/en/Cloud/Identity/organizations/_index.md @@ -9,4 +9,4 @@ date: 2023-10-28 Organizations, Teams, Users {{% /pageinfo %}} -YOu can create any number of these. \ No newline at end of file +YOu can create any number of these. diff --git a/content/en/Cloud/Overview/_index.md b/content/en/Cloud/Overview/_index.md index 53523d15..bd4d7da4 100644 --- a/content/en/Cloud/Overview/_index.md +++ b/content/en/Cloud/Overview/_index.md @@ -1,7 +1,7 @@ --- title: Overview description: Here's where your user finds out if your project is for them. -weight: 1 +weight: 2 categories: [Examples, Placeholders] tags: [test, docs] --- From 67f59f6f8bb3d45db9d2e07c35d999861f4517a7 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Sun, 29 Oct 2023 22:33:05 +0530 Subject: [PATCH 2/6] improve naming of folders Signed-off-by: Pranav Singh --- content/en/Cloud/{Getting started => getting-started}/_index.md | 0 .../en/Cloud/{Getting started => getting-started}/example-page.md | 0 .../{Getting started => getting-started}/onboarding/_index.md | 0 .../onboarding/getting-started-with-layer5-account/_index.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename content/en/Cloud/{Getting started => getting-started}/_index.md (100%) rename content/en/Cloud/{Getting started => getting-started}/example-page.md (100%) rename content/en/Cloud/{Getting started => getting-started}/onboarding/_index.md (100%) rename content/en/Cloud/{Getting started => getting-started}/onboarding/getting-started-with-layer5-account/_index.md (100%) diff --git a/content/en/Cloud/Getting started/_index.md b/content/en/Cloud/getting-started/_index.md similarity index 100% rename from content/en/Cloud/Getting started/_index.md rename to content/en/Cloud/getting-started/_index.md diff --git a/content/en/Cloud/Getting started/example-page.md b/content/en/Cloud/getting-started/example-page.md similarity index 100% rename from content/en/Cloud/Getting started/example-page.md rename to content/en/Cloud/getting-started/example-page.md diff --git a/content/en/Cloud/Getting started/onboarding/_index.md b/content/en/Cloud/getting-started/onboarding/_index.md similarity index 100% rename from content/en/Cloud/Getting started/onboarding/_index.md rename to content/en/Cloud/getting-started/onboarding/_index.md diff --git a/content/en/Cloud/Getting started/onboarding/getting-started-with-layer5-account/_index.md b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md similarity index 100% rename from content/en/Cloud/Getting started/onboarding/getting-started-with-layer5-account/_index.md rename to content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md From e443dfdddcec6efe125ba1d1ece95710f99f28f1 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Sun, 29 Oct 2023 22:43:29 +0530 Subject: [PATCH 3/6] fix onboarding Signed-off-by: Pranav Singh --- .../onboarding/getting-started-with-layer5-account/_index.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md index 28ddf030..883c5108 100644 --- a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md +++ b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md @@ -14,7 +14,7 @@ There are several types of accounts on Layer5. Every person who uses Layer5 Clou 1. Creating an account -To sign up for an account on cloud.layer5.io, navigate to and follow the prompts. +To sign up for an account on cloud.layer5.io, navigate to and follow the prompts. You may choose to either signup with your personal email or any of our supported OAuth providers like Github and Gmail. See "OAuth Providers" for more information. To keep your Layer5 account secure you should use a strong and unique password. For more information, see "Creating a strong password." @@ -42,6 +42,3 @@ Workspaces are logical group of shared set of resources like environments, conne 5. Viewing your Layer5 profile Your Layer5 profile tells people the story of your work through the recent activites, and infrastructure designs that you've published to Cloud catalog, the organization memberships you've chosen to publicize. For more information, see "About your profile". - - -## \ No newline at end of file From 34c3eb976e8c1c78f9e6fb782d0a1b4ebcb1ca52 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Sun, 29 Oct 2023 22:55:16 +0530 Subject: [PATCH 4/6] hyperlink keywords Signed-off-by: Pranav Singh --- .../getting-started-with-layer5-account/_index.md | 6 +++--- content/en/Cloud/workspaces/_index.md | 8 ++++++++ 2 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 content/en/Cloud/workspaces/_index.md diff --git a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md index 883c5108..c43f6c6b 100644 --- a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md +++ b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md @@ -32,13 +32,13 @@ Optionally, after you have configured 2FA, add a passkey to your account to enab 3. Creating an organization -Organization are unit of tenant in Layer5 Cloud. Every user on Layer5 Cloud is part of at least one organization. You can create your own organization or join an existing one. By default you are the owner of the organization you create. For more information, see "About organizations." +Organization are unit of tenant in Layer5 Cloud. Every user on Layer5 Cloud is part of at least one organization. You can create your own organization or join an existing one. By default you are the owner of the organization you create. For more information, see "[Organizations](/cloud/identity/organizations/)". 4. Creating a workspace -Workspaces are logical group of shared set of resources like environments, connections, credentials, infrastructural designs and more. Every user on Layer5 Cloud is part of at least one workspace. You can create your own workspace or join an existing one. By default you are the owner of the workspace you create. You can share access to resouces in your workspaces through teams. For more information, see "About workspaces." +Workspaces are logical group of shared set of resources like environments, connections, credentials, infrastructural designs and more. Every user on Layer5 Cloud is part of at least one workspace. You can create your own workspace or join an existing one. By default you are the owner of the workspace you create. You can share access to resouces in your workspaces through teams. For more information, see "[Workspaces](/cloud/workspaces/)". 5. Viewing your Layer5 profile -Your Layer5 profile tells people the story of your work through the recent activites, and infrastructure designs that you've published to Cloud catalog, the organization memberships you've chosen to publicize. For more information, see "About your profile". +Your Layer5 profile tells people the story of your work through the recent activites, designs that you've published to Cloud catalog. For more information, see "About your profile". diff --git a/content/en/Cloud/workspaces/_index.md b/content/en/Cloud/workspaces/_index.md new file mode 100644 index 00000000..a06bdfcd --- /dev/null +++ b/content/en/Cloud/workspaces/_index.md @@ -0,0 +1,8 @@ +--- +title: Workspaces +description: > + A short lead description about this section page. Text here can also be **bold** or _italic_ and can even be split over multiple paragraphs. +date: 2023-10-28 +weight: 6 + +--- \ No newline at end of file From 87a61186c6ffa6f886457be4e49951da7f31a071 Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Sun, 29 Oct 2023 23:12:13 +0530 Subject: [PATCH 5/6] reduce ambiguity; improve flow Signed-off-by: Pranav Singh --- .../_index.md | 26 +++++++++++++------ 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md index c43f6c6b..38f707e0 100644 --- a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md +++ b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md @@ -1,24 +1,22 @@ --- title: Getting started with your Layer5 account -description: With a personal account on Layer5 Cloud, you can import or create infrastructural designs, collaborate with others through workspaces and teams, and more. +description: With a personal account on Layer5 Cloud, you can import or create infrastructural designs, collaborate with others through workspaces and teams, manage your organizations and more. weight: 1 --- -This guide will walk you through setting up your Layer5 account and getting started with Layer5 Cloud's features for collaboration and infrastructure management. +This guide will walk you through setting up your Layer5 account. ## Configuring your Layer5 account The first steps in starting with Layer5 are to create an account, verify your email, setup an organization and a workspace, and view your profile. -There are several types of accounts on Layer5. Every person who uses Layer5 Cloud has their own personal account, which can be part of multiple organizations and teams. Your personal account is your identity on Layer5 Cloud and represents you as an individual. + Every person who uses Layer5 Cloud has their own personal account, which can be part of multiple organizations and teams. Your personal account is your identity on Layer5 Cloud and represents you as an individual. 1. Creating an account -To sign up for an account on cloud.layer5.io, navigate to and follow the prompts. +To sign up for an account on Layer5 Cloud, navigate to . You may choose to either signup with your personal email or any of our supported OAuth providers like Github and Gmail. See "OAuth Providers" for more information. -To keep your Layer5 account secure you should use a strong and unique password. For more information, see "Creating a strong password." - 2. Verifying your email address To ensure you can use all the features in your Layer5 plan, verify your email address after signing up for a new account. For more information, see "Verifying your email address." @@ -30,15 +28,27 @@ Two-factor authentication, or 2FA, is an extra layer of security used when loggi Optionally, after you have configured 2FA, add a passkey to your account to enable a secure, passwordless login. For more information, see "About passkeys" and "Managing your passkeys." --> -3. Creating an organization +3. Signing in to Layer5 Cloud + +To sign in to Layer5 Cloud, navigate to . Use your new credentials to sign in. Incase you have signed up with OAuth provider, you will be redirected to the provider's login page. +On successful login, you will be prompted to setup your first organization and workspace. + +4. Creating an organization Organization are unit of tenant in Layer5 Cloud. Every user on Layer5 Cloud is part of at least one organization. You can create your own organization or join an existing one. By default you are the owner of the organization you create. For more information, see "[Organizations](/cloud/identity/organizations/)". +Give your organization a name and a description. For more information, see "Creating an organization." 4. Creating a workspace Workspaces are logical group of shared set of resources like environments, connections, credentials, infrastructural designs and more. Every user on Layer5 Cloud is part of at least one workspace. You can create your own workspace or join an existing one. By default you are the owner of the workspace you create. You can share access to resouces in your workspaces through teams. For more information, see "[Workspaces](/cloud/workspaces/)". -5. Viewing your Layer5 profile +Give your workspace a name and a description. For more information, see "Creating a workspace." + +5. Dashboard + +The dashboard is the first page you see when you sign in to Layer5 Cloud. It provides a high-level overview of your Layer5 account. For more information, see "About your dashboard." + +6. Viewing your Layer5 profile Your Layer5 profile tells people the story of your work through the recent activites, designs that you've published to Cloud catalog. For more information, see "About your profile". From 2bc02f2442851a82cdd40ba4c4fc4a2a0dc1d30e Mon Sep 17 00:00:00 2001 From: Pranav Singh Date: Sun, 29 Oct 2023 23:13:44 +0530 Subject: [PATCH 6/6] update Signed-off-by: Pranav Singh --- .../onboarding/getting-started-with-layer5-account/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md index 38f707e0..32c93802 100644 --- a/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md +++ b/content/en/Cloud/getting-started/onboarding/getting-started-with-layer5-account/_index.md @@ -51,4 +51,4 @@ The dashboard is the first page you see when you sign in to Layer5 Cloud. It pro 6. Viewing your Layer5 profile -Your Layer5 profile tells people the story of your work through the recent activites, designs that you've published to Cloud catalog. For more information, see "About your profile". +Your Layer5 profile tells people the story of your work through the recent activites, designs that you've published to Cloud catalog and much more. For more information, see "About your profile".