Skip to content

Commit 2cf3c52

Browse files
author
jdv
committed
more clean up and starting content update
1 parent 82df0e7 commit 2cf3c52

17 files changed

Lines changed: 211 additions & 206 deletions

‎crowdsec-docs/docusaurus.config.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,13 @@ const NAVBAR_ITEMS: NavbarItem[] = [
8888
position: "left",
8989
label: "Blocklists",
9090
},
91-
{ to: "/u/cti_api/intro", position: "left", label: "CTI" },
91+
{ to: "/u/cti_api/intro", position: "left", label: "IP Reputation & CTI" },
9292
{ to: "/u/console/intro", position: "left", label: "Console" },
93+
{
94+
type: 'html',
95+
value: '<span class="navbar-separator" aria-hidden="true"></span>',
96+
position: 'left',
97+
},
9398
{
9499
label: "Resources",
95100
position: "left",

‎crowdsec-docs/sidebarsUnversioned.ts‎

Lines changed: 100 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -11,38 +11,13 @@ const sidebarsUnversionedConfig: SidebarConfig = {
1111
},
1212
{
1313
type: "link",
14-
label: "Web UI",
14+
label: "Web UI 📖",
1515
href: "/u/console/ip_reputation/intro",
1616
},
1717
{
18-
type: "category",
19-
label: "API",
20-
items: [
21-
{
22-
type: "doc",
23-
label: "Getting Started",
24-
id: "cti_api/api_getting_started",
25-
},
26-
{
27-
type: "link",
28-
label: "Swagger",
29-
href: "https://crowdsecurity.github.io/cti-api/",
30-
},
31-
],
32-
},
33-
{
34-
type: "category",
35-
label: "Taxonomy",
36-
items: [
37-
"cti_api/taxonomy/intro",
38-
"cti_api/taxonomy/cti_object",
39-
"cti_api/taxonomy/scores",
40-
"cti_api/taxonomy/scenarios",
41-
"cti_api/taxonomy/behaviors",
42-
"cti_api/taxonomy/classifications",
43-
"cti_api/taxonomy/false_positives",
44-
"cti_api/taxonomy/benign",
45-
],
18+
type: "doc",
19+
label: "API Access",
20+
id: "cti_api/api_introduction",
4621
},
4722
{
4823
type: "category",
@@ -70,6 +45,30 @@ const sidebarsUnversionedConfig: SidebarConfig = {
7045
"cti_api/api_integration/integration_thehive",
7146
],
7247
},
48+
{
49+
type: "link",
50+
label: "Swagger",
51+
href: "https://crowdsecurity.github.io/cti-api/",
52+
},
53+
{
54+
type: "html",
55+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
56+
defaultStyle: false,
57+
},
58+
{
59+
type: "category",
60+
label: "Taxonomy",
61+
items: [
62+
"cti_api/taxonomy/intro",
63+
"cti_api/taxonomy/cti_object",
64+
"cti_api/taxonomy/scores",
65+
"cti_api/taxonomy/scenarios",
66+
"cti_api/taxonomy/behaviors",
67+
"cti_api/taxonomy/classifications",
68+
"cti_api/taxonomy/false_positives",
69+
"cti_api/taxonomy/benign",
70+
],
71+
},
7372
{
7473
type: "doc",
7574
label: "FAQ",
@@ -114,6 +113,11 @@ const sidebarsUnversionedConfig: SidebarConfig = {
114113
label: "Getting Started",
115114
id: "console/getting_started",
116115
},
116+
{
117+
type: "html",
118+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
119+
defaultStyle: false,
120+
},
117121
{
118122
type: "category",
119123
label: "Security Engine",
@@ -182,11 +186,6 @@ const sidebarsUnversionedConfig: SidebarConfig = {
182186
},
183187
],
184188
},
185-
{
186-
label: "Blocklists",
187-
type: "doc",
188-
id: "blocklists/intro",
189-
},
190189
{
191190
type: "category",
192191
label: "Alerts",
@@ -262,37 +261,22 @@ const sidebarsUnversionedConfig: SidebarConfig = {
262261
],
263262
},
264263
{
265-
id: "console/allowlists",
264+
type: "html",
265+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
266+
defaultStyle: false,
267+
},
268+
{
269+
label: "Blocklists",
266270
type: "doc",
267-
label: "Centralized Allowlists",
268-
customProps: {
269-
tag: "premium",
270-
},
271+
id: "blocklists/intro",
271272
},
272273
{
273-
type: "category",
274-
label: "Enterprise plan",
274+
id: "console/allowlists",
275+
type: "doc",
276+
label: "Centralized Allowlists",
275277
customProps: {
276278
tag: "premium",
277279
},
278-
items: [
279-
{
280-
type: "doc",
281-
label: "Enterprise support",
282-
id: "console/enterprise_plan/enterprise_support",
283-
customProps: {
284-
tag: "premium",
285-
},
286-
},
287-
{
288-
type: "doc",
289-
label: "Invoices",
290-
id: "console/enterprise_plan/enterprise_invoices",
291-
customProps: {
292-
tag: "premium",
293-
},
294-
},
295-
],
296280
},
297281
{
298282
id: "console/threat_forecast",
@@ -302,6 +286,11 @@ const sidebarsUnversionedConfig: SidebarConfig = {
302286
tag: "premium",
303287
},
304288
},
289+
{
290+
type: "html",
291+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
292+
defaultStyle: false,
293+
},
305294
{
306295
type: "category",
307296
label: "IP Reputation / CTI",
@@ -325,7 +314,7 @@ const sidebarsUnversionedConfig: SidebarConfig = {
325314
},
326315
{
327316
type: "link",
328-
label: "Search Queries Syntax",
317+
label: "Search Queries Syntax 📖",
329318
href: "/u/cti_api/search_queries",
330319
},
331320
],
@@ -353,18 +342,64 @@ const sidebarsUnversionedConfig: SidebarConfig = {
353342
},
354343
{
355344
type: "link",
356-
label: "CTI API Integrations 🔀",
345+
label: "CTI API Integrations 📖",
357346
href: "/u/cti_api/api_integration/integration_intro",
358347
},
359348
{
360349
type: "link",
361-
label: "Technical Documentation 🔀",
350+
label: "Technical Documentation 📖",
362351
href: "/u/cti_api/taxonomy/intro",
363352
},
364353
],
365354
},
366355
],
367356
},
357+
{
358+
type: "html",
359+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
360+
defaultStyle: false,
361+
},
362+
{
363+
type: "category",
364+
label: "Notification integrations",
365+
customProps: {
366+
tag: "premium",
367+
},
368+
items: [
369+
{
370+
type: "doc",
371+
label: "Overview",
372+
id: "console/notification_integrations/overview",
373+
customProps: {
374+
tag: "premium",
375+
},
376+
},
377+
{
378+
type: "doc",
379+
label: "Notification Rule",
380+
id: "console/notification_integrations/rule",
381+
customProps: {
382+
tag: "premium",
383+
},
384+
},
385+
{
386+
type: "doc",
387+
label: "Discord",
388+
id: "console/notification_integrations/discord",
389+
},
390+
{
391+
type: "doc",
392+
label: "Slack",
393+
id: "console/notification_integrations/slack",
394+
},
395+
396+
{
397+
type: "doc",
398+
label: "Webhook",
399+
id: "console/notification_integrations/webhook",
400+
},
401+
],
402+
},
368403
{
369404
type: "category",
370405
label: "Service API",
@@ -442,45 +477,9 @@ const sidebarsUnversionedConfig: SidebarConfig = {
442477
],
443478
},
444479
{
445-
type: "category",
446-
label: "Notification integrations",
447-
customProps: {
448-
tag: "premium",
449-
},
450-
items: [
451-
{
452-
type: "doc",
453-
label: "Overview",
454-
id: "console/notification_integrations/overview",
455-
customProps: {
456-
tag: "premium",
457-
},
458-
},
459-
{
460-
type: "doc",
461-
label: "Notification Rule",
462-
id: "console/notification_integrations/rule",
463-
customProps: {
464-
tag: "premium",
465-
},
466-
},
467-
{
468-
type: "doc",
469-
label: "Discord",
470-
id: "console/notification_integrations/discord",
471-
},
472-
{
473-
type: "doc",
474-
label: "Slack",
475-
id: "console/notification_integrations/slack",
476-
},
477-
478-
{
479-
type: "doc",
480-
label: "Webhook",
481-
id: "console/notification_integrations/webhook",
482-
},
483-
],
480+
type: "html",
481+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
482+
defaultStyle: false,
484483
},
485484
{
486485
type: "doc",

‎crowdsec-docs/src/css/navbar.css‎

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

crowdsec-docs/static/img/console/enterprise_invoices/invoices_invoicing_notification_settings.png renamed to crowdsec-docs/static/img/console/premium_invoices/invoices_invoicing_notification_settings.png

File renamed without changes.

crowdsec-docs/static/img/console/enterprise_invoices/invoices_invoicing_recipients.png renamed to crowdsec-docs/static/img/console/premium_invoices/invoices_invoicing_recipients.png

File renamed without changes.

crowdsec-docs/static/img/console/enterprise_invoices/invoices_settings_menu.png renamed to crowdsec-docs/static/img/console/premium_invoices/invoices_settings_menu.png

File renamed without changes.

crowdsec-docs/static/img/console/enterprise_invoices/invoices_stripe.png renamed to crowdsec-docs/static/img/console/premium_invoices/invoices_stripe.png

File renamed without changes.

crowdsec-docs/static/img/console/enterprise_support/chat.png renamed to crowdsec-docs/static/img/console/premium_support/chat.png

File renamed without changes.

crowdsec-docs/static/img/console/enterprise_support/chat_icon.png renamed to crowdsec-docs/static/img/console/premium_support/chat_icon.png

File renamed without changes.

‎crowdsec-docs/unversioned/console/getting_started-deprecated.mdx‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
id: getting_started
3+
title: Getting started
4+
---
5+
6+
import ConsolePromo from '@site/src/components/console-promo';
7+
8+
# Getting Started
9+
10+
The CrowdSec Console provides a range of tools designed to bolster your infrastructure's security. We offer a range of features that can be tailored to your specific needs, including the ability to manage your Security Engines, subscribe to CrowdSec CTI, and integrate blocklists.
11+
12+
Depending on your use case you may want to start with the following guides:
13+
14+
<ConsolePromo
15+
title="CrowdSec Security Engine"
16+
description="The CrowdSec Security Engine is a powerful, open-source software for detecting and blocking malicious IPs, safeguarding both infrastructure and application security."
17+
image="Hero Security Engine.png"
18+
link="/u/getting_started/post_installation/console/"
19+
/>
20+
<br/>
21+
<ConsolePromo
22+
title="CrowdSec CTI"
23+
description="CrowdSec Cyber Threat Intelligence is the largest and most diverse CTI network on earth, delivering key contextualized and curated benchmarking insights from real users across the globe."
24+
image="Hero CTI Engine.png"
25+
link="/u/cti_api/getting_started/"
26+
/>
27+
<br/>
28+
<ConsolePromo
29+
title="CrowdSec Blocklists"
30+
description="Get immediate protection against active malicious IPs with CrowdSec’s actionable and real-time Blocklists."
31+
image="Hero Blocklists.png"
32+
link="/u/blocklists/getting_started/"
33+
/>
34+
<br/>
35+
If you're new to CrowdSec, we recommend starting with the [Security Engine](/getting_started/introduction.mdx) guide, however, if you are unsure where to start, feel free to browse our [main website for more information](https://www.crowdsec.net/).

0 commit comments

Comments
 (0)