Skip to content

Commit 1b3044d

Browse files
authored
Merge pull request #804 from yi-nuo426/master
Summarize readme
2 parents be6c5b3 + c76cede commit 1b3044d

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,6 @@ Explore tutorials and documentation by product in the https://docs.layer5.io web
4141

4242
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 🚀
4343

44-
### Running the Site Locally
45-
46-
The website can be run locally through Golang (Hugo) or Docker. If you choose to run through Docker, everything will be a little bit slower due to the additional overhead, so for frequent contributors it may be worth it to use Golang.
47-
48-
### With Docker
49-
50-
Running the site locally is simple. Provided you have Docker installed, clone this repo, run `make docker`, and then visit <http://localhost:1313>.
51-
52-
> [!IMPORTANT]
53-
> This requires Docker Desktop version **4.24** or later, or Docker Engine with Docker
54-
> Compose version [**2.22**](https://docs.docker.com/compose/file-watch/) or later.
55-
5644
### With Golang
5745

5846
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>
@@ -65,6 +53,15 @@ Now to setup and run the site locally run:
6553

6654
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.
6755

56+
### With Docker
57+
58+
Running the site locally is simple. Provided you have Docker installed, clone this repo, run `make docker`, and then visit <http://localhost:1313>.
59+
60+
> [!IMPORTANT]
61+
> This requires Docker Desktop version **4.24** or later, or Docker Engine with Docker
62+
> Compose version [**2.22**](https://docs.docker.com/compose/file-watch/) or later.
63+
64+
6865
## Layer5 Documentation Structure
6966

7067
## High-Level Outline & Information Architecture for Layer5 Documentation
@@ -76,7 +73,8 @@ If you pull down new code from GitHub, you will occasionally need to run `make s
7673
- **Personas:** Beginners, developers, admins, operators, security specialists, contributors, users of all experience levels.
7774
- **Needs:** Varied - learning fundamentals, managing tasks, understanding advanced concepts, contributing code.
7875

79-
## Cloud Docs
76+
<details>
77+
<summary><h2>Cloud Docs</h2></summary>
8078

8179
### Getting Started
8280

@@ -122,7 +120,9 @@ Keep your Kanvas designs internal to your workplace. Get remote support from Lay
122120

123121
Low-level ReST API reference for extending Layer5 Cloud.
124122

125-
## Kanvas Docs
123+
</details>
124+
<details>
125+
<summary><h2>Kanvas Docs</h2>
126126

127127
### Getting Started with Designs
128128

@@ -148,15 +148,15 @@ Operator mode is for operating your Kubernetes clusters and cloud native infrast
148148
### Core Tasks
149149

150150
- **Whiteboarding:** Kanvas Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.
151-
152151
- **Deploying Designs:** Validating Designs, Undeploying Designs, Deploying Designs, Cloning a Design
153152

154153
### Reference
155154

156155
- **Keyboard Shortcuts:** Learn the keyboard shortcuts for Kanvas to enhance your designing experience.
157-
158156
- **Troubleshooting Kanvas:** Learn to Troubleshoot the Kanvas
159157

158+
</details>
159+
160160
### Contribution Guidelines
161161

162162
A detailed contribution guide for Layer5 Docs.

0 commit comments

Comments
 (0)