You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,18 +41,6 @@ Explore tutorials and documentation by product in the https://docs.layer5.io web
41
41
42
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 🚀
43
43
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
-
56
44
### With Golang
57
45
58
46
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:
65
53
66
54
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.
67
55
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
+
68
65
## Layer5 Documentation Structure
69
66
70
67
## 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
76
73
-**Personas:** Beginners, developers, admins, operators, security specialists, contributors, users of all experience levels.
@@ -122,7 +120,9 @@ Keep your Kanvas designs internal to your workplace. Get remote support from Lay
122
120
123
121
Low-level ReST API reference for extending Layer5 Cloud.
124
122
125
-
## Kanvas Docs
123
+
</details>
124
+
<details>
125
+
<summary><h2>Kanvas Docs</h2>
126
126
127
127
### Getting Started with Designs
128
128
@@ -148,15 +148,15 @@ Operator mode is for operating your Kubernetes clusters and cloud native infrast
148
148
### Core Tasks
149
149
150
150
-**Whiteboarding:** Kanvas Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.
0 commit comments