Skip to content

Commit fa7fdbb

Browse files
authored
Merge pull request #1054 from crowdsecurity/LET_revamp
LET : doc v2
2 parents 35ecdfb + 1e4c529 commit fa7fdbb

31 files changed

Lines changed: 4005 additions & 857 deletions

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,29 @@ The documentation is built using [Docusaurus](https://docusaurus.io/), a modern
88

99
## Pre-requisites
1010

11-
- Node.js (version 20 or later)
12-
- npm (Node package manager)
11+
- [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager)
12+
- Node.js stable (install via nvm: `nvm install stable && nvm use stable`)
1313
- VSCode with recommended extensions installed (see `.vscode/extensions.json`)
1414

1515
## Installation
1616

1717
```console
18+
nvm use stable
19+
cd crowdsec-docs
1820
npm install
1921
```
2022

2123
## Local Development
2224

2325
```console
24-
npm run start
26+
nvm use stable
27+
cd crowdsec-docs
28+
npm start
29+
# or equivalently
30+
npx docusaurus start
2531
```
2632

27-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
33+
This command starts a local development server at http://localhost:3000. Most changes are reflected live without having to restart the server.
2834

2935
## Build
3036

crowdsec-docs/docusaurus.config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ const config: Config = {
227227
organizationName: "CrowdSec",
228228
projectName: "crowdsec-docs",
229229
markdown: {
230+
mermaid: true,
230231
mdx1Compat: {
231232
comments: true,
232233
admonitions: true,
@@ -239,6 +240,7 @@ const config: Config = {
239240
href: "https://fonts.googleapis.com/icon?family=Material+Icons",
240241
},
241242
],
243+
themes: ["@docusaurus/theme-mermaid"],
242244
themeConfig: {
243245
image: "img/crowdsec_og_image.png",
244246
colorMode: {

crowdsec-docs/package-lock.json

Lines changed: 1365 additions & 116 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

crowdsec-docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
"@docusaurus/plugin-client-redirects": "^3.9.2",
2525
"@docusaurus/preset-classic": "^3.9.2",
2626
"@docusaurus/theme-common": "^3.9.2",
27+
"@docusaurus/theme-mermaid": "^3.9.2",
2728
"@docusaurus/theme-search-algolia": "^3.9.2",
2829
"@emotion/react": "^11.14.0",
2930
"@emotion/styled": "^11.14.0",

crowdsec-docs/sidebarsUnversioned.ts

Lines changed: 85 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,28 +91,101 @@ const sidebarsUnversionedConfig: SidebarConfig = {
9191
trackerApiSidebar: [
9292
{
9393
type: "doc",
94-
label: "Getting Started",
94+
label: "Overview",
9595
id: "tracker_api/intro",
9696
},
9797
{
98-
type: "doc",
99-
label: "Prioritize",
100-
id: "tracker_api/prioritize",
98+
type: "category",
99+
label: "Understanding the Data",
100+
items: [
101+
{
102+
type: "doc",
103+
label: "Scores & Ratings",
104+
id: "tracker_api/scores",
105+
},
106+
{
107+
type: "doc",
108+
label: "Exploitation Phases",
109+
id: "tracker_api/exploitation_phases",
110+
},
111+
{
112+
type: "doc",
113+
label: "CrowdSec Analysis",
114+
id: "tracker_api/crowdsec_analysis",
115+
},
116+
{
117+
type: "doc",
118+
label: "Threat Context",
119+
id: "tracker_api/threat_context",
120+
},
121+
{
122+
type: "doc",
123+
label: "Reconnaissance Rules vs CVEs",
124+
id: "tracker_api/fingerprints_vs_cves",
125+
},
126+
],
101127
},
102128
{
103129
type: "doc",
104-
label: "Mitigate",
105-
id: "tracker_api/mitigate",
130+
label: "Web Interface",
131+
id: "tracker_api/web_interface",
106132
},
107133
{
108-
type: "doc",
109-
label: "API Reference",
110-
id: "tracker_api/api_reference",
134+
type: "category",
135+
label: "API",
136+
items: [
137+
{
138+
type: "doc",
139+
label: "Authentication & Setup",
140+
id: "tracker_api/api_authentication",
141+
},
142+
{
143+
type: "doc",
144+
label: "CVEs",
145+
id: "tracker_api/api_cves",
146+
},
147+
{
148+
type: "doc",
149+
label: "Reconnaissance / Fingerprints",
150+
id: "tracker_api/api_fingerprints",
151+
},
152+
{
153+
type: "doc",
154+
label: "Vendors, Products & Tags",
155+
id: "tracker_api/api_lookups",
156+
},
157+
{
158+
type: "doc",
159+
label: "Integrations & Blocklists",
160+
id: "tracker_api/api_integrations",
161+
},
162+
{
163+
type: "doc",
164+
label: "SDKs & Libraries",
165+
id: "tracker_api/api_sdks",
166+
},
167+
{
168+
type: "doc",
169+
label: "API Reference",
170+
id: "tracker_api/api_reference",
171+
},
172+
],
111173
},
112174
{
113-
type: "doc",
114-
label: "Web Interface",
115-
id: "tracker_api/web_interface",
175+
type: "category",
176+
label: "Guides",
177+
items: [
178+
{
179+
type: "doc",
180+
label: "Triage Workflow",
181+
id: "tracker_api/guide_triage",
182+
},
183+
{
184+
type: "doc",
185+
label: "Proactive Monitoring",
186+
id: "tracker_api/guide_proactive",
187+
},
188+
],
116189
},
117190
],
118191
consoleSidebar: [
194 KB
Loading
236 KB
Loading
258 KB
Loading
187 KB
Loading
189 KB
Loading

0 commit comments

Comments
 (0)