Skip to content

Commit b1b745c

Browse files
authored
Merge pull request #702 from Savvythelegend/chore/format-onboarding-section
docs(readme): refine formatting and fix typos
2 parents a375fe9 + 18d0226 commit b1b745c

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ Running the site locally is simple. Provided you have Docker installed, clone th
5555
5656
### With Golang
5757

58-
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>
58+
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>
5959

6060
Now to setup and run the site locally run:
6161

6262
`make setup` followed by `make site`
6363

6464
...and then visit <http://localhost:1313>.
6565

66-
If you pull down new code from GitHub, you will occasionally need 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.
66+
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.
6767

68-
## Layer5 Documentation Stucture
68+
## Layer5 Documentation Structure
6969

7070
## High-Level Outline & Information Architecture for Layer5 Documentation
7171

@@ -81,7 +81,7 @@ If you pull down new code from GitHub, you will occasionally need run `make setu
8181
### Getting Started
8282

8383
- **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.
84-
- **Creating a Design from Meshery Catalog Templates:** With this guide, you can create amazing cloud native designs for your infrastructure from already avaliable templetes in the meshery catalog.
84+
- **Creating a Design from Meshery Catalog Templates:** With this guide, you can create amazing cloud native designs for your infrastructure from already available templates in the meshery catalog.
8585

8686
### Concepts
8787

@@ -129,13 +129,13 @@ Low-level ReST API reference for extending Layer5 Cloud.
129129
- **Starting from a pattern:** A Pattern is an entity that augments the operational behavior of a deployed instance of a Design.
130130
- **Creating Relationships:** Relationships identify and facilitate genealogy between Components.
131131
- **Working with Components:** Components represent entities in the Meshery ecosystem, exposing capabilities of the underlying platform.
132-
- **Starting from scratch:** Emphasiz the underlying system behavior for each action you take.
132+
- **Starting from scratch:** Emphasize the underlying system behavior for each action you take.
133133

134134
### Exploring Designer
135135

136136
- **Reviewing Designs:** Learn how to leverage comments in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
137-
- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside kanvas
138-
- **Export Designs:** How to export your designs for backup , sharing or offline use.
137+
- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside Kanvas
138+
- **Export Designs:** How to export your designs for backup, sharing or offline use.
139139

140140
### Working with Components
141141

@@ -195,7 +195,7 @@ To display images in a pop-up modal, use the following syntax: `![alt text](/pat
195195

196196
### Adding Alert to the site
197197

198-
Use the following Syntax to add a Alert:
198+
Use the following Syntax to add an Alert:
199199
`{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}`
200200

201201
- `type="danger"`: Alert used to indicate something related to security.
@@ -204,21 +204,23 @@ Use the following Syntax to add a Alert:
204204
- `type="note"`: Alert used to indicate a neutral information.
205205
- `type="success"`: Alert used to indicate a positive information.
206206

207-
By default, if you don't specify a title `title="Your Title"`, the title will be the same as the type name.
207+
By default, if you don't specify a `title="Your Title"`, the title will be the same as the type name.
208208

209-
**Note-> Using the wrong type will lead to the use of the default alert i.e. success**
209+
**Note-> Using an invalid alert type will lead to the default alert being used (i.e. success).**
210210

211211
<hr/>
212212

213213
<a name="contributing"></a><a name="community"></a>
214-
Our projects are community-built and welcome collaboration. 👍 Be sure to see the <a href="https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit">Layer5 Community Welcome Guide</a> for a tour of resources available to you and jump into our <a href="http://slack.layer5.io">Slack</a>!
214+
Our projects are community-driven and open to collaboration. 👍 Be sure to see the <a href="https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit">Layer5 Community Welcome Guide</a> for a tour of resources available to you. You can also join our <a href="http://slack.layer5.io">Slack</a> to get involved.
215215

216216
<p style="clear:both;">
217217
<a href ="https://layer5.io/community/meshmates"><img alt="MeshMates" src=".github/readme/images/layer5-community-sign.png" style="margin-right:10px; margin-bottom:15px;" width="28%" align="left"/></a>
218218
<h3>Find your MeshMate</h3>
219219

220-
<p>MeshMates are experienced Layer5 community members, who will help you learn your way around, discover live projects and expand your community network.
221-
Become a <b>Meshtee</b> today!</p>
220+
<p>
221+
MeshMates are experienced Layer5 community members who will help you learn your way around, discover live projects and expand your community network.
222+
Become a <b>Meshtee</b> today!
223+
</p>
222224

223225
Find out more on the <a href="https://layer5.io/community">Layer5 community</a>. <br />
224226
<br /><br /><br /><br />
@@ -237,7 +239,7 @@ Find out more on the <a href="https://layer5.io/community">Layer5 community</a>.
237239
<div>
238240
<a href="https://meshery.io/community"><img alt="Layer5 Community" src=".github/readme/images//community.svg" style="margin-right:8px;padding-top:9px;" width="140px" align="left" /></a>
239241
<p>
240-
✔️ <em><strong>Join</strong></em> any or all of the weekly meetings on <a href="https://calendar.google.com/calendar/b/1?cid=bGF5ZXI1LmlvX2VoMmFhOWRwZjFnNDBlbHZvYzc2MmpucGhzQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20">community calendar</a>.<br />
242+
✔️ <em><strong>Join</strong></em> any or all of the weekly meetings on <a href="https://calendar.google.com/calendar/b/1?cid=bGF5ZXI1LmlvX2VoMmFhOWRwZjFnNDBlbHZvYzc2MmpucGhzQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20">Community calendar</a>.<br />
241243
✔️ <em><strong>Watch</strong></em> community <a href="https://www.youtube.com/playlist?list=PL3A-A6hPO2IMPPqVjuzgqNU5xwnFFn3n0">meeting recordings</a>.<br />
242244
✔️ <em><strong>Access</strong></em> the <a href="https://drive.google.com/drive/u/4/folders/0ABH8aabN4WAKUk9PVA">Community Drive</a> by completing a community <a href="https://layer5.io/newcomer">Member Form</a>.<br />
243245
✔️ <em><strong>Discuss</strong></em> in the <a href="https://discuss.layer5.io">Community Forum</a>.<br />

0 commit comments

Comments
 (0)