diff --git a/content/en/charts/_index.md b/content/en/charts/_index.md index 1ed1a3fbce..3fb1a38bf7 100644 --- a/content/en/charts/_index.md +++ b/content/en/charts/_index.md @@ -12,7 +12,7 @@ cascade: {{< alert type="info" title="Repository Only">}} This page only contains a brief synopsis of the Helm repository. -See the [Self-Hosted section](/cloud/self-hosted/) of the Layer5 Cloud documentation for deployment prerequisites, considerations, and instructions. +See the [Self-Hosted section](/cloud/guides/self-hosted/) of the Layer5 Cloud documentation for deployment prerequisites, considerations, and instructions. {{< /alert >}} ## Repository Contents @@ -24,7 +24,7 @@ Contained in the Layer5 Helm repository is the [Meshery Remote Provider](https:/

The source for this chart is located in the layer5io/meshery-cloud repository under install/kubernetes/.

{{< alert type="info" title="Complete Deployment Instructions">}} -Layer5 Cloud's Helm chart supports a number of [configuration options]({{}}) +Layer5 Cloud's Helm chart supports a number of [configuration options]({{}}) -See the [Self-Hosted section](/cloud/self-hosted/) of the Layer5 Cloud documentation for deployment prerequisites, considerations, and instructions. +See the [Self-Hosted section](/cloud/guides/self-hosted/) of the Layer5 Cloud documentation for deployment prerequisites, considerations, and instructions. {{< /alert >}} diff --git a/content/en/cloud/_index.md b/content/en/cloud/_index.md index 63f7481cfc..4003789717 100755 --- a/content/en/cloud/_index.md +++ b/content/en/cloud/_index.md @@ -72,6 +72,20 @@ cascade: {{% /pageinfo %}} +## What is Layer5 Cloud? + +Layer5 Cloud is the centralized management console and identity provider for the Layer5 ecosystem — specifically for **Kanvas** and **Meshery** deployments. It provides an extensible, highly flexible authorization framework that enables organizations to govern complex, multi-cloud infrastructure with confidence. Think of it as the command center where your teams, workspaces, and cloud-native assets come together under a single, unified platform. + +Layer5 Cloud is available both as a fully managed service and as a [self-hosted](/cloud/guides/self-hosted/) deployment, giving organizations the flexibility to meet their own security and compliance requirements. + +## Why use Layer5 Cloud? + +- **Unified Identity and Access Management**: Define and enforce granular Role-Based Access Control (RBAC) across your organizations, teams, and users — all from one place. +- **Collaborative Infrastructure Design**: Like Google Workspace for teams or Figma for designers, Layer5 Cloud enables real-time, multi-player collaboration on infrastructure patterns and deployments. +- **Content Catalog**: Publish, discover, and reuse cloud-native architectures and patterns — either publicly or privately within your organization. +- **Multi-Tenancy and Organizational Hierarchy**: Support service provider-grade structures with tenant entitlement services and a flexible organizational model that scales with your business. +- **Flexible Deployment**: Run Layer5 Cloud as a SaaS product or bring it on-premises — your infrastructure, your rules. + + -Delivering-catalog-content +Delivering-catalog-content The Cloud Catalog is a web-based, public catalog to facilitate easy discovery of existing designs. Designs that are published into the catalog can be, but are not always curated for known best practices and patterns. Content is published at [cloud.layer5.io/catalog](https://cloud.layer5.io/catalog), and one-click import of catalog content into Meshery Server is seamlessly integrated. diff --git a/content/en/cloud/catalog/exploring-the-catalog.md b/content/en/cloud/concepts/catalog/exploring-the-catalog.md similarity index 91% rename from content/en/cloud/catalog/exploring-the-catalog.md rename to content/en/cloud/concepts/catalog/exploring-the-catalog.md index 87d72beae8..36d6a02edd 100644 --- a/content/en/cloud/catalog/exploring-the-catalog.md +++ b/content/en/cloud/concepts/catalog/exploring-the-catalog.md @@ -4,11 +4,14 @@ weight: 3 description: "Discover how to browse, find, and interact with designs in the Catalog." categories: [Catalog] tags: [Designer] +aliases: + - /cloud/catalog/exploring-the-catalog/ + --- The [Cloud Catalog](https://cloud.layer5.io/catalog) is the central hub for well-architected cloud and cloud native patterns and best practices templates. Here, you can discover and share designs with the wider community. -![Catalog main page view](/cloud/catalog/images/catalog-view.gif) +![Catalog main page view](/cloud/concepts/catalog/images/catalog-view.gif) ## Viewing Catalog Items @@ -16,13 +19,13 @@ Meshery Catalog displays all published designs in an organized, searchable forma ### Top Performers -At the top of the page, you can find the **Top Performers** section. This provides a snapshot of the **Leaderboard**, highlighting the most popular designs based on various [metrics](/cloud/catalog/metrics/). +At the top of the page, you can find the **Top Performers** section. This provides a snapshot of the **Leaderboard**, highlighting the most popular designs based on various [metrics](/cloud/concepts/catalog/metrics/). - To see the complete rankings, click the **Open Leaderboard** button. - You can toggle the visibility of this section using the **Hide Performers** / **Show Performers** button. {{< alert type="info" title="Learn More About Leaderboard" >}} -To learn more about Leaderboard, see the [Leaderboard documentation](/cloud/catalog/leaderboard/). +To learn more about Leaderboard, see the [Leaderboard documentation](/cloud/concepts/catalog/leaderboard/). {{< /alert >}} ### Grid View @@ -36,10 +39,10 @@ Each card provides key information at a glance: - **Metrics:** A row of icons at the bottom displays key usage statistics (Opens, Downloads, Deploys, Clones, Shares) - **Detailed Information (on hover):** When you hover over a card, it flips to reveal more details, including the author, design version, technologies used, and the last updated time -Card View +Card View {{< alert type="info" title="Understanding Design Metrics" >}} -To better understand what these Metrics represent, you can learn more about [design metrics](/cloud/catalog/metrics/). +To better understand what these Metrics represent, you can learn more about [design metrics](/cloud/concepts/catalog/metrics/). {{< /alert >}} ### Table View @@ -48,7 +51,7 @@ Table view provides a dense, list-based format that's ideal for sorting and comp To customize the information displayed in this view, click the **View Columns icon** and select the attributes you want to see, such as Author, Created At, or Downloads. -![Catalog table view](/cloud/catalog/images/design-view.gif) +![Catalog table view](/cloud/concepts/catalog/images/design-view.gif) ## Filtering and Sorting Catalog Items @@ -81,7 +84,7 @@ These filters correspond to the metadata authors provide when they publish desig When you click on any design, you'll see its detail page. This page provides a complete overview of the design's purpose, technical details, and how you can use it. -![Catalog modal](/cloud/catalog/images/design_model.png) +![Catalog modal](/cloud/concepts/catalog/images/design_model.png) ### Key Information @@ -124,7 +127,7 @@ Design downloads include only the core YAML definition, excluding associated cat After you've published a design, you might need to update its metadata or description. Clicking the **Edit** button opens a dialog where you can make your changes. -![Design edit modal](/cloud/catalog/images/design-edit.png) +![Design edit modal](/cloud/concepts/catalog/images/design-edit.png) You can modify the following fields: diff --git a/content/en/cloud/catalog/images/Slide51.svg b/content/en/cloud/concepts/catalog/images/Slide51.svg similarity index 100% rename from content/en/cloud/catalog/images/Slide51.svg rename to content/en/cloud/concepts/catalog/images/Slide51.svg diff --git a/content/en/cloud/catalog/images/card-view.png b/content/en/cloud/concepts/catalog/images/card-view.png similarity index 100% rename from content/en/cloud/catalog/images/card-view.png rename to content/en/cloud/concepts/catalog/images/card-view.png diff --git a/content/en/cloud/catalog/images/cards.png b/content/en/cloud/concepts/catalog/images/cards.png similarity index 100% rename from content/en/cloud/catalog/images/cards.png rename to content/en/cloud/concepts/catalog/images/cards.png diff --git a/content/en/cloud/catalog/images/catalog-view.gif b/content/en/cloud/concepts/catalog/images/catalog-view.gif similarity index 100% rename from content/en/cloud/catalog/images/catalog-view.gif rename to content/en/cloud/concepts/catalog/images/catalog-view.gif diff --git a/content/en/cloud/catalog/images/delivering-catalog-content.svg b/content/en/cloud/concepts/catalog/images/delivering-catalog-content.svg similarity index 100% rename from content/en/cloud/catalog/images/delivering-catalog-content.svg rename to content/en/cloud/concepts/catalog/images/delivering-catalog-content.svg diff --git a/content/en/cloud/catalog/images/design-edit.png b/content/en/cloud/concepts/catalog/images/design-edit.png similarity index 100% rename from content/en/cloud/catalog/images/design-edit.png rename to content/en/cloud/concepts/catalog/images/design-edit.png diff --git a/content/en/cloud/catalog/images/design-view.gif b/content/en/cloud/concepts/catalog/images/design-view.gif similarity index 100% rename from content/en/cloud/catalog/images/design-view.gif rename to content/en/cloud/concepts/catalog/images/design-view.gif diff --git a/content/en/cloud/catalog/images/design_model.png b/content/en/cloud/concepts/catalog/images/design_model.png similarity index 100% rename from content/en/cloud/catalog/images/design_model.png rename to content/en/cloud/concepts/catalog/images/design_model.png diff --git a/content/en/cloud/catalog/images/leaderboard-action.png b/content/en/cloud/concepts/catalog/images/leaderboard-action.png similarity index 100% rename from content/en/cloud/catalog/images/leaderboard-action.png rename to content/en/cloud/concepts/catalog/images/leaderboard-action.png diff --git a/content/en/cloud/catalog/images/leaderboard-page.gif b/content/en/cloud/concepts/catalog/images/leaderboard-page.gif similarity index 100% rename from content/en/cloud/catalog/images/leaderboard-page.gif rename to content/en/cloud/concepts/catalog/images/leaderboard-page.gif diff --git a/content/en/cloud/catalog/images/leaderboard_button.png b/content/en/cloud/concepts/catalog/images/leaderboard_button.png similarity index 100% rename from content/en/cloud/catalog/images/leaderboard_button.png rename to content/en/cloud/concepts/catalog/images/leaderboard_button.png diff --git a/content/en/cloud/catalog/leaderboard.md b/content/en/cloud/concepts/catalog/leaderboard.md similarity index 79% rename from content/en/cloud/catalog/leaderboard.md rename to content/en/cloud/concepts/catalog/leaderboard.md index a922516d62..1c216d61c4 100644 --- a/content/en/cloud/catalog/leaderboard.md +++ b/content/en/cloud/concepts/catalog/leaderboard.md @@ -5,14 +5,17 @@ description: > The Leaderboard is a visual representation of Designs, ranked based on key Metrics such as Opens, Downloads, Deployments, Clones, and Shares. categories: [Catalog] tags: [Designer] +aliases: + - /cloud/catalog/leaderboard/ + --- Leaderboard provides a clear and engaging way to view and compare the performance of different Designs, highlighting the most popular and actively used ones within the Cloud. -![Leaderboard page overview](/cloud/catalog/images/leaderboard-page.gif) +![Leaderboard page overview](/cloud/concepts/catalog/images/leaderboard-page.gif) {{< alert type="info" title="Understanding Metrics" >}} -Metrics are quantifiable measures used to track and assess the status, progress, and performance of various activities and user interactions with Designs. Learn more about [Metrics](/cloud/catalog/metrics/) +Metrics are quantifiable measures used to track and assess the status, progress, and performance of various activities and user interactions with Designs. Learn more about [Metrics](/cloud/concepts/catalog/metrics/) {{< /alert >}} ### How to Access the Leaderboard @@ -22,7 +25,7 @@ You can reach the Leaderboard page in two ways: 1. **Global Navigation Bar:** Click the Leaderboard icon in the main navigation bar for quick access. 2. **From the Catalog Page:** While Browse the Catalog, you can click the 'Open Leaderboard' button in the **Top Performers** section -![Leaderboard Button](/cloud/catalog/images/leaderboard_button.png) +![Leaderboard Button](/cloud/concepts/catalog/images/leaderboard_button.png) ### Using the Leaderboard Page @@ -33,4 +36,4 @@ The Leaderboard page offers several ways to explore and interact with: - **Customize Your View:** Click the **View Columns** icon to show or hide specific metric columns. - **Take Actions:** Click the **Actions** icon to download, share, or perform other actions. -![Leaderboard action menu](/cloud/catalog/images/leaderboard-action.png) +![Leaderboard action menu](/cloud/concepts/catalog/images/leaderboard-action.png) diff --git a/content/en/cloud/catalog/metrics.md b/content/en/cloud/concepts/catalog/metrics.md similarity index 90% rename from content/en/cloud/catalog/metrics.md rename to content/en/cloud/concepts/catalog/metrics.md index 350608d31e..c6cf83d9bd 100644 --- a/content/en/cloud/catalog/metrics.md +++ b/content/en/cloud/concepts/catalog/metrics.md @@ -5,6 +5,9 @@ description: > Metrics are quantifiable measures used to track and assess the status, progress, and performance of various activities and user interactions with Designs. categories: [Catalog] tags: [Designer] +aliases: + - /cloud/catalog/metrics/ + --- Metrics provide valuable insights into how users engage with the designs, allowing us to understand usage patterns, identify trends, and make data-driven decisions to improve the user experience. @@ -19,10 +22,10 @@ Designs can be imported, exported, versioned, forked, merged, snapshotted, publi You can view the metrics of a Design in two ways: 1. Below each Design's catalog card, you can see its metrics. -![Catalog card](/cloud/catalog/images/cards.png) +![Catalog card](/cloud/concepts/catalog/images/cards.png) 2. By clicking on the catalog card, a modal will pop up displaying all the information about the Design, including its metrics. -![Catalog modal](/cloud/catalog/images/design_model.png) +![Catalog modal](/cloud/concepts/catalog/images/design_model.png) Here’s a detailed explanation of each metric we track: diff --git a/content/en/cloud/concepts/identity-and-security/_index.md b/content/en/cloud/concepts/identity-and-security/_index.md new file mode 100755 index 0000000000..25cf3a65c9 --- /dev/null +++ b/content/en/cloud/concepts/identity-and-security/_index.md @@ -0,0 +1,75 @@ +--- +title: Identity and Security +linkTitle: Identity and Security +description: > + Organizations, teams, users, roles, keychains, keys, sessions, and tokens. +weight: 3 +categories: [Identity, Security] +tags: [permissions, identity, authentication] +aliases: + - /cloud/identity/ + - /cloud/security/ + +--- + +Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. The identity structure is highly flexible: organizations can have any number of teams, teams can have any number of users, and users can belong to any number of teams and organizations. + +Below is an overview of the core identity components within the Layer5 Cloud. + +## Identity + +Organizations serve as the fundamental component of multi-tenancy within the Layer5 Cloud. + +They act as the top-level parent entity. All users and teams ultimately roll up to an organization. While Free plan users are limited to a single default organization, enterprise environments can leverage organizations to strictly isolate resources, billing, and access control across entirely different business units. + +Outside of grouping users together, teams offer controlled access to workspaces and to workspace resources such as environments and managed and unmanaged connections. + +Administrators can create teams as child units below the top-level organization. This allows you to apply unique settings, permissions, and workspace access to a specific set of users without altering the parent organization's settings. + +Each user account represents an individual collaborator. Individual user accounts exist beyond the bounds of organizations. + +Anyone who uses Layer5 Cloud signs into a user account, which acts as your sovereign identity. Your user account can independently own resources such as workspaces, designs, connections, and tokens. Any action taken on the platform is directly attributed to your individual user account, regardless of which teams or organizations you belong to. + +## Organizational Units + +Layer5 Cloud uses a hierarchical structure to isolate resources and manage users at scale: + +* **Provider Organizations:** The top-level entity that can manage multiple tenant organizations. +* **Tenant Organizations:** Individual customer or project-specific organizations (e.g., Layer5, Intel). +* **Teams:** Logical groupings of users within an organization to facilitate collaborative management. +* **Users:** Individual accounts that are members of teams and organizations. + +## Role and Access Control + +Access is granted through Role-Based Access Control (RBAC). Roles are assigned at different levels of the organizational hierarchy: + +* **Provider Administrators:** Management of provider-level settings and tenant organizations. +* **Organization Administrators:** Full control over an entire tenant organization. +* **Organization Billing Managers:** Access restricted to subscription and financial management. +* **Team Administrators:** Management of specific team resources and memberships. +* **Workspace Administrators:** Management of workspace-level resources and access. + +![permission](images/permissions.svg "image-center-shadow") + +## Key Management and Tokens + +Beyond structural roles, Layer5 Cloud uses cryptographic and session-based security: + +### Keychains + +Keychains are collections of keys used to manage environment-specific access and signing. They allow for the logical grouping of related security credentials. + +### Keys + +Keys are the atomic unit of access control within the system. They are used for secure communication between Meshery and Layer5 Cloud, as well as for signing design patterns. + +### Tokens + +Tokens provide temporary, secure access to the platform. + +* **Session Tokens:** Used for web browser authentication. +* **Personal Access Tokens (PATs):** Used for programmatic access via CLI or CI/CD pipelines. + +### Need more detail? + +Check out the [Roles Reference](/cloud/concepts/identity-and-security/roles/) for a complete matrix of permissions for each role. diff --git a/content/en/cloud/security/images/academy-admin.svg b/content/en/cloud/concepts/identity-and-security/images/academy-admin.svg similarity index 100% rename from content/en/cloud/security/images/academy-admin.svg rename to content/en/cloud/concepts/identity-and-security/images/academy-admin.svg diff --git a/content/en/cloud/security/images/learner.svg b/content/en/cloud/concepts/identity-and-security/images/learner.svg similarity index 100% rename from content/en/cloud/security/images/learner.svg rename to content/en/cloud/concepts/identity-and-security/images/learner.svg diff --git a/content/en/cloud/security/images/organization-roles.svg b/content/en/cloud/concepts/identity-and-security/images/organization-roles.svg similarity index 100% rename from content/en/cloud/security/images/organization-roles.svg rename to content/en/cloud/concepts/identity-and-security/images/organization-roles.svg diff --git a/content/en/cloud/identity/images/organization_units.svg b/content/en/cloud/concepts/identity-and-security/images/organization_units.svg similarity index 100% rename from content/en/cloud/identity/images/organization_units.svg rename to content/en/cloud/concepts/identity-and-security/images/organization_units.svg diff --git a/content/en/cloud/security/images/permissions.svg b/content/en/cloud/concepts/identity-and-security/images/permissions.svg similarity index 100% rename from content/en/cloud/security/images/permissions.svg rename to content/en/cloud/concepts/identity-and-security/images/permissions.svg diff --git a/content/en/cloud/security/images/role-provider-admin.svg b/content/en/cloud/concepts/identity-and-security/images/role-provider-admin.svg similarity index 100% rename from content/en/cloud/security/images/role-provider-admin.svg rename to content/en/cloud/concepts/identity-and-security/images/role-provider-admin.svg diff --git a/content/en/cloud/security/images/roles-overview.svg b/content/en/cloud/concepts/identity-and-security/images/roles-overview.svg similarity index 100% rename from content/en/cloud/security/images/roles-overview.svg rename to content/en/cloud/concepts/identity-and-security/images/roles-overview.svg diff --git a/content/en/cloud/security/images/team-roles.svg b/content/en/cloud/concepts/identity-and-security/images/team-roles.svg similarity index 100% rename from content/en/cloud/security/images/team-roles.svg rename to content/en/cloud/concepts/identity-and-security/images/team-roles.svg diff --git a/content/en/cloud/security/images/user-role.svg b/content/en/cloud/concepts/identity-and-security/images/user-role.svg similarity index 100% rename from content/en/cloud/security/images/user-role.svg rename to content/en/cloud/concepts/identity-and-security/images/user-role.svg diff --git a/content/en/cloud/security/images/workspace-roles.svg b/content/en/cloud/concepts/identity-and-security/images/workspace-roles.svg similarity index 100% rename from content/en/cloud/security/images/workspace-roles.svg rename to content/en/cloud/concepts/identity-and-security/images/workspace-roles.svg diff --git a/content/en/cloud/security/keychains.md b/content/en/cloud/concepts/identity-and-security/keychains.md similarity index 94% rename from content/en/cloud/security/keychains.md rename to content/en/cloud/concepts/identity-and-security/keychains.md index 093cfd1249..d599879028 100644 --- a/content/en/cloud/security/keychains.md +++ b/content/en/cloud/concepts/identity-and-security/keychains.md @@ -1,12 +1,15 @@ --- title: Keychains description: Keychains are a collection of keys -weight: 2 +weight: 5 categories: [Security] tags: [keychains, permissions] +aliases: + - /cloud/security/keychains/ + --- -In Layer5 Cloud, a collection of permissions is represented as a keychain. One or more keychains can are grouped together and assigned to a [role](/cloud/security/roles). Later, a role can be assigned to a user. This is the general flow of how keychains are assigned to a user. +In Layer5 Cloud, a collection of permissions is represented as a keychain. One or more keychains can are grouped together and assigned to a [role](/cloud/concepts/identity-and-security/roles). Later, a role can be assigned to a user. This is the general flow of how keychains are assigned to a user. For instance, consider a system shipped default keychain `Team Management`, which is a collection of eight keys: `View All Teams`, `Add User to Team`, `Invite User to Team`, `Remove User from Team`, `Create Team`, `Delete Team`, `Remove User Role from Team`, and `Assign User Role in a Team`. This implies that you can perform all these operations only if your user account possesses a role to which `Team Management` keychain is assigned in a given organization. @@ -64,9 +67,9 @@ If you don't have permission to view keychains for your selected organization, y 1. Select the organization for which you wish to assign keychains to users. You can do this by selecting the organization from the organization context switcher in the top navigation bar. 2. Navigate to the [Roles](https://cloud.layer5.io/security/roles) page. -3. Choose from the existing set of roles or create a new role to which you want to assign the keychain. For more information, see [Roles](/cloud/security/roles). +3. Choose from the existing set of roles or create a new role to which you want to assign the keychain. For more information, see [Roles](/cloud/concepts/identity-and-security/roles). 4. Navigate to [Users](https://cloud.layer5.io/identity/users) page. -5. Select the user to whom you want to assign the role with a new set of permissions. Alternatively, you can invite a new user and assign the role with the new set of permissions separately. For more information, see [Users](/cloud/identity/users). +5. Select the user to whom you want to assign the role with a new set of permissions. Alternatively, you can invite a new user and assign the role with the new set of permissions separately. For more information, see [Users](/cloud/concepts/identity-and-security/users). {{< alert title="Note" >}} @@ -94,4 +97,4 @@ It is recommended not to alter the existing default keychains unless you intend If you wish to change the permission for a specific organization, consider creating a new keychain and assigning it to a role. Then assign the role to the users of that organization. -{{< /alert >}} \ No newline at end of file +{{< /alert >}} diff --git a/content/en/cloud/security/keys.md b/content/en/cloud/concepts/identity-and-security/keys.md similarity index 87% rename from content/en/cloud/security/keys.md rename to content/en/cloud/concepts/identity-and-security/keys.md index e3eeaf5c92..d26783f03c 100644 --- a/content/en/cloud/security/keys.md +++ b/content/en/cloud/concepts/identity-and-security/keys.md @@ -1,12 +1,15 @@ --- title: Keys description: Keys are the atomic unit of access control -weight: 2 +weight: 6 categories: [Security] tags: [keys, permissions] +aliases: + - /cloud/security/keys/ + --- -In Layer5 Cloud, permissions are represented as keys, each serving as a unique identifier for a specific permission. One or more keys can be grouped together and assigned to a [keychain](/cloud/security/keychains). Then this keychain can be assigned to a [role](/cloud/security/roles) and that role can be assigned to a user. This is the general flow of how keys are assigned to a user. +In Layer5 Cloud, permissions are represented as keys, each serving as a unique identifier for a specific permission. One or more keys can be grouped together and assigned to a [keychain](/cloud/concepts/identity-and-security/keychains). Then this keychain can be assigned to a [role](/cloud/concepts/identity-and-security/roles) and that role can be assigned to a user. This is the general flow of how keys are assigned to a user. For instance, consider a system shipped default key `Create Organization`, which corresponds to the permission to create an organization in the Cloud. This implies that to create an organization, you need to have `Create Organization` key assigned to a keychain, which, in turn, is assigned to a role that's associated with your user account for a given organization. @@ -27,13 +30,13 @@ Generally, there are four types of keys: 3. **Update** - Update keys permit you to update resources. For instance, `Update Organization` key allows you to update an organization details. 4. **Delete** - Delete keys permit you to delete resources. For instance, `Delete Organization` key allows you to delete an organization. -There are also some special types of keys which don't fall into the standard CRUD (CREATE, READ, UPDATE, DELETE) category. For example, the `Approve Catalog Request` key allows you to approve a catalog request to publish a cloud native design to [Cloud Catalog](/cloud/catalog) or `Connect Github Account to Workspace` key enables you to connect your GitHub Account to your [workspace](/cloud/workspaces) in context of any organization. +There are also some special types of keys which don't fall into the standard CRUD (CREATE, READ, UPDATE, DELETE) category. For example, the `Approve Catalog Request` key allows you to approve a catalog request to publish a cloud native design to [Cloud Catalog](/cloud/concepts/catalog) or `Connect Github Account to Workspace` key enables you to connect your GitHub Account to your [workspace](/cloud/concepts/spaces/workspaces) in context of any organization. ### Keys Enforcement The primary purpose of key enforcement is to ensure that you can only perform actions for which you have the necessary permissions within the context of your selected/available organization. This is achieved by disabling or hiding the UI elements associated with actions for which you lack the required permissions. This approach not only provides clarity regarding what actions you are authorized to perform but also prevents you from attempting actions that you do not have authorization to execute. -For more information on managing permissions within an organization and use of organization context switcher, see [Organizations](/cloud/identity/organizations). +For more information on managing permissions within an organization and use of organization context switcher, see [Organizations](/cloud/concepts/identity-and-security/organizations). Each key is enforced at specific UI elements. For instance, the `Create Organization` key is enforced at the **Create Organization** button in the **Organizations** page. This implies that the button is disabled if you don't have the `Create Organization` assigned to a keychain, which, in turn, is assigned to a role that's associated with your user account for a given organization. @@ -54,12 +57,12 @@ If you don't have permission to view keys for your selected organization, you wi 1. Select the organization for which you wish to assign keys to users. You can do this by selecting the organization from the organization context switcher in the top navigation bar. 2. Navigate to [Keychains](https://cloud.layer5.io/security/keychains) page. -3. Choose from the existing set of keychains or create a new keychain to which you want to assign keys. For more information, see [Keychains](/cloud/security/keychains). +3. Choose from the existing set of keychains or create a new keychain to which you want to assign keys. For more information, see [Keychains](/cloud/concepts/identity-and-security/keychains). 4. Choose one more of your desired keys from the list of available keys. 5. Navigate to the [Roles](https://cloud.layer5.io/security/roles) page. -6. Choose from the existing set of roles or create a new role to which you want to assign the keychain. For more information, see [Roles](/cloud/security/roles). +6. Choose from the existing set of roles or create a new role to which you want to assign the keychain. For more information, see [Roles](/cloud/concepts/identity-and-security/roles). 7. Navigate to [Users](https://cloud.layer5.io/identity/users) page. -8. Select the user to whom you want to assign the role with a new set of permissions. Alternatively, you can invite a new user and assign the role with the new set of permissions separately. For more information, see [Users](/cloud/identity/users). +8. Select the user to whom you want to assign the role with a new set of permissions. Alternatively, you can invite a new user and assign the role with the new set of permissions separately. For more information, see [Users](/cloud/concepts/identity-and-security/users). {{< alert title="Note" >}} @@ -78,4 +81,3 @@ If you don't have permission to perform any of the above operations, consider sw ### Keys Lifecycle Layer5 Cloud ships with 103 default keys, each designed to enforce permissions across the platform. All the keys shipped with the system are immutable and cannot be deleted or modified. Each key is uniquely identified in the form of a UUID. The UUID is used to reference the key in the system. - diff --git a/content/en/cloud/identity/organizations/_index.md b/content/en/cloud/concepts/identity-and-security/organizations/_index.md similarity index 86% rename from content/en/cloud/identity/organizations/_index.md rename to content/en/cloud/concepts/identity-and-security/organizations/_index.md index 9e52df3d95..d26798abac 100755 --- a/content/en/cloud/identity/organizations/_index.md +++ b/content/en/cloud/concepts/identity-and-security/organizations/_index.md @@ -2,19 +2,23 @@ title: Organizations description: > Organizations serve as the fundamental component of multi-tenancy within the Layer5 Cloud. +weight: 1 categories: [Identity] tags: [orgs] +aliases: + - /cloud/identity/organizations/ + --- Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. Organizations can have any number of teams. Teams can have any number of users. Users can belong to any number of teams. Users may belong to any number of organizations. Outside of grouping users together, teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections -Organizational units +Organizational units ## Example: The Orbital Labs Ecosystem -The following organizations illustrate how multi-tenancy works across provider, startup, and enterprise tiers. Follow along in the rest of the docs using [Five and the cast at Orbital Labs](/cloud/about). +The following organizations illustrate how multi-tenancy works across provider, startup, and enterprise tiers. Follow along in the rest of the docs using [Five and the cast at Orbital Labs](/cloud/getting-started/meet-five). {{< cardpane >}} {{% card header="**Constellation Cloud** — Provider" %}} @@ -51,5 +55,5 @@ Stellar Dynamics is a separate tenant of Constellation Cloud and an enterprise c Users of one organization may be granted access to resources (workspaces, designs) in another organization. Entitlements are org-scoped: the permissions a user has in Orbital Labs do not automatically apply in Stellar Dynamics, and vice versa. {{< alert type="info" >}} -See [Meet Five and the Cast](/cloud/about) for the full narrative reference, including team structure and workspace inventory. -{{< /alert >}} \ No newline at end of file +See [Meet Five and the Cast](/cloud/getting-started/meet-five) for the full narrative reference, including team structure and workspace inventory. +{{< /alert >}} diff --git a/content/en/cloud/security/roles/_index.md b/content/en/cloud/concepts/identity-and-security/roles/_index.md similarity index 91% rename from content/en/cloud/security/roles/_index.md rename to content/en/cloud/concepts/identity-and-security/roles/_index.md index d6e355b4f7..6fc8cbe1b4 100644 --- a/content/en/cloud/security/roles/_index.md +++ b/content/en/cloud/concepts/identity-and-security/roles/_index.md @@ -2,20 +2,23 @@ title: Roles description: > Roles map permissions to users. Roles contain any number of keychains, which contain any number of keys (permissions). Assign roles to users to grant permissions. -weight: 2 +weight: 4 categories: [Security] tags: [roles, permissions] +aliases: + - /cloud/security/roles/ + --- Roles map permissions to users. Roles contain any number of keychains, which contain any number of keys (permissions). Assign roles to users to grant permissions. -![roles](/cloud/security/images/roles-overview.svg "image-center-no-shadow") +![roles](/cloud/concepts/identity-and-security/images/roles-overview.svg "image-center-no-shadow") ## Provider Admin Role {{< cardpane >}} {{% card header="Provider Admin Role" %}} -![role-provider](/cloud/security/images/role-provider-admin.svg) +![role-provider](/cloud/concepts/identity-and-security/images/role-provider-admin.svg) {{% /card %}} {{% card %}} @@ -52,7 +55,7 @@ Roles map permissions to users. Roles contain any number of keychains, which con {{< cardpane >}} {{% card %}} -![organization-administrator and manager](/cloud/security/images/organization-roles.svg) +![organization-administrator and manager](/cloud/concepts/identity-and-security/images/organization-roles.svg) {{% /card %}} {{< /cardpane >}} @@ -113,14 +116,14 @@ Organization owners carry the organization administrator role, and may be joined The entitlement of "organization owner" is automatically bestowed to the creator of a organization. The individual user who created a given organization initially is therefore granted certain administrative privileges beyond that of other organization administrators. Specifically, organization owners retain the sole permission to delete the organization. -For more information, see [Organization](/cloud/identity/organizations). +For more information, see [Organization](/cloud/concepts/identity-and-security/organizations). {{< /alert >}} ## Workspace Roles {{< cardpane >}} {{% card %}} -![workspace-administrator](/cloud/security/images/workspace-roles.svg) +![workspace-administrator](/cloud/concepts/identity-and-security/images/workspace-roles.svg) {{% /card %}} {{< /cardpane >}} @@ -163,7 +166,7 @@ The entitlement of "workspace owner" is automatically bestowed to the creator of {{< cardpane >}} {{% card %}} -![team-admins-and-manager](/cloud/security/images/team-roles.svg) +![team-admins-and-manager](/cloud/concepts/identity-and-security/images/team-roles.svg) {{% /card %}} {{< /cardpane >}} @@ -212,12 +215,12 @@ Team owners carry the team administrator role, and may be joined in their team a The entitlement of "team owner" is automatically bestowed to the creator of a team. The individual user who created a given team initially is therefore granted certain administrative privileges beyond that of other team administrators. Specifically, team owners retain the sole permission to delete the team. -For more information, see [Teams](/cloud/identity/teams). +For more information, see [Teams](/cloud/concepts/identity-and-security/teams). {{< /alert >}} ## Example: The Orbital Labs Role Hierarchy -The following illustrates how Provider Admin, Org Admin, and Team Admin roles stack in practice across the Orbital Labs ecosystem. See [Meet Five and the Cast](/cloud/about) for the full narrative. +The following illustrates how Provider Admin, Org Admin, and Team Admin roles stack in practice across the Orbital Labs ecosystem. See [Meet Five and the Cast](/cloud/getting-started/meet-five) for the full narrative. Five means business @@ -245,4 +248,4 @@ Zara Osei holds the Team Admin role for Orbital Labs' Infrastructure team. She m {{< alert type="info" >}} Role assignments are org-scoped. Dr. Aiko's Provider Admin role spans all tenants; Maya's Org Admin role applies only within Orbital Labs; Zara's Team Admin role applies only to the Infrastructure team within Orbital Labs. -{{< /alert >}} \ No newline at end of file +{{< /alert >}} diff --git a/content/en/cloud/security/roles/academy-roles.md b/content/en/cloud/concepts/identity-and-security/roles/academy-roles.md similarity index 87% rename from content/en/cloud/security/roles/academy-roles.md rename to content/en/cloud/concepts/identity-and-security/roles/academy-roles.md index 04e997d210..af1ed9e3ea 100644 --- a/content/en/cloud/security/roles/academy-roles.md +++ b/content/en/cloud/concepts/identity-and-security/roles/academy-roles.md @@ -5,11 +5,14 @@ description: > weight: 4 categories: [Security] tags: [academy, roles] +aliases: + - /cloud/security/roles/academy-roles/ + --- {{< cardpane >}} {{% card header="Academy Administrator" %}} -Academy Administrator Roles +Academy Administrator Roles {{% /card %}} {{< /cardpane >}} @@ -47,7 +50,7 @@ tags: [academy, roles] {{< cardpane >}} {{% card header="Learner" %}} Learner = A [User](../roles/user-role.md) who has registered for academy content. -Learner Roles +Learner Roles {{% /card %}} {{< /cardpane >}} @@ -97,4 +100,4 @@ Each individual academy content item (learning path, certification, or challenge | withdrawn | They left the course | {{% /card %}} -{{< /cardpane >}} \ No newline at end of file +{{< /cardpane >}} diff --git a/content/en/cloud/security/roles/organization-roles.md b/content/en/cloud/concepts/identity-and-security/roles/organization-roles.md similarity index 88% rename from content/en/cloud/security/roles/organization-roles.md rename to content/en/cloud/concepts/identity-and-security/roles/organization-roles.md index 03177f697a..13f9a2d028 100644 --- a/content/en/cloud/security/roles/organization-roles.md +++ b/content/en/cloud/concepts/identity-and-security/roles/organization-roles.md @@ -5,11 +5,14 @@ description: > weight: 2 categories: [Security] tags: [orgs, roles] +aliases: + - /cloud/security/roles/organization-roles/ + --- {{< cardpane >}} {{% card header="Default Organization Roles" %}} -Organization Roles +Organization Roles {{% /card %}} {{< /cardpane >}} diff --git a/content/en/cloud/security/roles/provider-admin-roles.md b/content/en/cloud/concepts/identity-and-security/roles/provider-admin-roles.md similarity index 85% rename from content/en/cloud/security/roles/provider-admin-roles.md rename to content/en/cloud/concepts/identity-and-security/roles/provider-admin-roles.md index 1c3e0e96f0..3fa0126d02 100644 --- a/content/en/cloud/security/roles/provider-admin-roles.md +++ b/content/en/cloud/concepts/identity-and-security/roles/provider-admin-roles.md @@ -6,11 +6,14 @@ weight: 1 categories: [Security] tags: [permissions] draft: true +aliases: + - /cloud/security/roles/provider-admin-roles/ + --- {{< cardpane >}} {{% card %}} - + {{% /card %}} {{% card header="## Provider Administrator" %}} diff --git a/content/en/cloud/security/roles/team-roles.md b/content/en/cloud/concepts/identity-and-security/roles/team-roles.md similarity index 83% rename from content/en/cloud/security/roles/team-roles.md rename to content/en/cloud/concepts/identity-and-security/roles/team-roles.md index e61b280b74..51ded8f84d 100644 --- a/content/en/cloud/security/roles/team-roles.md +++ b/content/en/cloud/concepts/identity-and-security/roles/team-roles.md @@ -5,11 +5,14 @@ description: > weight: 3 categories: [Security] tags: [teams, roles] +aliases: + - /cloud/security/roles/team-roles/ + --- {{< cardpane >}} {{% card header="Default Team Roles" %}} -Team Roles +Team Roles {{% /card %}} {{< /cardpane >}} diff --git a/content/en/cloud/security/roles/user-role.md b/content/en/cloud/concepts/identity-and-security/roles/user-role.md similarity index 84% rename from content/en/cloud/security/roles/user-role.md rename to content/en/cloud/concepts/identity-and-security/roles/user-role.md index 6ddad1f936..b13c9fe489 100644 --- a/content/en/cloud/security/roles/user-role.md +++ b/content/en/cloud/concepts/identity-and-security/roles/user-role.md @@ -5,11 +5,14 @@ description: > weight: 3 categories: [Security] tags: [user, roles] +aliases: + - /cloud/security/roles/user-role/ + --- {{< cardpane >}} {{% card header="Default User Role" %}} -User Role +User Role {{% /card %}} {{< /cardpane >}} diff --git a/content/en/cloud/security/roles/workspace-roles.md b/content/en/cloud/concepts/identity-and-security/roles/workspace-roles.md similarity index 84% rename from content/en/cloud/security/roles/workspace-roles.md rename to content/en/cloud/concepts/identity-and-security/roles/workspace-roles.md index 49354c46ec..b3cf3b6438 100644 --- a/content/en/cloud/security/roles/workspace-roles.md +++ b/content/en/cloud/concepts/identity-and-security/roles/workspace-roles.md @@ -5,11 +5,14 @@ description: > weight: 2 categories: [Security] tags: [workspaces, roles] +aliases: + - /cloud/security/roles/workspace-roles/ + --- {{< cardpane >}} {{% card %}} -Workspace Roles +Workspace Roles {{% /card %}} {{< /cardpane >}} diff --git a/content/en/cloud/security/sessions.md b/content/en/cloud/concepts/identity-and-security/sessions.md similarity index 98% rename from content/en/cloud/security/sessions.md rename to content/en/cloud/concepts/identity-and-security/sessions.md index b66377e19d..92072705cc 100644 --- a/content/en/cloud/security/sessions.md +++ b/content/en/cloud/concepts/identity-and-security/sessions.md @@ -2,9 +2,12 @@ title: Sessions description: > User sessions are created each time a user successfully authenticates. -weight: 3 +weight: 7 categories: [Security] tags: [sessions, permissions] +aliases: + - /cloud/security/sessions/ + --- ## What sessions are diff --git a/content/en/cloud/identity/teams/_index.md b/content/en/cloud/concepts/identity-and-security/teams/_index.md similarity index 84% rename from content/en/cloud/identity/teams/_index.md rename to content/en/cloud/concepts/identity-and-security/teams/_index.md index b40e006c27..3b63e77a2e 100755 --- a/content/en/cloud/identity/teams/_index.md +++ b/content/en/cloud/concepts/identity-and-security/teams/_index.md @@ -2,8 +2,12 @@ title: Teams description: > Outside of grouping users together, teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections. +weight: 2 categories: [Identity] tags: [teams] +aliases: + - /cloud/identity/teams/ + --- Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. Organizations can have any number of teams. Teams can have any number of users. Users can belong to any number of teams. Users may belong to any number of organizations. @@ -12,21 +16,21 @@ Outside of grouping users together, teams offer control access to workspaces and ## Example: Orbital Labs Teams -The following teams illustrate how organizations use teams to segment access and responsibilities. Follow the full story at [Meet Five and the Cast](/cloud/about). +The following teams illustrate how organizations use teams to segment access and responsibilities. Follow the full story at [Meet Five and the Cast](/cloud/getting-started/meet-five). Team of Fives {{< cardpane >}} {{% card header="**Infrastructure Team**" %}} -**Organization:** Orbital Labs -**Team Admin:** Zara Osei +**Organization:** Orbital Labs +**Team Admin:** Zara Osei **Members:** Five Controls access to production and staging workspaces (`orbital-production`, `orbital-staging`). Zara manages the keychain permission matrix and approves environment assignments. Five handles day-to-day platform operations and occasionally discovers undocumented feature behavior. {{% /card %}} {{% card header="**Development Team**" %}} -**Organization:** Orbital Labs -**Team Admin:** Maya Chen *(also Org Admin)* +**Organization:** Orbital Labs +**Team Admin:** Maya Chen *(also Org Admin)* **Members:** Rex Park, Jordan Reyes Controls access to the development workspace (`orbital-dev`). Rex deploys often; Jordan designs infrastructure that is architecturally ambitious. Maya ensures neither of them touches production on a Friday afternoon. @@ -34,7 +38,7 @@ Controls access to the development workspace (`orbital-dev`). Rex deploys often; {{< /cardpane >}} {{< alert type="info" >}} -An Org Admin may also serve as a Team Admin — Maya Chen holds both roles at Orbital Labs. See [Roles](/cloud/security/roles/) for more on how role assignments stack. +An Org Admin may also serve as a Team Admin — Maya Chen holds both roles at Orbital Labs. See [Roles](/cloud/concepts/identity-and-security/roles/) for more on how role assignments stack. {{< /alert >}} ## Add a Team @@ -45,7 +49,7 @@ A team is simply a group that an administrator can create in the Google Admin co Below the top-level organization, you can add as many teams as you want - at the same level. Hierarchal teams are not currently supported. When you change a setting at the higher level organization, the settings for all child teams that inherit that setting also change. Custom settings at the team level, however, remain unchanged. ->Learn more about the [organizational structure](/cloud/identity). +>Learn more about the [organizational structure](/cloud/concepts/identity-and-security). {{< alert type="info" title="Team Ownership">}} If you are the current team owner, you can’t remove yourself from the team until you transfer ownership to another team administrator. @@ -53,9 +57,9 @@ If you are the current team owner, you can’t remove yourself from the team unt ## Open Team Invite -The "Open Team Invite" feature allows administrators to use shareable "Team Invite Links" for users to join a particular team. This link-based invitation method functions much like an [Open Org Invite Link](https://docs.layer5.io/cloud/identity/organizations/org-management/), but is tailored for team-specific invitations and provides a direct alternative to adding members manually. +The "Open Team Invite" feature allows administrators to use shareable "Team Invite Links" for users to join a particular team. This link-based invitation method functions much like an [Open Org Invite Link](https://docs.layer5.io/cloud/guides/organizations/org-management/), but is tailored for team-specific invitations and provides a direct alternative to adding members manually. -![Process of open team invite](/cloud/identity/teams/open_team_invite.gif) +![Process of open team invite](/cloud/concepts/identity-and-security/teams/open_team_invite.gif) ### When to Use @@ -64,7 +68,7 @@ The "Open Team Invite" feature allows administrators to use shareable "Team Invi - **Structured Self-Service Enrollment:** Supports efficient, self-service team setup for urgent initiatives (e.g., agile sprints, training cohorts). {{< alert type="info" title="For Organization-Specific Invitations">}} -If your goal is to invite users only to a specific organization (and not directly to a team as part of the same invitation), please refer to the documentation on [Open Org Invite Link and User Management](https://docs.layer5.io/cloud/identity/organizations/org-management/). +If your goal is to invite users only to a specific organization (and not directly to a team as part of the same invitation), please refer to the documentation on [Open Org Invite Link and User Management](https://docs.layer5.io/cloud/guides/organizations/org-management/). {{< /alert >}} ### How it Works @@ -76,4 +80,4 @@ If your goal is to invite users only to a specific organization (and not directl * **If the user is already in the organization (and has an account):** Upon using the link, they are added to the specific team. 3. **Manual Alternative:** As an alternative, administrators can always manually add existing organization members to a team. -[^1]: If the direct way to copy this link isn't fully visible or working correctly in the current version, this is a known issue that we plan to fix in an upcoming update. \ No newline at end of file +[^1]: If the direct way to copy this link isn't fully visible or working correctly in the current version, this is a known issue that we plan to fix in an upcoming update. diff --git a/content/en/cloud/identity/teams/open_team_invite.gif b/content/en/cloud/concepts/identity-and-security/teams/open_team_invite.gif similarity index 100% rename from content/en/cloud/identity/teams/open_team_invite.gif rename to content/en/cloud/concepts/identity-and-security/teams/open_team_invite.gif diff --git a/content/en/cloud/security/tokens.md b/content/en/cloud/concepts/identity-and-security/tokens.md similarity index 98% rename from content/en/cloud/security/tokens.md rename to content/en/cloud/concepts/identity-and-security/tokens.md index da300a27b3..12df225221 100644 --- a/content/en/cloud/security/tokens.md +++ b/content/en/cloud/concepts/identity-and-security/tokens.md @@ -2,7 +2,10 @@ title: Tokens description: > API Tokens are used to authenticate to Layer5 Cloud's REST API. Generated on your user account's security tokens page. Tokens can be revoked at any time. -weight: 3 +weight: 8 +aliases: + - /cloud/security/tokens/ + --- ## What tokens are diff --git a/content/en/cloud/identity/users/Slide41.svg b/content/en/cloud/concepts/identity-and-security/users/Slide41.svg similarity index 100% rename from content/en/cloud/identity/users/Slide41.svg rename to content/en/cloud/concepts/identity-and-security/users/Slide41.svg diff --git a/content/en/cloud/identity/users/_index.md b/content/en/cloud/concepts/identity-and-security/users/_index.md similarity index 94% rename from content/en/cloud/identity/users/_index.md rename to content/en/cloud/concepts/identity-and-security/users/_index.md index 1972d6b261..fc459179b5 100755 --- a/content/en/cloud/identity/users/_index.md +++ b/content/en/cloud/concepts/identity-and-security/users/_index.md @@ -2,8 +2,12 @@ title: Users description: > Each user account represents an individual collaborator. Individual user accounts exist beyond the bounds of organizations. +weight: 3 categories: [Identity] tags: [users] +aliases: + - /cloud/identity/users/ + --- ## User Accounts @@ -20,7 +24,7 @@ Anyone who uses Layer5 Cloud signs into a user account. Your user account is you Curious, enthusiastic, and reliably the first to discover that a feature works differently than the docs say it does. -[See full cast →](/cloud/about) +[See full cast →](/cloud/getting-started/meet-five) {{% /card %}} {{% card header="**Maya Chen** — Org Admin" %}} Maya Chen @@ -31,7 +35,7 @@ Curious, enthusiastic, and reliably the first to discover that a feature works d Voice of reason. Has a calendar block called "Preventing Five from touching prod" that recurs every Friday at 4:45 PM. -[See full cast →](/cloud/about) +[See full cast →](/cloud/getting-started/meet-five) {{% /card %}} {{< /cardpane >}} @@ -48,7 +52,7 @@ For more information, see [Layer5 subscription plans](https://layer5.io/pricing) Teams allow you to organize users into groups and conveniently assign access to workspaces or to assign roles with associated keychains and keys to control permissions. {{< alert type="info" >}} -You need to have the default `Team Admin` role to assign permissions to users in your team. For more information, see [Teams](/cloud/identity/teams). +You need to have the default `Team Admin` role to assign permissions to users in your team. For more information, see [Teams](/cloud/concepts/identity-and-security/teams). {{< /alert >}} Organizations may have any number of teams and teams may have any number of users. User accounts are treated as sovereign entities that are owned by individual individuals, not by corporations. @@ -58,7 +62,7 @@ Organization and teams may have any number of users accounts. User accounts are Users and their tokens may be authorized to access resources. Users can be created and managed by the Provider Admins, Organization Admins, or Team Admins. Users of one organization may be granted access to resources (e.g. Workspaces and Designs) of another organization. User entitlement, roles and permissions are org-scoped, meaning that the entitlements and permissions that a given user has in one organization does not necessarily reflect the same level of access that their membership in another oganziation does. {{< alert type="info" >}} -Only Provider Admins and Organization Admin can create users. For more information, see [Roles](/cloud/security/roles/). +Only Provider Admins and Organization Admin can create users. For more information, see [Roles](/cloud/concepts/identity-and-security/roles/). {{< /alert >}} ## Account Linking @@ -93,7 +97,7 @@ When a user deletes their account, the following behaviors apply: **3. Organization Ownership** -- If you are the [only Org Admin or Owner](https://docs.layer5.io/cloud/security/roles/), the organization may become **unmanageable** after you delete your account. +- If you are the [only Org Admin or Owner](https://docs.layer5.io/cloud/concepts/identity-and-security/roles/), the organization may become **unmanageable** after you delete your account. - It is strongly recommended to assign multiple admins before deletion. **4. Organization Deletion** @@ -126,4 +130,3 @@ While account deletion is permanent for end-users, future versions of Layer5 Clo - Support for recovering accounts or restoring deleted data {{< /alert >}} - diff --git a/content/en/cloud/identity/users/add-user.gif b/content/en/cloud/concepts/identity-and-security/users/add-user.gif similarity index 100% rename from content/en/cloud/identity/users/add-user.gif rename to content/en/cloud/concepts/identity-and-security/users/add-user.gif diff --git a/content/en/cloud/identity/users/create-user.gif b/content/en/cloud/concepts/identity-and-security/users/create-user.gif similarity index 100% rename from content/en/cloud/identity/users/create-user.gif rename to content/en/cloud/concepts/identity-and-security/users/create-user.gif diff --git a/content/en/cloud/identity/users/default-permissions.md b/content/en/cloud/concepts/identity-and-security/users/default-permissions.md similarity index 90% rename from content/en/cloud/identity/users/default-permissions.md rename to content/en/cloud/concepts/identity-and-security/users/default-permissions.md index af895cb044..67b6995511 100644 --- a/content/en/cloud/identity/users/default-permissions.md +++ b/content/en/cloud/concepts/identity-and-security/users/default-permissions.md @@ -5,6 +5,9 @@ description: > weight: 5 categories: [Identity] tags: [users] +aliases: + - /cloud/identity/users/default-permissions/ + --- | Permissions | User | @@ -29,4 +32,4 @@ tags: [users] {{< alert title="*Organization Owner" type="warning" >}} _Permissions marked with * apply only if you are the owner of the organization._{{< /alert >}} -{{< alert title="Customizable Permissions" type="info" >}}Default permissions can be easily customized by simply creating your own [keychains](/cloud/security/keychains/) and [roles](/cloud/security/roles).{{< /alert >}} +{{< alert title="Customizable Permissions" type="info" >}}Default permissions can be easily customized by simply creating your own [keychains](/cloud/concepts/identity-and-security/keychains/) and [roles](/cloud/concepts/identity-and-security/roles).{{< /alert >}} diff --git a/content/en/cloud/identity/users/notification-preferences.gif b/content/en/cloud/concepts/identity-and-security/users/notification-preferences.gif similarity index 100% rename from content/en/cloud/identity/users/notification-preferences.gif rename to content/en/cloud/concepts/identity-and-security/users/notification-preferences.gif diff --git a/content/en/cloud/identity/users/notification-preferences.md b/content/en/cloud/concepts/identity-and-security/users/notification-preferences.md similarity index 91% rename from content/en/cloud/identity/users/notification-preferences.md rename to content/en/cloud/concepts/identity-and-security/users/notification-preferences.md index f79989fd53..8e1d45a53b 100644 --- a/content/en/cloud/identity/users/notification-preferences.md +++ b/content/en/cloud/concepts/identity-and-security/users/notification-preferences.md @@ -4,11 +4,14 @@ description: Manage your notifications on Layer5 Cloud weight: 20 categories: [Identity] tags: [users] +aliases: + - /cloud/identity/users/notification-preferences/ + --- Layer5 Cloud offers a range of user-configurable preferences that allows you to control the types of email notifications you receive. -How to set your notifications preferences +How to set your notifications preferences ## To change the notification preferences diff --git a/content/en/cloud/identity/users/org_invite.png b/content/en/cloud/concepts/identity-and-security/users/org_invite.png similarity index 100% rename from content/en/cloud/identity/users/org_invite.png rename to content/en/cloud/concepts/identity-and-security/users/org_invite.png diff --git a/content/en/cloud/identity/users/remove_user.png b/content/en/cloud/concepts/identity-and-security/users/remove_user.png similarity index 100% rename from content/en/cloud/identity/users/remove_user.png rename to content/en/cloud/concepts/identity-and-security/users/remove_user.png diff --git a/content/en/cloud/identity/users/user-invitations/images/create-invitation.png b/content/en/cloud/concepts/identity-and-security/users/user-invitations/images/create-invitation.png similarity index 100% rename from content/en/cloud/identity/users/user-invitations/images/create-invitation.png rename to content/en/cloud/concepts/identity-and-security/users/user-invitations/images/create-invitation.png diff --git a/content/en/cloud/identity/users/user-invitations/images/invitation-email.png b/content/en/cloud/concepts/identity-and-security/users/user-invitations/images/invitation-email.png similarity index 100% rename from content/en/cloud/identity/users/user-invitations/images/invitation-email.png rename to content/en/cloud/concepts/identity-and-security/users/user-invitations/images/invitation-email.png diff --git a/content/en/cloud/identity/users/user-invitations/images/overview.png b/content/en/cloud/concepts/identity-and-security/users/user-invitations/images/overview.png similarity index 100% rename from content/en/cloud/identity/users/user-invitations/images/overview.png rename to content/en/cloud/concepts/identity-and-security/users/user-invitations/images/overview.png diff --git a/content/en/cloud/identity/users/user-invitations/index.md b/content/en/cloud/concepts/identity-and-security/users/user-invitations/index.md similarity index 99% rename from content/en/cloud/identity/users/user-invitations/index.md rename to content/en/cloud/concepts/identity-and-security/users/user-invitations/index.md index f30eae8c21..686d1770dd 100644 --- a/content/en/cloud/identity/users/user-invitations/index.md +++ b/content/en/cloud/concepts/identity-and-security/users/user-invitations/index.md @@ -5,6 +5,9 @@ description: > weight: 3 categories: [Identity] tags: [users] +aliases: + - /cloud/identity/users/user-invitations/ + --- The [invitation system](https://cloud.layer5.io/identity/invitations) gives you precise control over how members join your organization, allowing you to streamline onboarding and enhance security. diff --git a/content/en/cloud/identity/users/user-management.md b/content/en/cloud/concepts/identity-and-security/users/user-management.md similarity index 85% rename from content/en/cloud/identity/users/user-management.md rename to content/en/cloud/concepts/identity-and-security/users/user-management.md index 39293d2cea..18ec8c0316 100644 --- a/content/en/cloud/identity/users/user-management.md +++ b/content/en/cloud/concepts/identity-and-security/users/user-management.md @@ -5,20 +5,23 @@ description: > weight: 4 categories: [Identity] tags: [users] +aliases: + - /cloud/identity/users/user-management/ + --- This guide outlines methods for creating user accounts, adding users to organizations, inviting new members, and managing user access within Layer5 Cloud to maintain a secure and organized environment. -![User Management options](/cloud/identity/users/org_invite.png) +![User Management options](/cloud/concepts/identity-and-security/users/org_invite.png) ## Create User Account Seamlessly initiate new user accounts, ensuring a smooth onboarding process. Specify user details, such as email, and tailor their access by adding them to one or more organizations. Optionally assign roles, defining their scope within the platform. Complete the process by sending a personalized account setup email, streamlining the user's introduction to Layer5 Cloud. -![Create User](/cloud/identity/users/create-user.gif) +![Create User](/cloud/concepts/identity-and-security/users/create-user.gif) {{< alert type="info" title="Permission Required for User Creation" >}} -Only Provider Admins and Organization Admins can create users. For more information, see [Roles](/cloud/security/roles). +Only Provider Admins and Organization Admins can create users. For more information, see [Roles](/cloud/concepts/identity-and-security/roles). {{< /alert >}} ## Add / Remove Existing User @@ -37,7 +40,7 @@ If someone already has a Layer5 Cloud account but isn't part of your organizatio 4. Select the user from the list of available users. 5. Assign appropriate roles within the organization. -![Add User to Organization](/cloud/identity/users/add-user.gif) +![Add User to Organization](/cloud/concepts/identity-and-security/users/add-user.gif) ### Removing Users from an Organization @@ -53,7 +56,7 @@ You can remove users from an organization one by one or several at once. This ac * **Use Bulk Action:** Click the "Delete" button. * **Confirm:** When prompted, confirm that you want to remove all the selected users from the organization. -![Removing Users from an Organization](/cloud/identity/users/remove_user.png) +![Removing Users from an Organization](/cloud/concepts/identity-and-security/users/remove_user.png) ## Invite User via Email @@ -67,5 +70,5 @@ You can invite new or existing users to join one of your organizations by sendin * **What the User Does:** The person you invited will click a link in the email to accept. If they're new to Layer5 Cloud, they'll need to create an account first before they can join your organization. {{< alert type="info" title="Permissions for Role Assignment" >}} -An Organization Admin can assign organization roles to users, but provider roles can only be assigned by Provider Admins. For more information, see [Roles](/cloud/security/roles). +An Organization Admin can assign organization roles to users, but provider roles can only be assigned by Provider Admins. For more information, see [Roles](/cloud/concepts/identity-and-security/roles). {{< /alert >}} diff --git a/content/en/cloud/spaces/_index.md b/content/en/cloud/concepts/spaces/_index.md similarity index 86% rename from content/en/cloud/spaces/_index.md rename to content/en/cloud/concepts/spaces/_index.md index 9301a10ccc..53b53d9190 100644 --- a/content/en/cloud/spaces/_index.md +++ b/content/en/cloud/concepts/spaces/_index.md @@ -4,4 +4,7 @@ description: > Meshery Spaces serve as a gathering point for your team-based work by grouping resources and controlling their access. weight: 6 categories: [Spaces] +aliases: + - /cloud/spaces/ + --- diff --git a/content/en/cloud/spaces/environments.md b/content/en/cloud/concepts/spaces/environments.md similarity index 98% rename from content/en/cloud/spaces/environments.md rename to content/en/cloud/concepts/spaces/environments.md index e9d2e81d42..d6480565c4 100644 --- a/content/en/cloud/spaces/environments.md +++ b/content/en/cloud/concepts/spaces/environments.md @@ -2,6 +2,9 @@ title: Environments description: "Environments are how you organize your deployment targets (whether on-premises servers or cloud services) into resource groups." categories: [Spaces] +aliases: + - /cloud/spaces/environments/ + --- Environments are how you organize your deployment targets (whether on-premises servers or cloud services) into groups that represent the different stages of your deployment pipeline, for instance, development, test, and production. @@ -45,7 +48,7 @@ Credentials in an Environment are the keys to securely authenticate and access m ## Example: Orbital Labs Environment Setup -The following illustrates how Five and Zara set up multi-cloud environments at Orbital Labs, spanning AWS, GCP, and Azure. See [Meet Five and the Cast](/cloud/about) for the full seed inventory. +The following illustrates how Five and Zara set up multi-cloud environments at Orbital Labs, spanning AWS, GCP, and Azure. See [Meet Five and the Cast](/cloud/getting-started/meet-five) for the full seed inventory. ### Environment Inventory diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/concepts/spaces/workspaces.md similarity index 94% rename from content/en/cloud/spaces/workspaces.md rename to content/en/cloud/concepts/spaces/workspaces.md index cfb35880bf..4fd62210d3 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/concepts/spaces/workspaces.md @@ -4,6 +4,9 @@ description: > Understand the core concepts of Workspaces. weight: 6 categories: [Spaces] +aliases: + - /cloud/spaces/workspaces/ + --- Workspaces provide a virtual space for you and your teams to collaborate, organize project-based work, manage access to environments and resources, and track team activities. @@ -38,7 +41,7 @@ Like a shared drive (or shared collection of files), Workspaces are your Google - Same environment can be assigned to multiple workspaces. {{< alert type="info" title="Assigning Environments to Workspaces" >}} -Assign any number of Environments to one or more Workspaces. See [Environments](/cloud/spaces/environments) section for more information. +Assign any number of Environments to one or more Workspaces. See [Environments](/cloud/concepts/spaces/environments) section for more information. {{< /alert >}} ### Designs @@ -58,7 +61,7 @@ Designs belong to only one Workspace at any given time. See [Designs](https://do - Same team can be assigned to multiple workspaces. {{< alert type="info" title="Team Access Control in Workspaces" >}} -Teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections. See [Teams](/cloud/identity/teams). +Teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections. See [Teams](/cloud/concepts/identity-and-security/teams). {{< /alert >}} ### Connections @@ -82,12 +85,12 @@ To make the most of Workspaces, here are some best practices: Workspaces enhance collaboration within your teams, providing a structured environment for sharing and managing resources. By following best practices and understanding the core components of Workspaces, you can maximize the benefits of this feature. {{< alert type="info" title="Looking for Practical Workspace Management?" >}} -For a step-by-step guide on how to create, edit, and manage your workspaces, see the [Managing Workspaces](/cloud/spaces/managing-workspaces/) documentation. +For a step-by-step guide on how to create, edit, and manage your workspaces, see the [Managing Workspaces](/cloud/guides/workspaces/managing-workspaces/) documentation. {{< /alert >}} ## Example: Orbital Labs Workspace Setup -The following illustrates how Five and Maya set up workspaces at Orbital Labs to segment access across infrastructure and development workflows. See [Meet Five and the Cast](/cloud/about) for the full seed inventory. +The following illustrates how Five and Maya set up workspaces at Orbital Labs to segment access across infrastructure and development workflows. See [Meet Five and the Cast](/cloud/getting-started/meet-five) for the full seed inventory. ### Workspace Inventory diff --git a/content/en/cloud/getting-started/_index.md b/content/en/cloud/getting-started/_index.md index cc05271d14..6e06c229c6 100644 --- a/content/en/cloud/getting-started/_index.md +++ b/content/en/cloud/getting-started/_index.md @@ -22,8 +22,6 @@ Layer5 Cloud functions as a Remote Provider for Meshery. To get started: 2. **Select Provider:** On the login screen, select **Layer5 Cloud** from the provider dropdown. 3. **Authenticate:** You will be redirected to the Layer5 Cloud authentication page. Log in with your preferred identity provider (GitHub, Google, etc.). -![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow") - ## Core Workflow Once authenticated, you can begin organizing your infrastructure using the following hierarchy: @@ -46,5 +44,5 @@ To verify your setup, try deploying a sample design: If you run into issues during setup, join our [Slack Community](http://slack.layer5.io) or check the [Troubleshooting Guide](/docs/troubleshooting). {{< alert type="info" title="Follow Along with Five" >}} -Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →]({{< relref "/cloud/about/_index.md" >}}) +Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →]({{< relref "/cloud/getting-started/meet-five/_index.md" >}}) {{< /alert >}} diff --git a/content/en/cloud/getting-started/getting-started-with-layer5-account.md b/content/en/cloud/getting-started/getting-started-with-layer5-account.md index 7d03b1ab29..31140efbb2 100644 --- a/content/en/cloud/getting-started/getting-started-with-layer5-account.md +++ b/content/en/cloud/getting-started/getting-started-with-layer5-account.md @@ -44,7 +44,7 @@ On successful login, you will be prompted to setup your first organization and w 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. {{< alert type="info" >}} -For more information, see [Organizations](/cloud/identity/organizations/). +For more information, see [Organizations](/cloud/concepts/identity-and-security/organizations/) {{< /alert >}} @@ -55,7 +55,7 @@ Give your organization a name and a description. For more information, see "Crea 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 resources in your workspaces through teams. {{< alert type="info" >}} -For more information, see [Workspaces](/cloud/spaces/workspaces/). +For more information, see [Workspaces](/cloud/concepts/spaces/workspaces/) {{< /alert >}} Give your workspace a name and a description. For more information, see "Creating a workspace." diff --git a/content/en/cloud/about/_index.md b/content/en/cloud/getting-started/meet-five/_index.md similarity index 89% rename from content/en/cloud/about/_index.md rename to content/en/cloud/getting-started/meet-five/_index.md index 3befce2c22..99cb9e2bf5 100644 --- a/content/en/cloud/about/_index.md +++ b/content/en/cloud/getting-started/meet-five/_index.md @@ -2,9 +2,13 @@ title: Meet Five and the Cast description: > The continuous narrative behind Layer5 Cloud documentation — Five, his team at Orbital Labs, and the cloud-native universe they inhabit. -linkTitle: About +linkTitle: Meet Five weight: 0 categories: [About] +aliases: + - /cloud/about/ + - /cloud/getting-started/about/ + --- Five is a Platform Engineer at Orbital Labs with an unshakeable belief that every problem is solvable with the right tool, the right permissions, and — ideally — access to production. He arrived at Layer5 Cloud the same way most engineers arrive at operations tooling: via a 3 AM paging incident that politely suggested he learn something new. He did. He also learned about role-based access control the hard way, but that is what the rest of these docs are for. @@ -45,7 +49,7 @@ Orbital Labs operates as a tenant of Constellation Cloud, an MSP whose Provider {{< cardpane >}} {{% card header="**Dr. Aiko Sato** — Provider Admin" %}} -![Dr. Aiko Sato — Provider Admin at Constellation Cloud](/images/five/layer5-five-mascot-means-business.svg) +Dr. Aiko Sato — Provider Admin at Constellation Cloud **Organization:** Constellation Cloud **Role:** Provider Admin @@ -59,7 +63,7 @@ Has seen every misconfigured RBAC policy known to humankind. Responds to Slack m {{< cardpane >}} {{% card header="**Five** — Platform Engineer" %}} -![Five — Platform Engineer at Orbital Labs](/images/five/1.svg) +Five — Platform Engineer at Orbital Labs **Organization:** Orbital Labs **Role:** User (Platform Engineer) @@ -68,7 +72,7 @@ Has seen every misconfigured RBAC policy known to humankind. Responds to Slack m The protagonist — curious, enthusiastic, and reliably the first to discover that a feature works differently than the docs say it does. {{% /card %}} {{% card header="**Maya Chen** — Org Admin & Development Team Admin" %}} -![Maya Chen — Org Admin and Development Team Admin at Orbital Labs](/images/five/2.svg) +Maya Chen — Org Admin and Development Team Admin at Orbital Labs **Organization:** Orbital Labs **Role:** Org Admin + Development Team Admin @@ -80,7 +84,7 @@ Voice of reason. Has a calendar block called "Preventing Five from touching prod {{< cardpane >}} {{% card header="**Zara Osei** — Infrastructure Team Admin" %}} -![Zara Osei — Infrastructure Team Admin at Orbital Labs](/images/five/3.svg) +Zara Osei — Infrastructure Team Admin at Orbital Labs **Organization:** Orbital Labs **Role:** Team Admin, Infrastructure Team @@ -89,7 +93,7 @@ Voice of reason. Has a calendar block called "Preventing Five from touching prod Sole keeper of the keychain permission matrix. Responds to access requests with a 48-hour SLA and a knowing look. {{% /card %}} {{% card header="**Rex Park** — Developer" %}} -![Rex Park — Developer at Orbital Labs](/images/five/4.svg) +Rex Park — Developer at Orbital Labs **Organization:** Orbital Labs **Role:** User, Developer Team @@ -98,7 +102,7 @@ Sole keeper of the keychain permission matrix. Responds to access requests with Opens design review requests and immediately asks Five if they have been approved yet. Deploys with confidence; reads error logs with less. {{% /card %}} {{% card header="**Jordan Reyes** — Developer & Designer" %}} -![Jordan Reyes — Developer and Designer at Orbital Labs](/images/five/5.svg) +Jordan Reyes — Developer and Designer at Orbital Labs **Organization:** Orbital Labs **Role:** User, Developer Team @@ -112,7 +116,7 @@ Crafts Kanvas designs of alarming elegance. Considers a 47-component architectur {{< cardpane >}} {{% card header="**Marcus Webb** — Org Admin" %}} -![Marcus Webb — Org Admin at Stellar Dynamics](/images/five/layer5-five-mascot-means-business.svg) +Marcus Webb — Org Admin at Stellar Dynamics **Organization:** Stellar Dynamics **Role:** Org Admin diff --git a/content/en/cloud/about/five-narrative-plan.md b/content/en/cloud/getting-started/meet-five/five-narrative-plan.md similarity index 63% rename from content/en/cloud/about/five-narrative-plan.md rename to content/en/cloud/getting-started/meet-five/five-narrative-plan.md index 43ab606a82..388921d74c 100644 --- a/content/en/cloud/about/five-narrative-plan.md +++ b/content/en/cloud/getting-started/meet-five/five-narrative-plan.md @@ -5,15 +5,19 @@ description: > linkTitle: Narrative Research Plan weight: 1 categories: [About] +aliases: + - /cloud/about/five-narrative-plan/ + - /cloud/getting-started/about/five-narrative-plan/ + --- {{< alert type="info" >}} -This page is a working document for documentation contributors. For the narrative itself — characters, organizations, and seed data — see [Meet Five and the Cast](/cloud/about/). +This page is a working document for documentation contributors. For the narrative itself — characters, organizations, and seed data — see [Meet Five and the Cast](/cloud/getting-started/meet-five/). {{< /alert >}} ## Objective -Layer5 Cloud and Kanvas documentation adopts a continuous narrative centered on Five and his colleagues at Orbital Labs. Rather than using generic placeholders ("User A", "Organization X"), every major docs section uses the canonical cast and scenarios defined in [Meet Five and the Cast](/cloud/about/). This plan maps which characters and scenarios belong in which sections, which Five illustrations to use, and the priority order for rolling out updates. +Layer5 Cloud and Kanvas documentation adopts a continuous narrative centered on Five and his colleagues at Orbital Labs. Rather than using generic placeholders ("User A", "Organization X"), every major docs section uses the canonical cast and scenarios defined in [Meet Five and the Cast](/cloud/getting-started/meet-five/). This plan maps which characters and scenarios belong in which sections, which Five illustrations to use, and the priority order for rolling out updates. ## Integration Map @@ -24,15 +28,15 @@ The **Difficulty** column rates the effort to update that section: | Docs Section | Characters | Scenario | Five Illustration | Difficulty | Status | |---|---|---|---|---|---| -| `cloud/identity/users` | Five, Maya | Five's profile card; Maya as Org Admin example | `/images/five/1.svg` | Low | Open | -| `cloud/identity/organizations` | Maya, Marcus | Orbital Labs org creation walkthrough; Stellar Dynamics as enterprise tenant | — | Low | Open | -| `cloud/identity/teams` | Zara, Rex, Jordan | Infrastructure team vs. Development team setup | `/images/five/team-of-fives.svg` | Low | Open | -| `cloud/security/roles` | Dr. Aiko, Maya, Zara | Provider Admin (Dr. Aiko) → Org Admin (Maya) → Team Admin (Zara) chain | `/images/five/layer5-five-mascot-means-business.svg` | Medium | Open | -| `cloud/security/keychains` | Zara | Zara configuring a keychain scoped to the Infrastructure team, locking down `prod-aws` access | — | Medium | Open | -| `cloud/spaces/workspaces` | Five, Maya | Five creates `orbital-staging`; Maya assigns Infrastructure and Development teams | — | Medium | Open | -| `cloud/spaces/environments` | Five, Zara | Five connects `prod-aws` (EKS + RDS + S3) and `prod-gcp` (GKE + Pub/Sub); Zara approves | — | Medium | Open | +| `cloud/concepts/identity-and-security/users` | Five, Maya | Five's profile card; Maya as Org Admin example | `/images/five/1.svg` | Low | Open | +| `cloud/concepts/identity-and-security/organizations` | Maya, Marcus | Orbital Labs org creation walkthrough; Stellar Dynamics as enterprise tenant | — | Low | Open | +| `cloud/concepts/identity-and-security/teams` | Zara, Rex, Jordan | Infrastructure team vs. Development team setup | `/images/five/team-of-fives.svg` | Low | Open | +| `cloud/concepts/identity-and-security/roles` | Dr. Aiko, Maya, Zara | Provider Admin (Dr. Aiko) → Org Admin (Maya) → Team Admin (Zara) chain | `/images/five/layer5-five-mascot-means-business.svg` | Medium | Open | +| `cloud/concepts/identity-and-security/keychains` | Zara | Zara configuring a keychain scoped to the Infrastructure team, locking down `prod-aws` access | — | Medium | Open | +| `cloud/concepts/spaces/workspaces` | Five, Maya | Five creates `orbital-staging`; Maya assigns Infrastructure and Development teams | — | Medium | Open | +| `cloud/concepts/spaces/environments` | Five, Zara | Five connects `prod-aws` (EKS + RDS + S3) and `prod-gcp` (GKE + Pub/Sub); Zara approves | — | Medium | Open | | `cloud/getting-started` | Five | Five's first login, first workspace (`orbital-dev`), first design (`microservices-baseline`) | `/images/five/1.svg` | Low | Open | -| `cloud/tutorials/sharing-a-workspace` | Five, Rex | Five shares `orbital-dev` with Rex's Developer team | — | Low | Open | +| `cloud/guides/tutorials/sharing-a-workspace` | Five, Rex | Five shares `orbital-dev` with Rex's Developer team | — | Low | Open | | `kanvas/getting-started` | Jordan, Five | Jordan opens `microservices-baseline` in Designer; Five reviews and leaves a comment | — | Medium | Open | | `kanvas/designer` | Jordan, Rex | Full walkthrough of `api-platform-aws` design (EKS + API Gateway + Lambda + RDS + S3) | — | High | Open | @@ -71,28 +75,28 @@ When capturing screenshots for any section that references the Five narrative, f | Provider Admin, cross-tenant | Dr. Aiko | `aiko@constellation-cloud.example` | | Enterprise org, cross-org access | Marcus | `marcus@stellar-dynamics.example` | -**Which workspace/environment to use:** Match the section's purpose to the Seed Inventory table in [Meet Five and the Cast](/cloud/about/). Use `dev-local` for all getting-started screenshots (no real cloud credentials required). +**Which workspace/environment to use:** Match the section's purpose to the Seed Inventory table in [Meet Five and the Cast](/cloud/getting-started/meet-five/). Use `dev-local` for all getting-started screenshots (no real cloud credentials required). **File naming:** `
--.png`, e.g., `workspaces-orbital-staging-creation-2026-04-28.png`. Store in the `images/` subdirectory of the relevant content section. ## Priority Order ### Ship with This PR -- `cloud/getting-started` — add intro paragraph and link to `/cloud/about` ✓ (done in this PR) +- `cloud/getting-started` — add intro paragraph and link to `/cloud/getting-started/meet-five` ✓ (done in this PR) ### Next Sprint — Batch 1: Identity (Low difficulty) -1. `cloud/identity/users` — Five's profile card (replaces existing `` placeholder) -2. `cloud/identity/organizations` — Orbital Labs + Stellar Dynamics examples -3. `cloud/identity/teams` — Infrastructure + Development team examples +1. `cloud/concepts/identity-and-security/users` — Five's profile card (replaces existing `` placeholder) +2. `cloud/concepts/identity-and-security/organizations` — Orbital Labs + Stellar Dynamics examples +3. `cloud/concepts/identity-and-security/teams` — Infrastructure + Development team examples ### Next Sprint — Batch 2: Security & Spaces (Medium difficulty) -4. `cloud/security/roles` — Provider Admin → Org Admin → Team Admin chain -5. `cloud/security/keychains` — Zara's Infrastructure team keychain -6. `cloud/spaces/workspaces` — `orbital-staging` creation and team assignment -7. `cloud/spaces/environments` — `prod-aws` and `prod-gcp` setup +4. `cloud/concepts/identity-and-security/roles` — Provider Admin → Org Admin → Team Admin chain +5. `cloud/concepts/identity-and-security/keychains` — Zara's Infrastructure team keychain +6. `cloud/concepts/spaces/workspaces` — `orbital-staging` creation and team assignment +7. `cloud/concepts/spaces/environments` — `prod-aws` and `prod-gcp` setup ### Backlog — Batch 3: Tutorials & Screenshots (Medium–High) -8. `cloud/tutorials/sharing-a-workspace` — Five + Rex scenario +8. `cloud/guides/tutorials/sharing-a-workspace` — Five + Rex scenario 9. New tutorial: Promoting a design from staging to prod 10. `kanvas/getting-started` — narrative character references diff --git a/content/en/cloud/guides/_index.md b/content/en/cloud/guides/_index.md new file mode 100644 index 0000000000..1c9bfea61e --- /dev/null +++ b/content/en/cloud/guides/_index.md @@ -0,0 +1,8 @@ +--- +title: Guides & Tutorials +linkTitle: Guides & Tutorials +description: Procedural guides and tutorials for using Layer5 Cloud. +weight: 3 +--- + +Use this section to find practical guidance for common Layer5 Cloud workflows. diff --git a/content/en/cloud/guides/integrations/_index.md b/content/en/cloud/guides/integrations/_index.md new file mode 100644 index 0000000000..e80e689207 --- /dev/null +++ b/content/en/cloud/guides/integrations/_index.md @@ -0,0 +1,9 @@ +--- +title: Integrations +description: Guides for connecting Layer5 Cloud and Kanvas to external tools and workflows. +weight: 3 +categories: [Workspaces] +tags: [integrations] +--- + +Use these guides to connect Layer5 Cloud and Kanvas with external systems, repositories, and automation workflows. diff --git a/content/en/cloud/github-actions/_index.md b/content/en/cloud/guides/integrations/github-actions/_index.md similarity index 68% rename from content/en/cloud/github-actions/_index.md rename to content/en/cloud/guides/integrations/github-actions/_index.md index 6a57a3e2c3..d17b4e589c 100644 --- a/content/en/cloud/github-actions/_index.md +++ b/content/en/cloud/guides/integrations/github-actions/_index.md @@ -1,9 +1,13 @@ --- title: GitHub Actions description: GitHub Actions with Kanvas automates the synchronization of Git repositories and visually validates pull requests for efficient development. -weight: 20 +weight: 1 categories: [Workspaces] tags: [gitops, github-actions, kanvas] +aliases: + - /cloud/github-actions/ + - /cloud/guides/github-actions/ + --- Kanvas GitHub Actions enhance your operational workflow by integrating git version control and the management of your infrastructure. Kanvas GitHub Actions are design to integrate into your existing pipelines. @@ -25,19 +29,7 @@ Kanvas introduces the Kanvas Snapshot GitHub Actions, a tool that allows you to ### Configuring Kanvas Snapshots -Kanvas serves as a fundamental component, providing visual insights into infrastructure changes and facilitating the synchronization between the actual and desired states. Ensure that you have proper access to Kanvas to leverage its capabilities for effective GitOps implementation. - -#### Step 1: Get access to Kanvas - -To integrate Snapshots into your GitHub pull requests, confirm that your user account has Kanvas access. To do so, sign into your Layer5 Cloud account and look forIf your user account doesn't have access, [simply request access](https://cloud.layer5.io/account/subscriptions) to Kanvas. - -#### Step 2: Enable Kanvas Snapshot Action - -1. Choose to enable the Kanvas Snapshot action for all repositories in your GitHub account or for specific repositories. -1. Authorize the Kanvas GitHub App. -1. Copy the Secret token. This token is used to authenticate Kanvas with your Layer5 Cloud account. -1. Once authorized, Kanvas will automatically create a pull request workflow for your repository. To disable the workflow, simply delete the `.github/workflows/kanvas-snapshot.yml` file from your repository. -1. Specify the path within your Git repository where the application configurations are stored. This ensures Kanvas knows where to find and visuzlie the desired state of your infrastructure. +For setup steps, see the [Kanvas Snapshots tutorial](/cloud/guides/tutorials/gitops-snapshots/). {{%pageinfo%}} The Kanvas GitHub App requires authorization to interact with your repositories. If you would like to use your GitHub user's personal access token, instead, [please let us know](https://cloud.layer5.io/support). {{%/pageinfo%}} diff --git a/content/en/cloud/guides/organizations/_index.md b/content/en/cloud/guides/organizations/_index.md new file mode 100644 index 0000000000..e01249ca83 --- /dev/null +++ b/content/en/cloud/guides/organizations/_index.md @@ -0,0 +1,8 @@ +--- +title: Organizations +description: Guides for managing Layer5 Cloud organizations. +weight: 2 +categories: [Identity] +--- + +Use these guides to create, edit, invite members to, navigate, and delete organizations in Layer5 Cloud. diff --git a/content/en/cloud/identity/organizations/org-management/_index.md b/content/en/cloud/guides/organizations/org-management/_index.md similarity index 88% rename from content/en/cloud/identity/organizations/org-management/_index.md rename to content/en/cloud/guides/organizations/org-management/_index.md index eddc5dee08..8713f017a4 100644 --- a/content/en/cloud/identity/organizations/org-management/_index.md +++ b/content/en/cloud/guides/organizations/org-management/_index.md @@ -5,11 +5,15 @@ description: > weight: 1 categories: [Identity] tags: [orgs] +aliases: + - /cloud/identity/organizations/org-management/ + - /cloud/concepts/identity-and-security/organizations/org-management/ + --- This guide covers creating new organizations, editing their details, inviting members, and deleting organizations when necessary. -![Organization Overview](/cloud/identity/organizations/org-management/org_overview.png) +![Organization Overview](/cloud/guides/organizations/org-management/org_overview.png) {{< alert title="Permissions Required" type="info" >}} Operations described on this page for managing your Organization typically require Organization Administrator or similar administrative roles. To understand the specific roles needed for each action, please refer to the [Default Permissions reference](https://docs.layer5.io/cloud/reference/default-permissions/). @@ -28,7 +32,7 @@ An Organization provides a way to structure your teams, users, and resource acce - Region (Optional): Choose the time zone for your Organization. - Add Organization Members (Optional): You can begin adding **existing** Layer5 Cloud users to your new Organization in this field. -Filling out new Organization details +Filling out new Organization details {{< alert type="info" title="Unable to Create More Organizations?" >}} If the "Add Organization" button is disabled, it means your current role does not permit creating additional Organizations. Only users with roles like Organization Administrator or Provider Administrator can create new Organizations. @@ -47,7 +51,7 @@ You can update your Organization's name, location, associated teams, branding, a - Logos: Upload specific logo versions for various display contexts by clicking the respective **"Upload"** buttons. - Invitations: Access a shareable link to invite users to your Organization. -Editing Organization Details +Editing Organization Details ## Using the Open Organization Invitation Link @@ -58,10 +62,10 @@ To invite multiple users to your organization at once, or to allow open sign-ups * Public Sign-ups: To let people sign up openly, for instance, by posting the link on a community page or another public resource. * Cross-Organizational Collaboration: To make it easy for collaborators from other organizations or external partners to join. -![Obtain Organization Invite Link](/cloud/identity/organizations/org-management/org_open_invite.gif) +![Obtain Organization Invite Link](/cloud/guides/organizations/org-management/org_open_invite.gif) {{< alert title="Inviting Users to Specific Teams" type="info" >}} -If you want to invite users directly to a specific team within your organization, please refer to the documentation on [Open Team Invites](https://docs.layer5.io/cloud/identity/teams/) +If you want to invite users directly to a specific team within your organization, please refer to the documentation on [Open Team Invites](https://docs.layer5.io/cloud/concepts/identity-and-security/teams/) {{< /alert >}} ### How it Works @@ -111,6 +115,6 @@ Avoid deleting an Organization if: 2. A confirmation modal will appear, requiring you to verify this action. 3. Click the "Delete" button to permanently remove the Organization. To abort the deletion, click "Cancel". -Delete Organization +Delete Organization -[^1]: Existing users who click this invitation link might encounter a "Page not found" error. This is a temporary bug and is being addressed. \ No newline at end of file +[^1]: Existing users who click this invitation link might encounter a "Page not found" error. This is a temporary bug and is being addressed. diff --git a/content/en/cloud/identity/organizations/org-management/create_org.png b/content/en/cloud/guides/organizations/org-management/create_org.png similarity index 100% rename from content/en/cloud/identity/organizations/org-management/create_org.png rename to content/en/cloud/guides/organizations/org-management/create_org.png diff --git a/content/en/cloud/identity/organizations/org-management/delete_org.png b/content/en/cloud/guides/organizations/org-management/delete_org.png similarity index 100% rename from content/en/cloud/identity/organizations/org-management/delete_org.png rename to content/en/cloud/guides/organizations/org-management/delete_org.png diff --git a/content/en/cloud/identity/organizations/org-management/edit_org.png b/content/en/cloud/guides/organizations/org-management/edit_org.png similarity index 100% rename from content/en/cloud/identity/organizations/org-management/edit_org.png rename to content/en/cloud/guides/organizations/org-management/edit_org.png diff --git a/content/en/cloud/identity/organizations/org-management/navigating-organizations/index.md b/content/en/cloud/guides/organizations/org-management/navigating-organizations/index.md similarity index 94% rename from content/en/cloud/identity/organizations/org-management/navigating-organizations/index.md rename to content/en/cloud/guides/organizations/org-management/navigating-organizations/index.md index 713b423429..33c15660b4 100644 --- a/content/en/cloud/identity/organizations/org-management/navigating-organizations/index.md +++ b/content/en/cloud/guides/organizations/org-management/navigating-organizations/index.md @@ -5,6 +5,10 @@ description: > weight: 2 categories: [Identity] tags: [orgs] +aliases: + - /cloud/identity/organizations/org-management/navigating-organizations/ + - /cloud/concepts/identity-and-security/organizations/org-management/navigating-organizations/ + --- This guide explains how to switch between organizations in Layer5 Cloud and describes the order of precedence that determines your active organization context. @@ -86,4 +90,4 @@ Your roles and permissions are organization-scoped. This means: - Administrative capabilities in one organization do not automatically grant administrative access in another. - Team memberships and their associated permissions are specific to each organization. -For more details about roles and permissions, see the [Roles documentation](/cloud/security/roles/). +For more details about roles and permissions, see the [Roles documentation](/cloud/concepts/identity-and-security/roles/). diff --git a/content/en/cloud/identity/organizations/org-management/org_open_invite.gif b/content/en/cloud/guides/organizations/org-management/org_open_invite.gif similarity index 100% rename from content/en/cloud/identity/organizations/org-management/org_open_invite.gif rename to content/en/cloud/guides/organizations/org-management/org_open_invite.gif diff --git a/content/en/cloud/identity/organizations/org-management/org_overview.png b/content/en/cloud/guides/organizations/org-management/org_overview.png similarity index 100% rename from content/en/cloud/identity/organizations/org-management/org_overview.png rename to content/en/cloud/guides/organizations/org-management/org_overview.png diff --git a/content/en/cloud/self-hosted/_index.md b/content/en/cloud/guides/self-hosted/_index.md similarity index 91% rename from content/en/cloud/self-hosted/_index.md rename to content/en/cloud/guides/self-hosted/_index.md index c47ca8f368..fa2d32dade 100644 --- a/content/en/cloud/self-hosted/_index.md +++ b/content/en/cloud/guides/self-hosted/_index.md @@ -1,9 +1,12 @@ --- title: Self-Hosted -weight: 10 +weight: 6 categories: [Self-Hosted] description: > Keep your Kanvas designs internal to your workplace. Get remote support from Layer5 when you need it. +aliases: + - /cloud/self-hosted/ + --- diff --git a/content/en/cloud/self-hosted/customizing-webhooks.md b/content/en/cloud/guides/self-hosted/customizing-webhooks.md similarity index 97% rename from content/en/cloud/self-hosted/customizing-webhooks.md rename to content/en/cloud/guides/self-hosted/customizing-webhooks.md index 78ead62712..d8722471d6 100644 --- a/content/en/cloud/self-hosted/customizing-webhooks.md +++ b/content/en/cloud/guides/self-hosted/customizing-webhooks.md @@ -3,6 +3,9 @@ title: Customizing Webhooks description: "Layer5 Cloud uses webhooks to automate approval flows and email notifications. This guide will help you customize and add your own custom webhooks." categories: [Self-Hosted] weight: 1 +aliases: + - /cloud/self-hosted/customizing-webhooks/ + --- Layer5 offers on-premises installation of its [Meshery Remote Provider](https://docs.meshery.io/extensibility/providers), Layer5 Cloud. In this guide, we will walk through configurable webhooks that Layer5 Cloud uses internally to automate tasks and how you can customize these webhooks to integrate with your existing tools. diff --git a/content/en/cloud/self-hosted/deployment/_index.md b/content/en/cloud/guides/self-hosted/deployment/_index.md similarity index 99% rename from content/en/cloud/self-hosted/deployment/_index.md rename to content/en/cloud/guides/self-hosted/deployment/_index.md index 31aafedcbf..ecb70cf10e 100644 --- a/content/en/cloud/self-hosted/deployment/_index.md +++ b/content/en/cloud/guides/self-hosted/deployment/_index.md @@ -4,6 +4,9 @@ description: "Layer5 Cloud is a collection of services that can be deployed on-p categories: [Self-Hosted] tags: [helm] weight: 2 +aliases: + - /cloud/self-hosted/deployment/ + --- ## High-level List of Deployment Tasks diff --git a/content/en/cloud/self-hosted/deployment/helm-chart-values.md b/content/en/cloud/guides/self-hosted/deployment/helm-chart-values.md similarity index 99% rename from content/en/cloud/self-hosted/deployment/helm-chart-values.md rename to content/en/cloud/guides/self-hosted/deployment/helm-chart-values.md index 9bf81d0c8f..2a37299da0 100644 --- a/content/en/cloud/self-hosted/deployment/helm-chart-values.md +++ b/content/en/cloud/guides/self-hosted/deployment/helm-chart-values.md @@ -3,6 +3,9 @@ title: "Customizing Layer5 Cloud Deployment with Helm" categories: [Self-Hosted] description: "Layer5’s Helm charts support a number of configuration options. Please refer to following table of configuration options." weight: 2 +aliases: + - /cloud/self-hosted/deployment/helm-chart-values/ + --- ## Requirements diff --git a/content/en/cloud/self-hosted/images/self-hosted.svg b/content/en/cloud/guides/self-hosted/images/self-hosted.svg similarity index 100% rename from content/en/cloud/self-hosted/images/self-hosted.svg rename to content/en/cloud/guides/self-hosted/images/self-hosted.svg diff --git a/content/en/cloud/self-hosted/operating/smtp.md b/content/en/cloud/guides/self-hosted/operating/smtp.md similarity index 99% rename from content/en/cloud/self-hosted/operating/smtp.md rename to content/en/cloud/guides/self-hosted/operating/smtp.md index 62329d69d0..42640eb299 100644 --- a/content/en/cloud/self-hosted/operating/smtp.md +++ b/content/en/cloud/guides/self-hosted/operating/smtp.md @@ -3,6 +3,9 @@ title: Email / SMTP Troubleshooting categories: [Self-Hosted] description: > This guide explains how to diagnose email sending issues in Layer5 Cloud deployments using the enhanced debug logging and testing features. +aliases: + - /cloud/self-hosted/operating/smtp/ + --- # Email Debugging Guide for Layer5 Cloud diff --git a/content/en/cloud/self-hosted/planning/_index.md b/content/en/cloud/guides/self-hosted/planning/_index.md similarity index 98% rename from content/en/cloud/self-hosted/planning/_index.md rename to content/en/cloud/guides/self-hosted/planning/_index.md index b407feb50b..d0045f41e1 100644 --- a/content/en/cloud/self-hosted/planning/_index.md +++ b/content/en/cloud/guides/self-hosted/planning/_index.md @@ -2,6 +2,9 @@ title: Planning description: Plan your self-hosted Layer5 Cloud deployment weight: 2 +aliases: + - /cloud/self-hosted/planning/ + --- ## Provider Configuration Planning @@ -145,4 +148,4 @@ Layer5 acknowledges the importance of air-gapped deployments and ensures content Plan for comprehensive observability across your Layer5 Cloud deployment, including metrics, logs, tracing, dashboards, and alerting. Establish SLOs for latency, availability, and saturation; size telemetry storage appropriately; and ensure privacy and access controls for operational data. -See: [Monitoring](/cloud/self-hosted/planning/monitoring/) +See: [Monitoring](/cloud/guides/self-hosted/planning/monitoring/) diff --git a/content/en/cloud/self-hosted/planning/identity-services.md b/content/en/cloud/guides/self-hosted/planning/identity-services.md similarity index 85% rename from content/en/cloud/self-hosted/planning/identity-services.md rename to content/en/cloud/guides/self-hosted/planning/identity-services.md index 5e3b66ec25..f685f72dbd 100644 --- a/content/en/cloud/self-hosted/planning/identity-services.md +++ b/content/en/cloud/guides/self-hosted/planning/identity-services.md @@ -4,14 +4,17 @@ description: "Understand identity services prerequisites and how to integrate yo categories: [Self-Hosted] tags: [identity] weight: 3 +aliases: + - /cloud/self-hosted/planning/identity-services/ + --- -Layer5 Cloud offers a built-in identity provider (IDP), supporting OIDC for normal users and token-based authentication (access, ID, refresh tokens) for API clients with JSON Web Signature (JWS) for token signing. Layer5 Cloud users can sign-up via email and password in addition to social identity providers (Google and GitHub) via OAuth2. See [Getting Started with a Layer5 Account](../../getting-started/getting-started-with-layer5-account.md) for details. +Layer5 Cloud offers a built-in identity provider (IDP), supporting OIDC for normal users and token-based authentication (access, ID, refresh tokens) for API clients with JSON Web Signature (JWS) for token signing. Layer5 Cloud users can sign-up via email and password in addition to social identity providers (Google and GitHub) via OAuth2. See [Getting Started with a Layer5 Account](/cloud/getting-started/getting-started-with-layer5-account/) for details. Layer5 Cloud identity services include features such as account recovery, email verification, automatica social sign-in account linking, and multi-factor authentication (coming soon). {{< alert type="info" >}} -For more information, see [User Account Linking](/cloud/identity/users). +For more information, see [User Account Linking](/cloud/concepts/identity-and-security/users). {{< /alert >}} Layer5 Cloud is also working toward being the IDP for Layer5 by supporting OIDC. It will leverage social authentication with Google, GitHub, Twitter, and LinkedIn based on OIDC to authenticate normal users. After authentication, Layer5 Cloud will be able to generate the access token, ID token, and refresh token for normal users. Applications, on the other hand, will use client credential OAUTH2 to get an access token. diff --git a/content/en/cloud/self-hosted/planning/images/kanvas-collaboration-networking.svg b/content/en/cloud/guides/self-hosted/planning/images/kanvas-collaboration-networking.svg similarity index 100% rename from content/en/cloud/self-hosted/planning/images/kanvas-collaboration-networking.svg rename to content/en/cloud/guides/self-hosted/planning/images/kanvas-collaboration-networking.svg diff --git a/content/en/cloud/self-hosted/planning/images/self-hosted-deployment.svg b/content/en/cloud/guides/self-hosted/planning/images/self-hosted-deployment.svg similarity index 100% rename from content/en/cloud/self-hosted/planning/images/self-hosted-deployment.svg rename to content/en/cloud/guides/self-hosted/planning/images/self-hosted-deployment.svg diff --git a/content/en/cloud/self-hosted/planning/monitoring.md b/content/en/cloud/guides/self-hosted/planning/monitoring.md similarity index 98% rename from content/en/cloud/self-hosted/planning/monitoring.md rename to content/en/cloud/guides/self-hosted/planning/monitoring.md index 2367dcd55e..41da8195bc 100644 --- a/content/en/cloud/self-hosted/planning/monitoring.md +++ b/content/en/cloud/guides/self-hosted/planning/monitoring.md @@ -4,6 +4,9 @@ description: "Plan monitoring for Layer5 Cloud self-hosted deployments: metrics, categories: [Self-Hosted] tags: [monitoring] weight: 4 +aliases: + - /cloud/self-hosted/planning/monitoring/ + --- Monitoring is essential to operate a reliable Layer5 Cloud deployment. Plan for metrics, logs, traces, dashboards, alerting, and retention so that you can detect and resolve issues quickly, understand capacity, and meet compliance needs. diff --git a/content/en/cloud/self-hosted/planning/peer-to-peer-communication.md b/content/en/cloud/guides/self-hosted/planning/peer-to-peer-communication.md similarity index 96% rename from content/en/cloud/self-hosted/planning/peer-to-peer-communication.md rename to content/en/cloud/guides/self-hosted/planning/peer-to-peer-communication.md index 169b5d65e1..7a51d9ca36 100644 --- a/content/en/cloud/self-hosted/planning/peer-to-peer-communication.md +++ b/content/en/cloud/guides/self-hosted/planning/peer-to-peer-communication.md @@ -4,6 +4,9 @@ description: "Prepare and configure network services for your Layer5 Cloud deplo categories: [Self-Hosted] tags: [identity] weight: 2 +aliases: + - /cloud/self-hosted/planning/peer-to-peer-communication/ + --- ## Considerations of Peer-to-Peer Communication diff --git a/content/en/cloud/self-hosted/white-labeling/_index.md b/content/en/cloud/guides/self-hosted/white-labeling/_index.md similarity index 95% rename from content/en/cloud/self-hosted/white-labeling/_index.md rename to content/en/cloud/guides/self-hosted/white-labeling/_index.md index 5accb0b665..7ba04d87e1 100644 --- a/content/en/cloud/self-hosted/white-labeling/_index.md +++ b/content/en/cloud/guides/self-hosted/white-labeling/_index.md @@ -4,6 +4,9 @@ weight: 1 categories: [Self-Hosted] description: > Customize the appearance and branding of your engineering platform powered by Layer5 Cloud. +aliases: + - /cloud/self-hosted/white-labeling/ + --- You can change the logo, color scheme, domain name, and other aspects of the user interface to match your own identity and preferences. White-labeling enables you to offer a seamless and consistent experience to your customers, partners, or internal users who access your service mesh platform. White-labeling also helps you to differentiate your platform from other Layer5 Cloud users and competitors, and to enhance your brand recognition and loyalty. @@ -35,7 +38,7 @@ This example includes a custom branding with colors and full-sized logo. Layer5 Cloud supports customizing themes on a per organization basis. This includes the ability to upload your own logo and define your own color scheme. Your logo will be displayed in the top left corner of the dashboard. Both a full-sized logo and a logo mark are supported. -As an [Organization Administrator](/cloud/security/roles/organization-roles/), you can add your organization's logo to the global navigation bar, which supports a large, horizontal logo for desktop users and a small, square logo for mobile users. The logo appears at the top of each user's window for all Layer5 Cloud pages within your organization. +As an [Organization Administrator](/cloud/concepts/identity-and-security/roles/organization-roles/), you can add your organization's logo to the global navigation bar, which supports a large, horizontal logo for desktop users and a small, square logo for mobile users. The logo appears at the top of each user's window for all Layer5 Cloud pages within your organization. {{% card header="Preference Example" footer="Example: Selection of theme" %}} This example shows how to customize through different themes @@ -66,7 +69,7 @@ Square logo (mark): 32 width x 32 height pixels {{% tab header="Full-sized Logo Example" lang="en" active="true" %}} -When users register through the [Open Organization Invitation Link](https://docs.layer5.io/cloud/identity/organizations/org-management/#using-the-open-organization-invitation-link), they will see the full-sized logo. +When users register through the [Open Organization Invitation Link](https://docs.layer5.io/cloud/guides/organizations/org-management/#using-the-open-organization-invitation-link), they will see the full-sized logo. Full-sized Logo @@ -138,7 +141,7 @@ To set up a www or custom subdomain, such as `www.example.com` or `meshery.examp In Layer5 Cloud, navigate to your Provider Organization. -Under your Organization name, click Edit. If you cannot click the "Edit" action, verify that you are a [Provider Administrator](/cloud/security/roles). +Under your Organization name, click Edit. If you cannot click the "Edit" action, verify that you are a [Provider Administrator](/cloud/concepts/identity-and-security/roles). Under "Custom domain", type your custom domain, then click Save. This will create a server configuration that will require a reboot in order to take effect. diff --git a/content/en/cloud/self-hosted/white-labeling/images/custom-branding-dashboard-cloudfire.png b/content/en/cloud/guides/self-hosted/white-labeling/images/custom-branding-dashboard-cloudfire.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/custom-branding-dashboard-cloudfire.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/custom-branding-dashboard-cloudfire.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/custom-branding-dashboard-mobile-cloudfire.png b/content/en/cloud/guides/self-hosted/white-labeling/images/custom-branding-dashboard-mobile-cloudfire.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/custom-branding-dashboard-mobile-cloudfire.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/custom-branding-dashboard-mobile-cloudfire.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/custom-dashboard-1.png b/content/en/cloud/guides/self-hosted/white-labeling/images/custom-dashboard-1.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/custom-dashboard-1.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/custom-dashboard-1.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/custom-dashboard-2.png b/content/en/cloud/guides/self-hosted/white-labeling/images/custom-dashboard-2.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/custom-dashboard-2.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/custom-dashboard-2.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/custom-dashboard-3.png b/content/en/cloud/guides/self-hosted/white-labeling/images/custom-dashboard-3.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/custom-dashboard-3.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/custom-dashboard-3.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/full-size-logo.png b/content/en/cloud/guides/self-hosted/white-labeling/images/full-size-logo.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/full-size-logo.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/full-size-logo.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/logo-mark.png b/content/en/cloud/guides/self-hosted/white-labeling/images/logo-mark.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/logo-mark.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/logo-mark.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/pref-selection.gif b/content/en/cloud/guides/self-hosted/white-labeling/images/pref-selection.gif similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/pref-selection.gif rename to content/en/cloud/guides/self-hosted/white-labeling/images/pref-selection.gif diff --git a/content/en/cloud/self-hosted/white-labeling/images/white-label-catalog-example.png b/content/en/cloud/guides/self-hosted/white-labeling/images/white-label-catalog-example.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/white-label-catalog-example.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/white-label-catalog-example.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/white-label-dashboard-example.png b/content/en/cloud/guides/self-hosted/white-labeling/images/white-label-dashboard-example.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/white-label-dashboard-example.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/white-label-dashboard-example.png diff --git a/content/en/cloud/self-hosted/white-labeling/images/white-label-login-screen-example.png b/content/en/cloud/guides/self-hosted/white-labeling/images/white-label-login-screen-example.png similarity index 100% rename from content/en/cloud/self-hosted/white-labeling/images/white-label-login-screen-example.png rename to content/en/cloud/guides/self-hosted/white-labeling/images/white-label-login-screen-example.png diff --git a/content/en/cloud/tutorials/_index.md b/content/en/cloud/guides/tutorials/_index.md old mode 100755 new mode 100644 similarity index 70% rename from content/en/cloud/tutorials/_index.md rename to content/en/cloud/guides/tutorials/_index.md index b88fd3b725..b759e6c06e --- a/content/en/cloud/tutorials/_index.md +++ b/content/en/cloud/guides/tutorials/_index.md @@ -1,5 +1,7 @@ --- title: Tutorials description: Show your user how to work through some end to end examples. -weight: 8 +weight: 4 +aliases: + - /cloud/tutorials/ --- diff --git a/content/en/cloud/tutorials/assigning-user-badges.md b/content/en/cloud/guides/tutorials/assigning-user-badges.md similarity index 93% rename from content/en/cloud/tutorials/assigning-user-badges.md rename to content/en/cloud/guides/tutorials/assigning-user-badges.md index b0f3c51dd7..f8d642677c 100755 --- a/content/en/cloud/tutorials/assigning-user-badges.md +++ b/content/en/cloud/guides/tutorials/assigning-user-badges.md @@ -2,6 +2,13 @@ title: Recognizing User and Contributor Milestones description: > Showcasing user and contributor achievements +weight: 4 +categories: [Tutorials] +tags: [badges, recognition, profile] +aliases: + - /cloud/tutorials/assigning-user-badges/ + - /cloud/guides/profile/recognizing-user-and-contributor-milestones/ + --- @@ -37,7 +44,7 @@ To share your badges on other social profiles, utilize the provided embedded cod 3. Copy the html or the markdown code by clicking the Embed Code icon 4. Paste the code in your site -{{< figure src="/cloud/tutorials/images/embedding-badges-modal.svg" alt="Embedding-badges-modal">}} +{{< figure src="/cloud/guides/tutorials/images/embedding-badges-modal.svg" alt="Embedding-badges-modal">}} ### FAQ - **Is there a limit to the number of badges that I can earn?** diff --git a/content/en/cloud/tutorials/gitops-snapshots.md b/content/en/cloud/guides/tutorials/gitops-snapshots.md similarity index 99% rename from content/en/cloud/tutorials/gitops-snapshots.md rename to content/en/cloud/guides/tutorials/gitops-snapshots.md index 19dfe609ad..2f4cd15433 100644 --- a/content/en/cloud/tutorials/gitops-snapshots.md +++ b/content/en/cloud/guides/tutorials/gitops-snapshots.md @@ -4,6 +4,9 @@ description: > Connect Kanvas to your GitHub repo and see changes pull request-to-pull request. category: GitOps weight: 4 +aliases: + - /cloud/tutorials/gitops-snapshots/ + - /cloud/guides/integrations/kanvas-snapshots/ --- Kanvas Snapshots offer visual insights in every pull request. Verify your workload designs and Kubernetes cluster configurations prior to accepting and merging pull requests. diff --git a/content/en/cloud/tutorials/images/embedding-badges-modal.svg b/content/en/cloud/guides/tutorials/images/embedding-badges-modal.svg similarity index 100% rename from content/en/cloud/tutorials/images/embedding-badges-modal.svg rename to content/en/cloud/guides/tutorials/images/embedding-badges-modal.svg diff --git a/content/en/cloud/tutorials/promoting-a-design.md b/content/en/cloud/guides/tutorials/promoting-a-design.md similarity index 85% rename from content/en/cloud/tutorials/promoting-a-design.md rename to content/en/cloud/guides/tutorials/promoting-a-design.md index e7d7bba233..e1cafe370c 100644 --- a/content/en/cloud/tutorials/promoting-a-design.md +++ b/content/en/cloud/guides/tutorials/promoting-a-design.md @@ -2,14 +2,18 @@ title: Promoting a Design from Staging to Prod description: > Learn how to move a design from a staging workspace to a production workspace, with environment assignment and access approval. -weight: 6 +weight: 2 categories: [Tutorials] tags: [designs, workspaces, environments] +aliases: + - /cloud/tutorials/promoting-a-design/ + - /cloud/guides/workspaces/promoting-a-design/ + --- -This tutorial walks through how Five promotes the `prod-deployment-v2` design from the `orbital-staging` workspace to `orbital-production`, with Zara Osei (Infrastructure Team Admin) approving the environment assignment. +This guide walks through how Five promotes the `prod-deployment-v2` design from the `orbital-staging` workspace to `orbital-production`, with Zara Osei (Infrastructure Team Admin) approving the environment assignment. -See [Meet Five and the Cast](/cloud/about) for the full Orbital Labs narrative reference. +See [Meet Five and the Cast](/cloud/getting-started/meet-five) for the full Orbital Labs narrative reference. ## Overview @@ -65,7 +69,7 @@ If your organization requires Team Admin approval before production deployments, 3. She clicks **Approve** — the deployment proceeds to `prod-aws`. {{< alert type="info" title="Why does Zara need to approve?" >}} -The Infrastructure team's keychain grants `orbital-production` workspace access and `prod-aws` environment deployment rights only to members who have been explicitly granted those keys. Zara, as Team Admin, holds the approval authority for production environment assignments. See [Keychains](/cloud/security/keychains/) for how this is configured. +The Infrastructure team's keychain grants `orbital-production` workspace access and `prod-aws` environment deployment rights only to members who have been explicitly granted those keys. Zara, as Team Admin, holds the approval authority for production environment assignments. See [Keychains](/cloud/concepts/identity-and-security/keychains/) for how this is configured. {{< /alert >}} ### Step 5 — Verify the deployment @@ -78,6 +82,6 @@ After approval: ## What's Next -- To give the Development team visibility into the production design (read-only), Five can share the design individually with Rex and Jordan. See [Sharing a Workspace](/cloud/tutorials/sharing-a-workspace/). +- To give the Development team visibility into the production design (read-only), Five can share the design individually with Rex and Jordan. See [Sharing a Workspace](/cloud/guides/tutorials/sharing-a-workspace/). - To set up a parallel deployment to `prod-gcp`, Five repeats Steps 3–5 selecting `prod-gcp` as the environment. - To roll back, Five transfers `prod-deployment-v2` back to `orbital-staging` and deploys the previous version from there. diff --git a/content/en/cloud/tutorials/sharing-a-workspace.md b/content/en/cloud/guides/tutorials/sharing-a-workspace.md similarity index 92% rename from content/en/cloud/tutorials/sharing-a-workspace.md rename to content/en/cloud/guides/tutorials/sharing-a-workspace.md index 495ba9544d..1eebdc90b9 100644 --- a/content/en/cloud/tutorials/sharing-a-workspace.md +++ b/content/en/cloud/guides/tutorials/sharing-a-workspace.md @@ -2,7 +2,13 @@ title: Sharing a Workspace description: > Learn how to control access to workspaces and their resources. -weight: 5 +weight: 1 +categories: [Tutorials] +tags: [workspaces, sharing, designs] +aliases: + - /cloud/tutorials/sharing-a-workspace/ + - /cloud/guides/workspaces/sharing-a-workspace/ + --- ## Share designs from Workspaces @@ -19,7 +25,7 @@ In your browser, go to [Layer5 Cloud](https://cloud.layer5.io). 4. Set the permission level — Five gives Rex **edit** access so he can deploy and modify the design. 5. Click **Send**. -![Flow for sharing designs](/cloud/catalog/images/Slide51.svg) +![Flow for sharing designs](/cloud/concepts/catalog/images/Slide51.svg) Rex receives an invitation and can now open `microservices-baseline` in the `orbital-dev` workspace. @@ -86,5 +92,5 @@ Someone you don't know might be viewing your design because: - Someone who can edit your design shared it further. {{< alert type="info" >}} -See [Meet Five and the Cast](/cloud/about) for the full Orbital Labs workspace and character reference. +See [Meet Five and the Cast](/cloud/getting-started/meet-five) for the full Orbital Labs workspace and character reference. {{< /alert >}} diff --git a/content/en/cloud/guides/workspaces/_index.md b/content/en/cloud/guides/workspaces/_index.md new file mode 100644 index 0000000000..7b5605dc2a --- /dev/null +++ b/content/en/cloud/guides/workspaces/_index.md @@ -0,0 +1,8 @@ +--- +title: Workspaces +description: Guides for creating, configuring, and managing Layer5 Cloud workspaces. +weight: 1 +categories: [Spaces] +--- + +Use these guides to manage workspace lifecycle, access, environments, designs, views, and activity in Layer5 Cloud. diff --git a/content/en/cloud/spaces/images/assign-designs-views.gif b/content/en/cloud/guides/workspaces/images/assign-designs-views.gif similarity index 100% rename from content/en/cloud/spaces/images/assign-designs-views.gif rename to content/en/cloud/guides/workspaces/images/assign-designs-views.gif diff --git a/content/en/cloud/spaces/images/assign-teams.gif b/content/en/cloud/guides/workspaces/images/assign-teams.gif similarity index 100% rename from content/en/cloud/spaces/images/assign-teams.gif rename to content/en/cloud/guides/workspaces/images/assign-teams.gif diff --git a/content/en/cloud/spaces/images/assign_environment.png b/content/en/cloud/guides/workspaces/images/assign_environment.png similarity index 100% rename from content/en/cloud/spaces/images/assign_environment.png rename to content/en/cloud/guides/workspaces/images/assign_environment.png diff --git a/content/en/cloud/spaces/images/create-workspace.gif b/content/en/cloud/guides/workspaces/images/create-workspace.gif similarity index 100% rename from content/en/cloud/spaces/images/create-workspace.gif rename to content/en/cloud/guides/workspaces/images/create-workspace.gif diff --git a/content/en/cloud/spaces/images/delete-workspace.gif b/content/en/cloud/guides/workspaces/images/delete-workspace.gif similarity index 100% rename from content/en/cloud/spaces/images/delete-workspace.gif rename to content/en/cloud/guides/workspaces/images/delete-workspace.gif diff --git a/content/en/cloud/spaces/images/edit-workspace.gif b/content/en/cloud/guides/workspaces/images/edit-workspace.gif similarity index 100% rename from content/en/cloud/spaces/images/edit-workspace.gif rename to content/en/cloud/guides/workspaces/images/edit-workspace.gif diff --git a/content/en/cloud/spaces/images/grid-view.png b/content/en/cloud/guides/workspaces/images/grid-view.png similarity index 100% rename from content/en/cloud/spaces/images/grid-view.png rename to content/en/cloud/guides/workspaces/images/grid-view.png diff --git a/content/en/cloud/spaces/images/security-audit.png b/content/en/cloud/guides/workspaces/images/security-audit.png similarity index 100% rename from content/en/cloud/spaces/images/security-audit.png rename to content/en/cloud/guides/workspaces/images/security-audit.png diff --git a/content/en/cloud/spaces/images/table-view.png b/content/en/cloud/guides/workspaces/images/table-view.png similarity index 100% rename from content/en/cloud/spaces/images/table-view.png rename to content/en/cloud/guides/workspaces/images/table-view.png diff --git a/content/en/cloud/spaces/managing-workspaces.md b/content/en/cloud/guides/workspaces/managing-workspaces.md similarity index 85% rename from content/en/cloud/spaces/managing-workspaces.md rename to content/en/cloud/guides/workspaces/managing-workspaces.md index ccbb9bfdd4..1c4f962319 100644 --- a/content/en/cloud/spaces/managing-workspaces.md +++ b/content/en/cloud/guides/workspaces/managing-workspaces.md @@ -1,13 +1,17 @@ --- title: Managing Workspaces description: "Learn how to create, edit, delete, and configure your Workspaces." -weight: 7 +weight: 1 categories: [Spaces] +aliases: + - /cloud/spaces/managing-workspaces/ + - /cloud/concepts/spaces/managing-workspaces/ + --- This guide walks you through the practical steps of managing your Workspaces. Here, you'll learn how to create, edit, and delete Workspaces, as well as how to manage access by assigning teams and resources like Environments, Designs, and Views to them. -If you're new to the concept of Workspaces, we recommend starting with the [Workspaces Overview](/cloud/spaces/workspaces/) to understand what a Workspace is and how it relates to key components like Environments, Designs, and Teams. +If you're new to the concept of Workspaces, we recommend starting with the [Workspaces Overview](/cloud/concepts/spaces/workspaces/) to understand what a Workspace is and how it relates to key components like Environments, Designs, and Teams. {{< alert type="info" title="A Note on Permissions" >}} Every action described in this guide is governed by roles and permissions. To see a detailed breakdown of what your assigned role allows you to do, please refer to the [Default Permissions](/cloud/reference/default-permissions/) documentation. @@ -21,14 +25,14 @@ The [Workspaces page](https://cloud.layer5.io/spaces/workspaces) is where you ca #### Grid View The grid view offers a card-based layout, perfect for quickly identifying workspaces at a glance. Each card displays essential information, and you can flip it to reveal management options like editing or deleting and get audit history. -![Grid view of workspaces showing card-based layout](/cloud/spaces/images/grid-view.png) +![Grid view of workspaces showing card-based layout](/cloud/guides/workspaces/images/grid-view.png) #### Table View The table view provides a dense, list-based format that is ideal for managing a large number of workspaces. This view allows for sorting and gives you more control over the specific details you see. To customize the information displayed, click the **View Columns** icon and select the attributes you want to see, such as Owner ID or Created Date. -![Table view of workspaces showing list-based format with sorting options](/cloud/spaces/images/table-view.png) +![Table view of workspaces showing list-based format with sorting options](/cloud/guides/workspaces/images/table-view.png) {{< alert type="info" title="Consistent Actions Across Views" >}} Both the grid and table views provide the same set of management capabilities. You can choose the layout that best fits your needs without losing any functionality. @@ -49,7 +53,7 @@ To create a workspace: 3. Enter a descriptive **Name** and an optional **Description**, then click **Save**. 4. Your new workspace will now appear on the page. -![Animation showing workspace creation process](/cloud/spaces/images/create-workspace.gif) +![Animation showing workspace creation process](/cloud/guides/workspaces/images/create-workspace.gif) ### Edit a Workspace @@ -58,7 +62,7 @@ You can modify a workspace's name and description at any time after it has been - **From the Grid View:** Flip the workspace card, then click the **pencil icon**. - **From the Table View:** Click the **pencil icon** in the row of the workspace you wish to modify. -![Animation showing workspace editing process](/cloud/spaces/images/edit-workspace.gif) +![Animation showing workspace editing process](/cloud/guides/workspaces/images/edit-workspace.gif) ### Delete a Workspace @@ -74,7 +78,7 @@ You can delete a single workspace or multiple workspaces at once. 1. Select the checkboxes on the cards of the workspaces you want to delete. 2. Click the **Delete** button that appears at the top of the page. -![Animation showing workspace deletion process](/cloud/spaces/images/delete-workspace.gif) +![Animation showing workspace deletion process](/cloud/guides/workspaces/images/delete-workspace.gif) {{< alert type="info" title="Deletion Restrictions" >}} Meshery requires at least one workspace to exist within an organization at all times, so you cannot delete the last remaining workspace. @@ -96,7 +100,7 @@ When a Workspace is deleted: ### Assign Teams to a Workspace Assigning teams is the way you grant users access to a workspace. Once a team is assigned, its members can access all of the Designs, Views, and Environments linked to that workspace. -![Animation showing team assignment process](/cloud/spaces/images/assign-teams.gif) +![Animation showing team assignment process](/cloud/guides/workspaces/images/assign-teams.gif) You can open the team management Dialog from either the grid or table view. @@ -114,14 +118,14 @@ Inside the assignment Dialog, you will see two lists: **Available Teams** on the 3. Click **Save** to apply your changes. {{< alert type="info" title="Team and Workspace Relationships" >}} -You can assign multiple teams to a single workspace, and a single team can also be a member of multiple workspaces. This provides flexible access control across your projects. For more restrictions, see [Workspaces documentation](/cloud/spaces/workspaces/). +You can assign multiple teams to a single workspace, and a single team can also be a member of multiple workspaces. This provides flexible access control across your projects. For more restrictions, see [Workspaces documentation](/cloud/concepts/spaces/workspaces/). {{< /alert >}} ### Link Environments to a Workspace -When you link an [Environment](/cloud/spaces/environments/) to a Workspace, you make all the connections (like those to Kubernetes clusters or databases) grouped within that Environment available. This means any team members with access to that Workspace can then deploy their applications or configurations to the resources. +When you link an [Environment](/cloud/concepts/spaces/environments/) to a Workspace, you make all the connections (like those to Kubernetes clusters or databases) grouped within that Environment available. This means any team members with access to that Workspace can then deploy their applications or configurations to the resources. The process of linking environments is almost the same as assigning teams. -![Animation showing environment assignment process](/cloud/spaces/images/assign_environment.png) +![Animation showing environment assignment process](/cloud/guides/workspaces/images/assign_environment.png) {{< alert type="info" title="Many-to-Many Relationship" >}} An Environment can be linked to multiple Workspaces, and a Workspace can have multiple Environments. This allows you to share common environments across different projects. @@ -140,17 +144,17 @@ When you create a new Design, it is automatically added to your current Workspac 3. Use the arrow buttons to move the selected Design(s) or View(s) to the target workspace. 4. Click **Save**. -![Animation showing design and view assignment process](/cloud/spaces/images/assign-designs-views.gif) +![Animation showing design and view assignment process](/cloud/guides/workspaces/images/assign-designs-views.gif) {{< alert type="info" title="Exclusive Ownership" >}} -A Design or View can only exist in one Workspace at a time. Moving it to a new Workspace will automatically remove it from its original location. For more detailed information, see [Workspaces documentation](/cloud/spaces/workspaces/). +A Design or View can only exist in one Workspace at a time. Moving it to a new Workspace will automatically remove it from its original location. For more detailed information, see [Workspaces documentation](/cloud/concepts/spaces/workspaces/). {{< /alert >}} ### View Recent Activity Meshery keeps a detailed audit log for each workspace, allowing you to track all significant events. This is useful for maintaining security and troubleshooting issues. -![Workspace audit log showing recent activity](/cloud/spaces/images/security-audit.png) +![Workspace audit log showing recent activity](/cloud/guides/workspaces/images/security-audit.png) The activity log captures a variety of events, including: - The creation or deletion of the workspace. @@ -180,7 +184,7 @@ Think of a private workspace as your personal Google "My Drive." You can use it **3. Template Library** Create a separate, access-controlled Workspace to serve as your organization's internal, private template library. This is for storing non-public, organization-specific, or sensitive patterns. -> This practice complements the [public Catalog](/cloud/catalog/exploring-the-catalog/), which is used for sharing generic, non-sensitive designs with the community. A dedicated Organization Catalog feature is also planned for the future. +> This practice complements the [public Catalog](/cloud/concepts/catalog/exploring-the-catalog/), which is used for sharing generic, non-sensitive designs with the community. A dedicated Organization Catalog feature is also planned for the future. **4. The Team Space** @@ -198,7 +202,7 @@ For teams requiring strict separation between environments, this pattern is esse - **Access**: Access to the Design is determined by the Teams assigned to its new Workspace. - **Cross-Organization Transfers**: You can move a Design you own into a Workspace in a different Organization, provided you have the necessary permissions in the target Organization. -> A key restriction is that a user, even with a [Workspace Admin](/cloud/security/roles/workspace-roles/) role, cannot manage a Design they **do not own**. This action requires [Organization Admin](/cloud/security/roles/organization-roles/) or Organization Owner permissions. +> A key restriction is that a user, even with a [Workspace Admin](/cloud/concepts/identity-and-security/roles/workspace-roles/) role, cannot manage a Design they **do not own**. This action requires [Organization Admin](/cloud/concepts/identity-and-security/roles/organization-roles/) or Organization Owner permissions. #### 2. What can other users of a Workspace do with my design? Can they delete my design? @@ -236,4 +240,4 @@ To share a design exclusively with a select group: This grants members of the assigned Team exclusive access and the permission to edit the design. -[^1]: This functionality is not fully implemented yet. Users might occasionally observe that designs and views are preserved after Workspace deletion. \ No newline at end of file +[^1]: This functionality is not fully implemented yet. Users might occasionally observe that designs and views are preserved after Workspace deletion. diff --git a/content/en/cloud/identity/_index.md b/content/en/cloud/identity/_index.md deleted file mode 100755 index cd6a8bc534..0000000000 --- a/content/en/cloud/identity/_index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Identity -description: > - Organizations, Teams, Users -weight: 3 -categories: [Identity] ---- - -Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. The identity structure is highly flexible: organizations can have any number of teams, teams can have any number of users, and users can belong to any number of teams and organizations. - -Below is an overview of the core identity components within the Layer5 Cloud. - -## [Organizations](organizations) -Organizations serve as the fundamental component of multi-tenancy within the Layer5 Cloud. - -They act as the top-level parent entity. All users and teams ultimately roll up to an organization. While Free plan users are limited to a single default organization, enterprise environments can leverage organizations to strictly isolate resources, billing, and access control across entirely different business units. - -## [Teams](teams) -Outside of grouping users together, teams offer controlled access to workspaces and to workspace resources such as environments and managed and unmanaged connections. - -Administrators can create teams as child units below the top-level organization. This allows you to apply unique settings, permissions, and workspace access to a specific set of users without altering the parent organization's settings. - -## [Users](users) -Each user account represents an individual collaborator. Individual user accounts exist beyond the bounds of organizations. - -Anyone who uses Layer5 Cloud signs into a user account, which acts as your sovereign identity. Your user account can independently own resources such as workspaces, designs, connections, and tokens. Any action taken on the platform—such as creating a design or reviewing a deployment request—is directly attributed to your individual user account, regardless of which teams or organizations you belong to. diff --git a/content/en/cloud/overview/_index.md b/content/en/cloud/overview/_index.md deleted file mode 100644 index 5c93521550..0000000000 --- a/content/en/cloud/overview/_index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Overview -description: Learn how Layer5 Cloud centralizes management, visualization, and collaboration for your multi-cloud infrastructure. -weight: 1 -categories: [Reference, Cloud] -tags: [Cloud, Architecture, Governance] -draft: false ---- - -{{% pageinfo %}} -Layer5 Cloud is the control plane for your cloud-native infrastructure, providing deep insights and collaborative management across all your clusters. -{{% /pageinfo %}} - -## What is Layer5 Cloud? - -Layer5 Cloud serves as the centralized management console and identity provider for the Layer5 ecosystem, specifically for **Kanvas** and **Meshery** deployments. It provides an extensible authorization framework that allows organizations to manage complex infrastructure with confidence. - -## Why use Layer5 Cloud? - -* **Collaborative Design**: Similar to Google Workspace or Figma, multiple team members can design and review infrastructure patterns in real-time. -* **Unified Identity**: Manage organizations, teams, and users with granular Role-Based Access Control (RBAC). -* **Content Catalog**: Host and share cloud-native patterns publicly or keep them private within your organization. - -## Next Steps - -* [**Identity**](/cloud/identity): Learn about Organizations, Teams, and Users. -* [**Security**](/cloud/security): Understand tokens, keychains, and permissions. diff --git a/content/en/cloud/reference/_index.md b/content/en/cloud/reference/_index.md index 27468d718d..e2fddca16d 100644 --- a/content/en/cloud/reference/_index.md +++ b/content/en/cloud/reference/_index.md @@ -1,7 +1,7 @@ --- title: Reference description: References for using Layer5 Cloud’s various features and components. -weight: 20 +weight: 5 categories: [Reference] tags: [extensibility] --- diff --git a/content/en/cloud/reference/api-reference/_index.md b/content/en/cloud/reference/api-reference/_index.md index 98556bdaa4..3c24e1de22 100644 --- a/content/en/cloud/reference/api-reference/_index.md +++ b/content/en/cloud/reference/api-reference/_index.md @@ -153,7 +153,7 @@ The following example demonstrate how to retrieve information from the Academy R ### Get the total number of registered learners in Academy -Use the Layer5 Cloud API to retrieve the *total* number of registered learners. Pass your [Security Token](https://docs.layer5.io/cloud/security/tokens/) as a Bearer token in the `Authorization` header (as shown in [Authenticating with API](/cloud/reference/api-reference/#authenticating-with-the-api)). The response JSON includes an array of user objects. +Use the Layer5 Cloud API to retrieve the *total* number of registered learners. Pass your [Security Token](https://docs.layer5.io/cloud/concepts/identity-and-security/tokens/) as a Bearer token in the `Authorization` header (as shown in [Authenticating with API](/cloud/reference/api-reference/#authenticating-with-the-api)). The response JSON includes an array of user objects. {{< tabpane >}} @@ -251,4 +251,3 @@ This returns the number of Total registered learners: 130 ``` - diff --git a/content/en/cloud/reference/default-permissions.md b/content/en/cloud/reference/default-permissions.md index 5046f79b35..2ca694b610 100644 --- a/content/en/cloud/reference/default-permissions.md +++ b/content/en/cloud/reference/default-permissions.md @@ -6,7 +6,7 @@ categories: [Identity] tags: [perms] --- -{{< alert title="Customizable Permissions" type="info" >}}Default permissions can be easily customized by simply creating your own [keychains](/cloud/security/keychains/#keychains-management) and [roles](/cloud/security/roles).{{< /alert >}} +{{< alert title="Customizable Permissions" type="info" >}}Default permissions can be easily customized by simply creating your own [keychains](/cloud/concepts/identity-and-security/keychains/#keychains-management) and [roles](/cloud/concepts/identity-and-security/roles).{{< /alert >}} **Legend:** diff --git a/content/en/cloud/security/_index.md b/content/en/cloud/security/_index.md deleted file mode 100755 index 6391473bf2..0000000000 --- a/content/en/cloud/security/_index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Security -description: Manage identity and access through Tokens, Keychains, Keys, and RBAC Roles. -weight: 4 -draft: false -categories: [Security] -tags: [permissions, identity, authentication] ---- -Layer5 Cloud provides a multi-tenant security model designed to manage access across complex organizational structures. This section covers the core components of our Identity and Access Management (IAM) system. - -## Security Architecture - -The following diagram illustrates the relationship between Organizational Units, Roles, and the underlying Permissions: - -![permission](/cloud/security/images/permissions.svg "image-center-shadow") - ---- - -## Organizational Units -Layer5 Cloud uses a hierarchical structure to isolate resources and manage users at scale: -* **Provider Organizations:** The top-level entity that can manage multiple tenant organizations. -* **Tenant Organizations:** Individual customer or project-specific organizations (e.g., Layer5, Intel). -* **Teams:** Logical groupings of users within an organization to facilitate collaborative management. -* **Users:** Individual accounts that are members of teams and organizations. - -## Roles and Access Control -Access is granted through Role-Based Access Control (RBAC). Roles are assigned at different levels of the organizational hierarchy: -* **Organization Administrators:** Full control over an entire tenant organization. -* **Organization Billing Managers:** Access restricted to subscription and financial management. -* **Team Administrators:** Management of specific team resources and memberships. - -## Key Management and Tokens -Beyond structural roles, Layer5 Cloud uses cryptographic and session-based security: - -### Keychains -Keychains are collections of keys used to manage environment-specific access and signing. They allow for the logical grouping of related security credentials. - -### Keys -Keys are the atomic unit of access control within the system. They are used for secure communication between Meshery and Layer5 Cloud, as well as for signing design patterns. - -### Tokens -Tokens provide temporary, secure access to the platform. -* **Session Tokens:** Used for web browser authentication. -* **Personal Access Tokens (PATs):** Used for programmatic access via CLI or CI/CD pipelines. - ---- - -### Need more detail? -Check out the [Roles Reference](/docs/security/roles) for a complete matrix of permissions for each role. diff --git a/content/en/kanvas/advanced/performance/index.md b/content/en/kanvas/advanced/performance/index.md index b5faa6a8d3..2a0e3ef1fd 100644 --- a/content/en/kanvas/advanced/performance/index.md +++ b/content/en/kanvas/advanced/performance/index.md @@ -55,7 +55,7 @@ Upon loading a design exceeds that exceeds 20 tags within a single design, Kanva ### Maximum Number of Users -Under the Free [subscription plan](https://layer5.io/pricing), Kanvas supports at least 20 users per design. As resources allow, up to 34 users may simultaneously collaborate within a given design. If you have a large team collaborating on a design, be mindful of the number of users active at the same time. Too many users can strain the performance of your design, leading to slower response times and potential data loss. See [Layer5 Cloud Networking Services](/cloud/self-hosted/planning/peer-to-peer-communication) for more details. +Under the Free [subscription plan](https://layer5.io/pricing), Kanvas supports at least 20 users per design. As resources allow, up to 34 users may simultaneously collaborate within a given design. If you have a large team collaborating on a design, be mindful of the number of users active at the same time. Too many users can strain the performance of your design, leading to slower response times and potential data loss. See [Layer5 Cloud Networking Services](/cloud/guides/self-hosted/planning/peer-to-peer-communication) for more details. ### Impact of Images diff --git a/content/en/kanvas/designer/_index.md b/content/en/kanvas/designer/_index.md index a4f21a69d8..54ee85c51d 100644 --- a/content/en/kanvas/designer/_index.md +++ b/content/en/kanvas/designer/_index.md @@ -28,5 +28,5 @@ Rex opens `api-platform-aws` in Kanvas Designer and traces the connection paths Jordan sees the notification and comes back to the canvas. They hash it out in the comment thread, land on the ALB approach, and Jordan draws a new connection representing the internal Application Load Balancer sitting between Lambda and the cluster's service mesh entry point. The design updates in place — no version-named duplicates, no stale exported images — and Rex can reload and see the revised architecture immediately. {{< alert type="info" title="Meet the team" >}} -Meet Jordan, Rex, and the rest of the Orbital Labs team in [Meet Five and the Cast](/cloud/about). +Meet Jordan, Rex, and the rest of the Orbital Labs team in [Meet Five and the Cast](/cloud/getting-started/meet-five). {{< /alert >}} diff --git a/content/en/kanvas/designer/comments/index.md b/content/en/kanvas/designer/comments/index.md index 6bf70b4af9..b47f956b05 100644 --- a/content/en/kanvas/designer/comments/index.md +++ b/content/en/kanvas/designer/comments/index.md @@ -209,7 +209,7 @@ Collaborators (users you have shared the design with) do not receive notificatio ### Enable Email Notifications -Customize your [notification preferences](/cloud/identity/users/notification-preferences) to receive emails for comments on your design. When this is enabled, you'll be notified when comments are made on your design, you're mentioned in a comment, or someone adds a comment to a thread you've previously engaged with. +Customize your [notification preferences](/cloud/concepts/identity-and-security/users/notification-preferences) to receive emails for comments on your design. When this is enabled, you'll be notified when comments are made on your design, you're mentioned in a comment, or someone adds a comment to a thread you've previously engaged with. ### Muting Comment Notifications @@ -224,7 +224,7 @@ Customize your notification preferences to mute email notifications for comments Muting a comment thread applies only to participants in that thread. Design owners continue to receive notifications for all activity within their design regardless of thread-level muting. {{< /alert >}} -You can also manage all your comment notification settings centrally through the **Cloud -> Account -> [Preference](https://docs.layer5.io/cloud/identity/users/notification-preferences/)**. +You can also manage all your comment notification settings centrally through the **Cloud -> Account -> [Preference](https://docs.layer5.io/cloud/concepts/identity-and-security/users/notification-preferences/)**.
Manage comment notifications in the Cloud Portal diff --git a/content/en/kanvas/designer/publishing-designs/index.md b/content/en/kanvas/designer/publishing-designs/index.md index fecd06e809..eec5f13597 100644 --- a/content/en/kanvas/designer/publishing-designs/index.md +++ b/content/en/kanvas/designer/publishing-designs/index.md @@ -97,7 +97,7 @@ A design transitions through multiple states from creation to publication. The d | Submit for Review | ✔ | ✔ | ✔ | ✔ | ✔ | | Unpublish | ✘ | ✘ | ✔ | ✔ | ✔ | -For more about roles and permissions, refer to [Role Descriptions](https://docs.layer5.io/cloud/security/roles/) and [Default Permissions](https://docs.layer5.io/cloud/reference/default-permissions/). +For more about roles and permissions, refer to [Role Descriptions](https://docs.layer5.io/cloud/concepts/identity-and-security/roles/) and [Default Permissions](https://docs.layer5.io/cloud/reference/default-permissions/). **Key Notes:** - Provider Admins have root-level visibility and can see private designs from all organizations. @@ -126,4 +126,4 @@ Only Admins and Owner can unpublish designs. Regular users and guests cannot per |-------------|---------------|----------------|-----------| | **Public** | Visible to all Meshery Cloud users | Fully editable | Available for all users to access | | **Private** | Only visible to the owner and organization members | Fully editable | Used for drafts and internal work | -| **Published** | Approved and locked for public access | Cannot be modified | Ensures design consistency and prevents unauthorized edits | \ No newline at end of file +| **Published** | Approved and locked for public access | Cannot be modified | Ensures design consistency and prevents unauthorized edits | diff --git a/content/en/kanvas/designer/sharing/index.md b/content/en/kanvas/designer/sharing/index.md index 829bdbe9ab..5d3d29d036 100644 --- a/content/en/kanvas/designer/sharing/index.md +++ b/content/en/kanvas/designer/sharing/index.md @@ -27,7 +27,7 @@ Designs have visibility statuses that defines who can access your designs. These Public status is useful for sharing designs broadly, for example, as open-source templates, public demonstrations, or for soliciting feedback from a wider community. If your goal is to share broadly only within your organization, consider using a combination of private designs shared with specific organization-wide teams or workspaces. {{< /alert >}} -- **Published:** The published visibility setting is designed for sharing designs with a wider audience. Published designs become discoverable to other users and allow them to view, download, and clone the design. Users can find published designs through [Cloud Catalog](/cloud/catalog) ([open catalog](https://cloud.layer5.io/catalog)). +- **Published:** The published visibility setting is designed for sharing designs with a wider audience. Published designs become discoverable to other users and allow them to view, download, and clone the design. Users can find published designs through [Cloud Catalog](/cloud/concepts/catalog) ([open catalog](https://cloud.layer5.io/catalog)). ## Granting access to individual users @@ -94,7 +94,7 @@ As the Owner of a design, you can manage who has access to it at any time using {{< alert title="Implications of adding a Design to a Workspace">}} When you add design to a workspace, it signifies that all teams associated with that workspace will be allowed to access your designs even if it is private. Review your workspace's team assignments in order to verify which users will be granted access. -Learn more about [auditing and assigning Workspace access](/cloud/spaces/workspaces/). +Learn more about [auditing and assigning Workspace access](/cloud/concepts/spaces/workspaces/). {{< /alert >}} ## Sharing Your Design with a Link @@ -128,7 +128,7 @@ There are two primary ways to share designs with teams: 2. Assign one or more Teams to that same Workspace. 3. By this association, members of the assigned Team(s) should then inherit access to the **designs** within that Workspace, including Private designs. -> Learn more about auditing the access permission within [workspace](/cloud/spaces/workspaces/) +> Learn more about auditing the access permission within [workspace](/cloud/concepts/spaces/workspaces/) [^1]: This functionality is not fully implemented yet. Users might occasionally observe that even when a team is assigned to a workspace, members of that team may not be able to access private designs within that workspace without explicit individual or team-level sharing for the design itself. [^2]: This feature (direct sharing with teams via the "Share" modal) is not yet fully implemented and is planned for a future update. \ No newline at end of file diff --git a/content/en/kanvas/getting-started/_index.md b/content/en/kanvas/getting-started/_index.md index 2a7b563876..8397fd8431 100644 --- a/content/en/kanvas/getting-started/_index.md +++ b/content/en/kanvas/getting-started/_index.md @@ -9,7 +9,7 @@ aliases: --- {{< alert type="info" title="Follow Along with Jordan and Five" >}} -Throughout the Kanvas docs, you'll follow **Jordan Reyes** — a developer and designer at Orbital Labs — as she creates, shares, and iterates on infrastructure designs. **Five** reviews her work and occasionally discovers that a design works better in practice than it does in theory. Their starting point is the `microservices-baseline` design in the `orbital-dev` workspace. [Meet the full cast →](/cloud/about) +Throughout the Kanvas docs, you'll follow **Jordan Reyes** — a developer and designer at Orbital Labs — as she creates, shares, and iterates on infrastructure designs. **Five** reviews her work and occasionally discovers that a design works better in practice than it does in theory. Their starting point is the `microservices-baseline` design in the `orbital-dev` workspace. [Meet the full cast →](/cloud/getting-started/meet-five) {{< /alert >}} ## Use Kanvas for your Diagrams diff --git a/content/en/kanvas/tutorials/_index.md b/content/en/kanvas/tutorials/_index.md index 9fe9869151..e5db7a2967 100755 --- a/content/en/kanvas/tutorials/_index.md +++ b/content/en/kanvas/tutorials/_index.md @@ -10,5 +10,5 @@ aliases: Kanvas tutorials walk through real-world design scenarios using two fictional organizations — Orbital Labs, a cloud-native startup on the Team plan, and Stellar Dynamics, their enterprise client on the Enterprise plan — both managed under the Constellation Cloud provider. Each tutorial follows a cast of named characters as they build, share, and collaborate on infrastructure designs, so you can see how Kanvas permissions, workspaces, environments, and cross-org access work together in practice. {{< alert type="info" >}} -Meet Five, Maya, Zara, Marcus, Dr. Aiko, and the full cast at [Meet Five and the Cast](/cloud/about). +Meet Five, Maya, Zara, Marcus, Dr. Aiko, and the full cast at [Meet Five and the Cast](/cloud/getting-started/meet-five). {{< /alert >}} diff --git a/content/en/kanvas/tutorials/data-pipeline-gcp.md b/content/en/kanvas/tutorials/data-pipeline-gcp.md index b77ad2dcac..d89c547790 100644 --- a/content/en/kanvas/tutorials/data-pipeline-gcp.md +++ b/content/en/kanvas/tutorials/data-pipeline-gcp.md @@ -81,5 +81,5 @@ Five receives an in-app notification. When he opens the design, he can see all f The `data-pipeline-gcp` design is now live in `orbital-production`, connected to real infrastructure, and ready for collaborative review. {{< alert type="info" >}} -Meet Zara and the rest of the team at [Meet Five and the Cast](/cloud/about). +Meet Zara and the rest of the team at [Meet Five and the Cast](/cloud/getting-started/meet-five). {{< /alert >}} diff --git a/content/en/kanvas/tutorials/stellar-saas-platform.md b/content/en/kanvas/tutorials/stellar-saas-platform.md index a2005c37fb..77cac17452 100644 --- a/content/en/kanvas/tutorials/stellar-saas-platform.md +++ b/content/en/kanvas/tutorials/stellar-saas-platform.md @@ -73,7 +73,7 @@ Marcus opens the **Share** panel on `stellar-saas-platform`. He types Five's nam Marcus clicks **Share**. Five receives an in-app notification in his Orbital Labs account. {{< alert type="info" title="Cross-Org Access" >}} -Cross-organization design sharing requires that both organizations exist under a shared Provider (Constellation Cloud in this scenario). The Provider Admin (Dr. Aiko Sato) must have configured cross-org permissions before sharing can occur. See [Roles and Keychains](/cloud/security/roles/) for the permission model. +Cross-organization design sharing requires that both organizations exist under a shared Provider (Constellation Cloud in this scenario). The Provider Admin (Dr. Aiko Sato) must have configured cross-org permissions before sharing can occur. See [Roles and Keychains](/cloud/concepts/identity-and-security/roles/) for the permission model. {{< /alert >}} ### Step 6: Five reviews the design from Orbital Labs @@ -101,5 +101,5 @@ Marcus resolves Five's WAF comment and replies: "Added Application Gateway (WAF The `stellar-saas-platform` design now reflects the correct architecture, the review loop is documented in the comment history, and the cross-org collaboration happened entirely within Kanvas — no design files exported, no screenshots emailed. {{< alert type="info" >}} -Meet Marcus, Five, Dr. Aiko, and the rest of the cast at [Meet Five and the Cast](/cloud/about). +Meet Marcus, Five, Dr. Aiko, and the rest of the cast at [Meet Five and the Cast](/cloud/getting-started/meet-five). {{< /alert >}} diff --git a/docs/superpowers/plans/2026-04-28-five-narrative.md b/docs/superpowers/plans/2026-04-28-five-narrative.md index c4579ac447..7dd1071eed 100644 --- a/docs/superpowers/plans/2026-04-28-five-narrative.md +++ b/docs/superpowers/plans/2026-04-28-five-narrative.md @@ -4,7 +4,7 @@ **Goal:** Establish a continuous narrative in Layer5 Cloud docs built around Five (the mascot) and a cast of six fictional characters across three fictional organizations, with a companion research plan page and 12 filed follow-up GitHub issues. -**Architecture:** A dedicated `/cloud/about/` Hugo section hosts the canonical narrative page (`_index.md`) and research plan (`five-narrative-plan.md`). Five SVG assets are copied from the `layer5` repo into `docs/static/images/five/`. The Getting Started index gets a short intro paragraph linking to `/cloud/about`. No new Hugo shortcodes are needed — the existing `{{< cardpane >}}`, `{{% card %}}`, and `{{< alert >}}` shortcodes cover all layout needs. +**Architecture:** A dedicated `/cloud/getting-started/meet-five/` Hugo section hosts the canonical narrative page (`_index.md`) and research plan (`five-narrative-plan.md`). Five SVG assets are copied from the `layer5` repo into `docs/static/images/five/`. The Getting Started index gets a short intro paragraph linking to `/cloud/getting-started/meet-five`. No new Hugo shortcodes are needed — the existing `{{< cardpane >}}`, `{{% card %}}`, and `{{< alert >}}` shortcodes cover all layout needs. **Tech Stack:** Hugo (static site generator), Markdown, Hugo shortcodes (`cardpane`, `card`, `alert`), GitHub CLI (`gh`) for filing issues. @@ -21,9 +21,9 @@ | Copy | `static/images/five/1.svg` through `19.svg` | Character profile illustrations | | Copy | `static/images/five/resources-sign.svg` | Sidebar/callout illustration | | Copy | `static/images/five/stick-figures.svg` | Team overview illustration | -| Create | `content/en/cloud/about/_index.md` | Narrative + cast reference page | -| Create | `content/en/cloud/about/five-narrative-plan.md` | Research plan / integration roadmap | -| Modify | `content/en/cloud/getting-started/_index.md` | Add intro paragraph + link to /cloud/about | +| Create | `content/en/cloud/getting-started/meet-five/_index.md` | Narrative + cast reference page | +| Create | `content/en/cloud/getting-started/meet-five/five-narrative-plan.md` | Research plan / integration roadmap | +| Modify | `content/en/cloud/getting-started/_index.md` | Add intro paragraph + link to /cloud/getting-started/meet-five | --- @@ -84,11 +84,11 @@ git commit -s -m "[Docs] Add Five mascot SVG assets from layer5 repo" ## Task 2: Create the About Section Skeleton **Files:** -- Create: `content/en/cloud/about/_index.md` +- Create: `content/en/cloud/getting-started/meet-five/_index.md` - [ ] **Step 1: Create the directory and skeleton file** -Create `content/en/cloud/about/_index.md` with this exact content: +Create `content/en/cloud/getting-started/meet-five/_index.md` with this exact content: ```markdown --- @@ -125,8 +125,8 @@ Expected: `Build clean` (no errors or warnings related to the new file) - [ ] **Step 3: Commit** ```bash -git add content/en/cloud/about/_index.md -git commit -s -m "[Docs] Add cloud/about section skeleton for Five narrative" +git add content/en/cloud/getting-started/meet-five/_index.md +git commit -s -m "[Docs] Add cloud/getting-started/meet-five section skeleton for Five narrative" ``` --- @@ -134,7 +134,7 @@ git commit -s -m "[Docs] Add cloud/about section skeleton for Five narrative" ## Task 3: Write the Origin Story **Files:** -- Modify: `content/en/cloud/about/_index.md` +- Modify: `content/en/cloud/getting-started/meet-five/_index.md` - [ ] **Step 1: Replace the origin story comment with the prose** @@ -160,8 +160,8 @@ Expected: `Build clean` - [ ] **Step 3: Commit** ```bash -git add content/en/cloud/about/_index.md -git commit -s -m "[Docs] Add Five narrative origin story to cloud/about" +git add content/en/cloud/getting-started/meet-five/_index.md +git commit -s -m "[Docs] Add Five narrative origin story to cloud/getting-started/meet-five" ``` --- @@ -169,7 +169,7 @@ git commit -s -m "[Docs] Add Five narrative origin story to cloud/about" ## Task 4: Write the Organizations Section **Files:** -- Modify: `content/en/cloud/about/_index.md` +- Modify: `content/en/cloud/getting-started/meet-five/_index.md` - [ ] **Step 1: Replace the organizations comment with this content** @@ -215,7 +215,7 @@ Expected: `Build clean` - [ ] **Step 3: Commit** ```bash -git add content/en/cloud/about/_index.md +git add content/en/cloud/getting-started/meet-five/_index.md git commit -s -m "[Docs] Add Organizations section to Five narrative page" ``` @@ -224,7 +224,7 @@ git commit -s -m "[Docs] Add Organizations section to Five narrative page" ## Task 5: Write the Cast Section **Files:** -- Modify: `content/en/cloud/about/_index.md` +- Modify: `content/en/cloud/getting-started/meet-five/_index.md` - [ ] **Step 1: Replace the cast comment with this content** @@ -327,7 +327,7 @@ Expected: `Build clean` - [ ] **Step 3: Commit** ```bash -git add content/en/cloud/about/_index.md +git add content/en/cloud/getting-started/meet-five/_index.md git commit -s -m "[Docs] Add Cast section to Five narrative page" ``` @@ -336,7 +336,7 @@ git commit -s -m "[Docs] Add Cast section to Five narrative page" ## Task 6: Write the Hierarchy Table and Seed Inventory **Files:** -- Modify: `content/en/cloud/about/_index.md` +- Modify: `content/en/cloud/getting-started/meet-five/_index.md` - [ ] **Step 1: Replace the hierarchy comment with this content** @@ -406,7 +406,7 @@ Expected: `Build clean` - [ ] **Step 4: Commit** ```bash -git add content/en/cloud/about/_index.md +git add content/en/cloud/getting-started/meet-five/_index.md git commit -s -m "[Docs] Add hierarchy table and seed inventory to Five narrative page" ``` @@ -415,7 +415,7 @@ git commit -s -m "[Docs] Add hierarchy table and seed inventory to Five narrativ ## Task 7: Write the "Using This Narrative" Callout and Finalize Narrative Page **Files:** -- Modify: `content/en/cloud/about/_index.md` +- Modify: `content/en/cloud/getting-started/meet-five/_index.md` - [ ] **Step 1: Replace the callout comment with this content** @@ -440,7 +440,7 @@ hugo --quiet 2>&1 | grep -i "error\|warn" || echo "Build clean" Expected: `Build clean` -Then run `make site` and open `http://localhost:1313/cloud/about/` in a browser. Verify: +Then run `make site` and open `http://localhost:1313/cloud/getting-started/meet-five/` in a browser. Verify: - Page appears in the left sidebar under Cloud - Origin story prose renders - Three org cards render side-by-side @@ -451,7 +451,7 @@ Then run `make site` and open `http://localhost:1313/cloud/about/` in a browser. - [ ] **Step 3: Commit** ```bash -git add content/en/cloud/about/_index.md +git add content/en/cloud/getting-started/meet-five/_index.md git commit -s -m "[Docs] Complete Five narrative page with Using This Narrative callout" ``` @@ -460,7 +460,7 @@ git commit -s -m "[Docs] Complete Five narrative page with Using This Narrative ## Task 8: Create the Research Plan Page **Files:** -- Create: `content/en/cloud/about/five-narrative-plan.md` +- Create: `content/en/cloud/getting-started/meet-five/five-narrative-plan.md` - [ ] **Step 1: Create the research plan file with this exact content** @@ -545,7 +545,7 @@ When capturing screenshots for any section that references the Five narrative, f ## Priority Order ### Ship with this PR -- `cloud/getting-started` — add intro paragraph + link to `/cloud/about` (see Task 10 of the implementation plan) +- `cloud/getting-started` — add intro paragraph + link to `/cloud/getting-started/meet-five` (see Task 10 of the implementation plan) ### Next Sprint — Batch 1: Identity (Low difficulty) 1. `cloud/identity/users` — Five's profile card @@ -577,12 +577,12 @@ hugo --quiet 2>&1 | grep -i "error\|warn" || echo "Build clean" Expected: `Build clean` -Then verify `http://localhost:1313/cloud/about/five-narrative-plan/` renders and the integration map table is readable. +Then verify `http://localhost:1313/cloud/getting-started/meet-five/five-narrative-plan/` renders and the integration map table is readable. - [ ] **Step 3: Commit** ```bash -git add content/en/cloud/about/five-narrative-plan.md +git add content/en/cloud/getting-started/meet-five/five-narrative-plan.md git commit -s -m "[Docs] Add Five narrative research plan page" ``` @@ -595,11 +595,11 @@ git commit -s -m "[Docs] Add Five narrative research plan page" - [ ] **Step 1: Add the intro paragraph before the existing image** -In `content/en/cloud/getting-started/_index.md`, insert the following **before** the line `![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow")`: +In `content/en/cloud/getting-started/_index.md`, insert the following **before** the line `## Core Workflow`: ```markdown {{< alert type="info" title="Follow Along with Five" >}} -Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →](/cloud/about) +Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →](/cloud/getting-started/meet-five) {{< /alert >}} ``` @@ -614,7 +614,7 @@ weight: 1 --- {{< alert type="info" title="Follow Along with Five" >}} -Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →](/cloud/about) +Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →](/cloud/getting-started/meet-five) {{< /alert >}} ![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow") @@ -629,7 +629,7 @@ hugo --quiet 2>&1 | grep -i "error\|warn" || echo "Build clean" Expected: `Build clean` -Then verify `http://localhost:1313/cloud/getting-started/` shows the alert callout with the link to `/cloud/about`. +Then verify `http://localhost:1313/cloud/getting-started/` shows the alert callout with the link to `/cloud/getting-started/meet-five`. - [ ] **Step 3: Commit** @@ -652,16 +652,16 @@ gh issue create --repo layer5io/docs \ --label "kind/enhancement,help wanted,issue/willfix" \ --body "$(cat <<'EOF' ## Overview -The `cloud/identity/users` page has an existing `` placeholder for Five's user profile. Replace it with a character card using the canonical Five profile defined in https://docs.layer5.io/cloud/about. +The `cloud/identity/users` page has an existing `` placeholder for Five's user profile. Replace it with a character card using the canonical Five profile defined in https://docs.layer5.io/cloud/getting-started/meet-five. ## Tasks - [ ] Remove the `` comment block from `content/en/cloud/identity/users/_index.md` - [ ] Add a `{{< cardpane >}}` character card for Five showing: name, role (Platform Engineer, User), org (Orbital Labs), plan (Team), and `/images/five/1.svg` - [ ] Add a second card for Maya Chen as the Org Admin example -- [ ] Link both cards to `/cloud/about` for full cast reference +- [ ] Link both cards to `/cloud/getting-started/meet-five` for full cast reference ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Low EOF @@ -678,10 +678,10 @@ Update `cloud/identity/organizations` to use Orbital Labs and Stellar Dynamics a - [ ] Add Orbital Labs as the example org in the org-creation walkthrough - [ ] Add Stellar Dynamics as the enterprise tenant example (cross-org access scenario) - [ ] Reference the org chart with Constellation Cloud as the provider/MSP -- [ ] Link to `/cloud/about` for full narrative context +- [ ] Link to `/cloud/getting-started/meet-five` for full narrative context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Low EOF @@ -698,10 +698,10 @@ Update `cloud/identity/teams` to use Orbital Labs' Infrastructure team (Zara, Fi - [ ] Add the Infrastructure team (admin: Zara Osei, members: Five) as the primary team example - [ ] Add the Development team (admin: Maya Chen, members: Rex Park, Jordan Reyes) as a second example - [ ] Add `team-of-fives.svg` illustration (`/images/five/team-of-fives.svg`) at an appropriate point -- [ ] Link to `/cloud/about` for full cast reference +- [ ] Link to `/cloud/getting-started/meet-five` for full cast reference ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Low EOF @@ -723,10 +723,10 @@ Update `cloud/security/roles` to use Dr. Aiko Sato (Provider Admin at Constellat - [ ] Add Maya Chen as the Org Admin example - [ ] Add Zara Osei as the Team Admin example - [ ] Use `layer5-five-mascot-means-business.svg` in the admin section header -- [ ] Link to `/cloud/about` for full cast context +- [ ] Link to `/cloud/getting-started/meet-five` for full cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Medium EOF @@ -742,11 +742,11 @@ Update `cloud/security/keychains` to use Zara Osei configuring a keychain scoped ## Tasks - [ ] Add scenario: Zara creates a keychain for the Infrastructure team - [ ] Show keychain scoped to `orbital-production` workspace and `prod-aws` environment -- [ ] Add screenshot (log in as Zara: `zara@orbital-labs.example`) following screenshot standards in `/cloud/about/five-narrative-plan` -- [ ] Link to `/cloud/about` for cast context +- [ ] Add screenshot (log in as Zara: `zara@orbital-labs.example`) following screenshot standards in `/cloud/getting-started/meet-five/five-narrative-plan` +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Medium EOF @@ -762,11 +762,11 @@ Update `cloud/spaces/workspaces` to use Five creating `orbital-staging` and Maya ## Tasks - [ ] Add scenario: Five creates the `orbital-staging` workspace - [ ] Show Maya assigning Infrastructure team and Development team to the workspace -- [ ] Add screenshot(s) following screenshot standards in `/cloud/about/five-narrative-plan` -- [ ] Link to `/cloud/about` for cast context +- [ ] Add screenshot(s) following screenshot standards in `/cloud/getting-started/meet-five/five-narrative-plan` +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Medium EOF @@ -783,11 +783,11 @@ Update `cloud/spaces/environments` to use Five connecting `prod-aws` (EKS + RDS - [ ] Add scenario: Five connects the `prod-aws` environment (AWS services: EKS, RDS, S3, CloudFront, SQS) - [ ] Add scenario: Five connects the `prod-gcp` environment (GCP services: GKE, Cloud SQL, Cloud Storage, Pub/Sub) - [ ] Show both environments assigned to the `orbital-production` workspace -- [ ] Add screenshots following screenshot standards in `/cloud/about/five-narrative-plan` -- [ ] Link to `/cloud/about` for cast context +- [ ] Add screenshots following screenshot standards in `/cloud/getting-started/meet-five/five-narrative-plan` +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Medium EOF @@ -808,10 +808,10 @@ Rewrite `cloud/tutorials/sharing-a-workspace` so Five shares `orbital-dev` with - [ ] Rewrite tutorial using Five as the workspace owner sharing `orbital-dev` - [ ] Add Rex Park (Developer team) as the recipient - [ ] Update or replace screenshots (log in as Five: `five@orbital-labs.example`) -- [ ] Link to `/cloud/about` for cast context +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Low–Medium EOF @@ -830,10 +830,10 @@ Add a new tutorial to `cloud/tutorials/` covering the promotion of `prod-deploym - [ ] Show Zara's approval step (Team Admin of Infrastructure, which controls prod access) - [ ] Add screenshots (Five: `five@orbital-labs.example`; Zara: `zara@orbital-labs.example`) - [ ] Cloud services in scope: EKS, RDS (PostgreSQL), S3, CloudFront -- [ ] Link to `/cloud/about` for cast context +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Medium EOF @@ -850,10 +850,10 @@ Update `kanvas/getting-started` so Jordan Reyes opens the `microservices-baselin - [ ] Introduce Jordan as the user opening Kanvas Designer with `microservices-baseline` - [ ] Add Five as the reviewer/collaborator - [ ] Update screenshots to use narrative accounts -- [ ] Link to `/cloud/about` for full cast context +- [ ] Link to `/cloud/getting-started/meet-five` for full cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: Medium EOF @@ -875,10 +875,10 @@ Update the Kanvas Designer documentation to use Jordan Reyes and Rex Park walkin - [ ] Use Jordan as the designer, Rex as the collaborator/reviewer - [ ] Cover: opening the design, adding/connecting AWS components, sharing for review - [ ] Update screenshots (Jordan: `jordan@orbital-labs.example`) -- [ ] Link to `/cloud/about` for cast context +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: High EOF @@ -894,11 +894,11 @@ Add or update advanced Kanvas tutorials using `data-pipeline-gcp` (Zara's GCP wo ## Tasks - [ ] Add/update a tutorial covering `data-pipeline-gcp` (owner: Zara Osei, workspace: `orbital-production`) - [ ] Add/update a tutorial covering `stellar-saas-platform` (owner: Marcus Webb, workspace: `stellar-main`) to demonstrate cross-org design access -- [ ] Add screenshots per screenshot standards in `/cloud/about/five-narrative-plan` -- [ ] Link to `/cloud/about` for cast context +- [ ] Add screenshots per screenshot standards in `/cloud/getting-started/meet-five/five-narrative-plan` +- [ ] Link to `/cloud/getting-started/meet-five` for cast context ## Reference -- Narrative: `/cloud/about` +- Narrative: `/cloud/getting-started/meet-five` - Spec: `docs/superpowers/specs/2026-04-28-five-narrative-design.md` - Difficulty: High EOF @@ -940,10 +940,10 @@ Expected: `All clear` - [ ] **Step 3: Check the about page appears in navigation** Start `make site` and verify: -- `http://localhost:1313/cloud/about/` — narrative page loads, all 3 org cards visible, all 6 character cards visible, images render -- `http://localhost:1313/cloud/about/five-narrative-plan/` — research plan loads, integration map table renders +- `http://localhost:1313/cloud/getting-started/meet-five/` — narrative page loads, all 3 org cards visible, all 6 character cards visible, images render +- `http://localhost:1313/cloud/getting-started/meet-five/five-narrative-plan/` — research plan loads, integration map table renders - `http://localhost:1313/cloud/getting-started/` — alert callout with Five link is visible -- Click the "Meet Five and the full cast →" link from Getting Started — navigates to `/cloud/about/` +- Click the "Meet Five and the full cast →" link from Getting Started — navigates to `/cloud/getting-started/meet-five/` - [ ] **Step 4: Final commit (if any fixes were needed)** @@ -973,9 +973,9 @@ gh pr create \ Implements [issue #457](https://github.com/layer5io/docs/issues/457) — establishes a continuous narrative in Layer5 Cloud docs built around Five (the mascot) and a cast of fictional characters. -- Adds `/cloud/about` — the canonical "Meet Five and the Cast" reference page with origin story, three fictional orgs (Constellation Cloud, Orbital Labs, Stellar Dynamics), six named characters with role/personality profiles, and a seed inventory of canonical workspace/environment/design names for use across all docs -- Adds `/cloud/about/five-narrative-plan` — section-by-section integration map, mascot usage guide, screenshot standards, and priority order for rolling out narrative updates -- Updates `cloud/getting-started` with a Five intro callout linking to `/cloud/about` +- Adds `/cloud/getting-started/meet-five` — the canonical "Meet Five and the Cast" reference page with origin story, three fictional orgs (Constellation Cloud, Orbital Labs, Stellar Dynamics), six named characters with role/personality profiles, and a seed inventory of canonical workspace/environment/design names for use across all docs +- Adds `/cloud/getting-started/meet-five/five-narrative-plan` — section-by-section integration map, mascot usage guide, screenshot standards, and priority order for rolling out narrative updates +- Updates `cloud/getting-started` with a Five intro callout linking to `/cloud/getting-started/meet-five` - Copies Five SVG assets from `layer5` repo into `static/images/five/` - Files 12 follow-up issues (4 batches) for phased narrative integration across Cloud and Kanvas docs @@ -991,9 +991,9 @@ Dr. Aiko Sato (Provider Admin), Five (Platform Engineer), Maya Chen (Org Admin + ## Test plan - [ ] `make clean` completes without errors -- [ ] `/cloud/about/` renders: org cards, character cards, hierarchy table, seed inventory, callout -- [ ] `/cloud/about/five-narrative-plan/` renders: integration map table, mascot guide, screenshot standards -- [ ] `/cloud/getting-started/` shows Five intro callout with working link to `/cloud/about` +- [ ] `/cloud/getting-started/meet-five/` renders: org cards, character cards, hierarchy table, seed inventory, callout +- [ ] `/cloud/getting-started/meet-five/five-narrative-plan/` renders: integration map table, mascot guide, screenshot standards +- [ ] `/cloud/getting-started/` shows Five intro callout with working link to `/cloud/getting-started/meet-five` - [ ] All 12 follow-up issues filed and visible in repo issue tracker Closes #457 diff --git a/docs/superpowers/specs/2026-04-28-five-narrative-design.md b/docs/superpowers/specs/2026-04-28-five-narrative-design.md index 688a70a876..7bba4c2d66 100644 --- a/docs/superpowers/specs/2026-04-28-five-narrative-design.md +++ b/docs/superpowers/specs/2026-04-28-five-narrative-design.md @@ -29,19 +29,19 @@ The approach mirrors Microsoft's use of "Contoso" but goes further: Five has a p ### New files ``` -content/en/cloud/about/_index.md ← narrative + cast reference page -content/en/cloud/about/five-narrative-plan.md ← research plan / integration roadmap +content/en/cloud/getting-started/meet-five/_index.md ← narrative + cast reference page +content/en/cloud/getting-started/meet-five/five-narrative-plan.md ← research plan / integration roadmap ``` ### Modified files ``` -content/en/cloud/getting-started/_index.md ← short intro paragraph + link to /cloud/about +content/en/cloud/getting-started/_index.md ← short intro paragraph + link to /cloud/getting-started/meet-five ``` --- -## Narrative Page Structure (`content/en/cloud/about/_index.md`) +## Narrative Page Structure (`content/en/cloud/getting-started/meet-five/_index.md`) ### Section 1 — Origin Story (prose) Three paragraphs: @@ -132,7 +132,7 @@ Short `{{< alert type="info" >}}` callout pointing to `five-narrative-plan.md` w --- -## Research Plan Page Structure (`content/en/cloud/about/five-narrative-plan.md`) +## Research Plan Page Structure (`content/en/cloud/getting-started/meet-five/five-narrative-plan.md`) ### Section 1 — Objective Why this narrative exists, what problem it solves, how to use this plan. @@ -171,7 +171,7 @@ Reference table mapping each Five SVG (1–19) plus named pieces (business-mode, ## Follow-up GitHub Issues (to be filed with this PR) ### Batch 1 — Identity (Low difficulty) -1. `[Docs] Add Five's user profile card to cloud/identity/users` — Replace `` placeholder with Five's character card, avatar, and link to `/cloud/about`. +1. `[Docs] Add Five's user profile card to cloud/identity/users` — Replace `` placeholder with Five's character card, avatar, and link to `/cloud/getting-started/meet-five`. 2. `[Docs] Illustrate cloud/identity/organizations with Orbital Labs and Stellar Dynamics examples` 3. `[Docs] Illustrate cloud/identity/teams with Infrastructure and Development team examples` @@ -197,5 +197,5 @@ Reference table mapping each Five SVG (1–19) plus named pieces (business-mode, - All Five SVG illustrations source from `layer5` repo at `src/assets/images/five/SVG/`. Files must be copied into `static/images/five/` in the `docs` repo. - Hugo shortcodes in use: `{{< cardpane >}}`, `{{< alert >}}`, `{{< svg >}}`. No new shortcodes needed. - The narrative page is the single source of truth. Character names, roles, and seed data defined here must not be contradicted elsewhere in the docs. -- The `kanvas` docs reference this narrative but the canonical home is in `cloud/about`. Kanvas pages link to `/cloud/about` rather than duplicating the cast. +- The `kanvas` docs reference this narrative but the canonical home is in `cloud/getting-started/meet-five`. Kanvas pages link to `/cloud/getting-started/meet-five` rather than duplicating the cast. - Tone standard: witty sarcasm and dry humor as tools to keep the reader engaged. Never obscures technical content. One well-placed quip per page is enough. diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index 484b5c724c..f434b47add 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -74,9 +74,6 @@
-