Skip to content

Commit a6d3944

Browse files
SyedAsad108SyedAsad108
authored andcommitted
docs: update additional placeholders
Signed-off-by: SyedAsad108 <ID+username@users.noreply.github.com>
1 parent a39b1ea commit a6d3944

File tree

10 files changed

+1068
-2460
lines changed

10 files changed

+1068
-2460
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2020 Layer5, Inc.
189+
Copyright 2022 The Hugo Authors.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 206 additions & 215 deletions
Large diffs are not rendered by default.
Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,37 @@
11
---
22
title: Concepts
33
weight: 2
4-
draft: true
4+
draft: false
55
description: >
66
An overview of Layer5 Cloud concepts and their relationships.
77
---
88

9+
10+
11+
The Layer5 Cloud provides a comprehensive suite of management tools for cloud-native infrastructure. Understanding the core entities and how they interact is essential for effectively managing your service meshes, clusters, and designs.
12+
13+
## Core Entities
14+
15+
The following concepts form the foundation of the Layer5 Cloud ecosystem:
16+
17+
* **Workspaces:** Logical isolation boundaries for organizing team members, environments, and resources.
18+
* **Environments:** Specific deployment targets (e.g., Development, Staging, Production) within a Workspace.
19+
* **Designs:** Visual representations of your infrastructure patterns and service mesh configurations.
20+
* **Catalogs:** Repositories of reusable patterns and best practices shared across the community or organization.
21+
922
![concepts-overview](images/concepts-overview.svg "image-center-shadow")
1023

11-
<!--
12-
{{% pageinfo %}}
13-
Page under construction.
14-
{{% /pageinfo %}}
24+
---
1525

16-
For many projects, users may not need much information beyond the information in the [Overview](/docs/overview/), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.
26+
### Understanding Relationships
1727

18-
Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.
28+
To get the most out of Layer5 Cloud, it is important to understand how these components interact:
1929

30+
| Concept | Relationship | Purpose |
31+
| :--- | :--- | :--- |
32+
| **User to Workspace** | Many-to-Many | Users can collaborate across multiple isolated workspaces. |
33+
| **Workspace to Environment** | One-to-Many | A single workspace can host multiple environments for lifecycle management. |
34+
| **Design to Catalog** | Many-to-One | Designs can be published to a catalog for broader consumption and version control. |
2035

21-
{{ $context := . }}
22-
{{ range $taxo, $taxo_map := .Site.Taxonomies }}
23-
{{ partial "taxonomy_terms_article.html" (dict "context" $context "taxo" $taxo ) }}
24-
{{ end }} -->
36+
### Next Steps
37+
For a deeper dive into the technical implementation of these concepts, please refer to our [Architecture Documentation](/docs/architecture).

content/en/cloud/getting-started/_index.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,46 @@
22
title: Getting Started
33
description: Learn how to effectively manage your organizations, teams, users, workspaces, environments, and more.
44
weight: 1
5+
draft: false
56
---
6-
<!-- {{% pageinfo %}}
7-
Page under construction.
8-
{{% /pageinfo %}} -->
9-
<!-- Information in this section helps your user try your project themselves.
107

11-
* What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.
8+
The Layer5 Cloud provides a centralized management plane for your cloud-native infrastructure. This guide will help you set up your account and deploy your first design.
129

13-
* Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.
10+
## Prerequisites
1411

15-
Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.
12+
Before you begin, ensure you have the following:
13+
* A [Layer5 Cloud account](https://cloud.layer5.io).
14+
* A running Kubernetes cluster (local or cloud-based).
15+
* [Meshery](https://docs.meshery.io/installation) installed and connected to your cluster.
1616

17-
## Prerequisites
17+
## Installation and Setup
1818

19-
Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?
19+
Layer5 Cloud functions as a Remote Provider for Meshery. To get started:
2020

21-
## Installation
21+
1. **Log in:** Navigate to your Meshery UI (usually `http://localhost:9081`).
22+
2. **Select Provider:** On the login screen, select **Layer5 Cloud** from the provider dropdown.
23+
3. **Authenticate:** You will be redirected to the Layer5 Cloud authentication page. Log in with your preferred identity provider (GitHub, Google, etc.).
2224

23-
Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?
25+
![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow")
26+
[Image of Meshery login screen showing the Layer5 Cloud provider selection]
2427

25-
## Setup
28+
## Core Workflow
2629

27-
Is there any initial setup users need to do after installation to try your project?
30+
Once authenticated, you can begin organizing your infrastructure using the following hierarchy:
31+
32+
* **Organizations:** Create an Organization to manage your teams and billing.
33+
* **Workspaces:** Group your projects and resources logically.
34+
* **Environments:** Map your Kubernetes clusters to specific environments (e.g., Staging, Production).
2835

2936
## Try it out!
3037

31-
Can your users test their installation, for example by running a command or deploying a Hello World example? -->
32-
![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow")
38+
To verify your setup, try deploying a sample design:
39+
40+
1. Navigate to the **Designs** section in the sidebar.
41+
2. Click on **Import** and select a sample pattern from the Meshery Catalog.
42+
3. Click **Deploy** and select your target Environment.
43+
44+
---
45+
46+
### Need Help?
47+
If you run into issues during setup, join our [Slack Community](http://slack.layer5.io) or check the [Troubleshooting Guide](/docs/troubleshooting).

go.mod

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ module github.com/layer5io/docs
33
go 1.23
44

55
require (
6-
github.com/google/docsy v0.12.0 // indirect
6+
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect
7+
github.com/google/docsy v0.11.0 // indirect
78
github.com/google/docsy/dependencies v0.7.2 // indirect
9+
github.com/twbs/bootstrap v5.3.8+incompatible // indirect
810
)

go.sum

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2+
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
3+
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w=
24
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
3-
github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4=
4-
github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM=
5+
github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM=
6+
github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI=
57
github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI=
68
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
79
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
8-
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
10+
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
11+
github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o=
12+
github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
22 MB
Binary file not shown.
18.6 MB
Binary file not shown.

0 commit comments

Comments
 (0)