Skip to content

Commit 27c0ce5

Browse files
authored
Update README.md
Signed-off-by: Mericio <218162243+simihablo@users.noreply.github.com>
1 parent e961c6c commit 27c0ce5

File tree

1 file changed

+82
-71
lines changed

1 file changed

+82
-71
lines changed

README.md

Lines changed: 82 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
[Layer5](https://layer5.io)'s cloud native application and infrastructure management software enables engineers to expect more from their infrastructure. We embrace _developer_-defined infrastructure. We empower developers to change how they write applications, support _operators_ in rethinking how they run modern infrastructure, and enable _product owners_ to regain full-control over their product portfolio.
2727

28-
## Contributions Welcome
28+
### Contributions Welcome
2929

3030
<div>
3131
<a href="https://layer5.io/community"><img alt="Layer5 Community" src=".github/readme/images//community.svg" style="margin-right:8px;padding-top:9px;" width="140px" align="left" /></a>
@@ -37,12 +37,13 @@
3737
✔️ <em><strong>Explore more</strong></em> in the <a href="https://layer5.io/community/handbook">Community Handbook</a>.<br />
3838
</p>
3939
</div>
40-
Explore tutorials and documentation by product in the https://docs.layer5.io website; documentation and developer resources of Layer5 products.
40+
Explore tutorials and documentation by product in the https://docs.layer5.io website; documentation and developer resources of Layer5 products. If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in 🚀
4141

42-
If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in 🚀
42+
## Building the Documentation
4343

44-
### With Golang
44+
<details>
4545

46+
<summary><h3>Build Docs with Golang</h3></summary>
4647
If your local development environment has a supported version (v1.21.0+) of Golang installed, next you'll need to install extended Hugo version as it has necessary SCSS/SASS support. Find all the Hugo packages here: <https://github.com/gohugoio/hugo/releases/tag/v0.120.4>
4748

4849
Now to setup and run the site locally run:
@@ -53,17 +54,78 @@ Now to setup and run the site locally run:
5354

5455
If you pull down new code from GitHub, you will occasionally need to run `make setup` again. Otherwise, there's no need to re-run `make setup` each time the site is run, you can just run `make site` to get it going and have it automatically reload as you make and save site edits.
5556

56-
### With Docker
57+
</details>
58+
<details>
59+
60+
<summary><h3>Build Docs with Docker</h3></summary>
61+
5762

5863
Running the site locally is simple. Provided you have Docker installed, clone this repo, run `make docker`, and then visit <http://localhost:1313>.
5964

6065
> [!IMPORTANT]
6166
> This requires Docker Desktop version **4.24** or later, or Docker Engine with Docker
6267
> Compose version [**2.22**](https://docs.docker.com/compose/file-watch/) or later.
6368
64-
## Layer5 Documentation Structure
69+
</details>
70+
71+
<details>
72+
73+
<summary><h3>Contribution Guidelines</h3>
74+
75+
A detailed contribution guide for Layer5 Docs.
76+
77+
### Editing Markdown Content
78+
79+
Documentation content is written in Markdown and you'll find all files listed under the /content directory.
80+
81+
To create a new page with Markdown, create a file ending in `.md` in a `site/<subdirectory>`. The path in the content directory will be the URL route. For example, `site/docs/hello.md` will be served from the `/docs/hello` URL.
82+
83+
```yaml
84+
---
85+
title: 'My Title'
86+
description: "A thorough, yet succinct description of the page's contents"
87+
---
88+
```
89+
90+
The significant keys in the YAML frontmatter are:
91+
92+
`title` (string) - This is the title of the page that will be set in the HTML title.
93+
`description` (string) - This is a description of the page that will be set in the HTML description.
94+
`permalink` (string - relative file path) - canonical location of the page
95+
`category` (string) - section to which the page belongs.
96+
`redirect_from` (string - relative file path) - in case the page was previously available elsewhere
97+
98+
<div>&nbsp;</div>
99+
100+
### Uploading Images to the site
101+
102+
To display images in a pop-up modal, use the following syntax: `![alt text](/path/to/image.svg)` or `<img src="" alt="" />`.
103+
104+
**Note:**
105+
106+
- For images to show correctly on subpages, always provide the complete image path.
107+
- When using the `<img />` tag, add `data-modal="false"` to prevent the image from opening in a modal e.g. a [logo](https://github.com/layer5io/docs/blob/0bef5a9a05214a9dda10d8a68431e41f5a36676d/layouts/partials/footer.html#L9).
108+
109+
### Adding Alert to the site
110+
111+
Use the following Syntax to add an Alert:
112+
`{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}`
113+
114+
- `type="danger"`: Alert used to indicate something related to security.
115+
- `type="info"`: Alert used to write some information.
116+
- `type="warning"`: Alert used to indicate a warning that might need attention.
117+
- `type="note"`: Alert used to indicate a neutral information.
118+
- `type="success"`: Alert used to indicate a positive information.
119+
120+
By default, if you don't specify a `title="Your Title"`, the title will be the same as the type name.
65121

66-
## High-Level Outline & Information Architecture for Layer5 Documentation
122+
**Note-> Using an invalid alert type will lead to the default alert being used (i.e. success).**
123+
124+
</details>
125+
126+
## Documentation Structure
127+
128+
The following is the high-level outline and information architecture for Layer5 documentation.
67129

68130
**Goal:** Offer comprehensive, organized, and accessible documentation for diverse audiences, from new users to expert contributors.
69131

@@ -73,43 +135,43 @@ Running the site locally is simple. Provided you have Docker installed, clone th
73135
- **Needs:** Varied - learning fundamentals, managing tasks, understanding advanced concepts, contributing code.
74136

75137
<details>
76-
<summary><h2>Cloud Docs</h2></summary>
138+
<summary><h3>Cloud Section: Information Architecture</h3></summary>
77139

78140
### Getting Started
79141

80-
- **Setting up Layer5 Account:** With a personal account on Layer5 Cloud, you can import or create infrastructural designs, collaborate with others through workspaces and teams, manage your organizations and more.
81-
- **Creating a Design from Layer5 Cloud Catalog Templates:** With this guide, you can create amazing cloud native designs for your infrastructure from already available templates in the catalog.
142+
- Creating an Account
143+
- Creating your first Designs
82144

83145
### Concepts
84146

85147
An overview of Layer5 Cloud concepts and their relationships to one another.
86148

87-
### Identity
149+
#### Identity
88150

89151
- **Organizations:** Organizations, Managing Organization Permissions
90152
- **Teams:** Teams, Managing Teams Permissions
91153
- **Users:** User Management, Managing User Permissions
92154

93-
### Security
155+
#### Security
94156

95157
- **Tokens:** API Tokens are used to authenticate to Layer5 Cloud’s REST API.
96158
- **Keychains**: Keychains are a collection of keys
97159
- **Keys**: Keys are the atomic unit of access control
98160
- **Roles**: Roles map permissions to users.
99161

100-
### Catalog
162+
#### Catalog
101163

102164
The Cloud Catalog is a web-based, public catalog to facilitate easy sharing and discovery of common cloud native architectures and design patterns.
103165

104-
### Workspaces
166+
#### Workspaces
105167

106168
Workspaces serve as a virtual space for your team-based work.
107169

108-
### Tutorials
170+
#### Tutorials
109171

110-
- **Kanvas Snapshots**: Connect Kanvas to your GitHub repo and see changes pull request-to-pull request.
111-
- **Sharing a Workspace**: Learn how to control access to workspaces and their resources.
112-
- **Recognizing User and Contributor Milestones**: Showcasing user and contributor achievements
172+
- Kanvas Snapshots
173+
- Sharing a Workspace
174+
- Recognizing User and Contributor Milestones
113175

114176
### Self-Hosted
115177

@@ -120,8 +182,9 @@ Keep your Kanvas designs internal to your workplace. Get remote support from Lay
120182
Low-level ReST API reference for extending Layer5 Cloud.
121183

122184
</details>
185+
123186
<details>
124-
<summary><h2>Kanvas Docs</h2>
187+
<summary><h3>Kanvas Section: Information Architecture</h3>
125188

126189
### Getting Started with Designs
127190

@@ -156,58 +219,6 @@ Operator mode is for operating your Kubernetes clusters and cloud native infrast
156219

157220
</details>
158221

159-
### Contribution Guidelines
160-
161-
A detailed contribution guide for Layer5 Docs.
162-
Contributing to the docs.layer5.io
163-
164-
### Editing Markdown Content
165-
166-
Documentation content is written in Markdown and you'll find all files listed under the /content directory.
167-
168-
To create a new page with Markdown, create a file ending in `.md` in a `site/<subdirectory>`. The path in the content directory will be the URL route. For example, `site/docs/hello.md` will be served from the `/docs/hello` URL.
169-
170-
```yaml
171-
---
172-
title: 'My Title'
173-
description: "A thorough, yet succinct description of the page's contents"
174-
---
175-
```
176-
177-
The significant keys in the YAML frontmatter are:
178-
179-
`title` (string) - This is the title of the page that will be set in the HTML title.
180-
`description` (string) - This is a description of the page that will be set in the HTML description.
181-
`permalink` (string - relative file path) - canonical location of the page
182-
`category` (string) - section to which the page belongs.
183-
`redirect_from` (string - relative file path) - in case the page was previously available elsewhere
184-
185-
<div>&nbsp;</div>
186-
187-
### Uploading Images to the site
188-
189-
To display images in a pop-up modal, use the following syntax: `![alt text](/path/to/image.svg)` or `<img src="" alt="" />`.
190-
191-
**Note:**
192-
193-
- For images to show correctly on subpages, always provide the complete image path.
194-
- When using the `<img />` tag, add `data-modal="false"` to prevent the image from opening in a modal e.g. a [logo](https://github.com/layer5io/docs/blob/0bef5a9a05214a9dda10d8a68431e41f5a36676d/layouts/partials/footer.html#L9).
195-
196-
### Adding Alert to the site
197-
198-
Use the following Syntax to add an Alert:
199-
`{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}`
200-
201-
- `type="danger"`: Alert used to indicate something related to security.
202-
- `type="info"`: Alert used to write some information.
203-
- `type="warning"`: Alert used to indicate a warning that might need attention.
204-
- `type="note"`: Alert used to indicate a neutral information.
205-
- `type="success"`: Alert used to indicate a positive information.
206-
207-
By default, if you don't specify a `title="Your Title"`, the title will be the same as the type name.
208-
209-
**Note-> Using an invalid alert type will lead to the default alert being used (i.e. success).**
210-
211222
<hr/>
212223

213224
<a name="contributing"></a><a name="community"></a>

0 commit comments

Comments
 (0)