Skip to content

Commit 35ecdfb

Browse files
rr404jdv
rr404
and
jdv
authored
CTI options addition + CTI doc lint (#1064)
* CTI GUI things moving to Console Section * CTI renamed to IP Reputation / CTI * Addint premium cti key doc * Vairous improvements on CTI related side bars and content --------- Co-authored-by: jdv <julien@crowdsec.net>
1 parent 21a46f0 commit 35ecdfb

46 files changed

Lines changed: 536 additions & 765 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎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: 171 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -10,65 +10,17 @@ const sidebarsUnversionedConfig: SidebarConfig = {
1010
id: "cti_api/intro",
1111
},
1212
{
13-
type: "category",
13+
type: "link",
1414
label: "Web UI",
15-
items: [
16-
{
17-
type: "doc",
18-
label: "Getting Started",
19-
id: "cti_api/getting_started",
20-
},
21-
{
22-
type: "doc",
23-
label: "IP Report",
24-
id: "cti_api/ip_report",
25-
},
26-
{
27-
type: "doc",
28-
label: "Advanced Search",
29-
id: "cti_api/advanced_search",
30-
},
31-
{
32-
type: "doc",
33-
label: "Search Queries",
34-
id: "cti_api/search_queries",
35-
},
36-
{
37-
type: "doc",
38-
label: "CVE Explorer",
39-
id: "cti_api/cve_explorer",
40-
},
41-
],
42-
},
43-
{
44-
type: "category",
45-
label: "API",
46-
items: [
47-
{
48-
type: "doc",
49-
label: "Getting Started",
50-
id: "cti_api/api_getting_started",
51-
},
52-
{
53-
type: "link",
54-
label: "Swagger",
55-
href: "https://crowdsecurity.github.io/cti-api/",
56-
},
57-
],
15+
href: "/u/console/ip_reputation/intro",
16+
customProps: {
17+
tag: "otherSection",
18+
},
5819
},
5920
{
60-
type: "category",
61-
label: "Taxonomy",
62-
items: [
63-
"cti_api/taxonomy/intro",
64-
"cti_api/taxonomy/cti_object",
65-
"cti_api/taxonomy/scores",
66-
"cti_api/taxonomy/scenarios",
67-
"cti_api/taxonomy/behaviors",
68-
"cti_api/taxonomy/classifications",
69-
"cti_api/taxonomy/false_positives",
70-
"cti_api/taxonomy/benign",
71-
],
21+
type: "doc",
22+
label: "API Access",
23+
id: "cti_api/api_introduction",
7224
},
7325
{
7426
type: "category",
@@ -96,6 +48,40 @@ const sidebarsUnversionedConfig: SidebarConfig = {
9648
"cti_api/api_integration/integration_thehive",
9749
],
9850
},
51+
{
52+
type: "html",
53+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
54+
defaultStyle: false,
55+
},
56+
{
57+
type: "doc",
58+
label: "Advanced Query Syntax",
59+
id: "cti_api/search_queries",
60+
},
61+
{
62+
type: "category",
63+
label: "Taxonomy",
64+
items: [
65+
"cti_api/taxonomy/intro",
66+
"cti_api/taxonomy/cti_object",
67+
"cti_api/taxonomy/scores",
68+
"cti_api/taxonomy/scenarios",
69+
"cti_api/taxonomy/behaviors",
70+
"cti_api/taxonomy/classifications",
71+
"cti_api/taxonomy/false_positives",
72+
"cti_api/taxonomy/benign",
73+
],
74+
},
75+
{
76+
type: "html",
77+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
78+
defaultStyle: false,
79+
},
80+
{
81+
type: "link",
82+
label: "Swagger",
83+
href: "https://crowdsecurity.github.io/cti-api/",
84+
},
9985
{
10086
type: "doc",
10187
label: "FAQ",
@@ -140,6 +126,11 @@ const sidebarsUnversionedConfig: SidebarConfig = {
140126
label: "Getting Started",
141127
id: "console/getting_started",
142128
},
129+
{
130+
type: "html",
131+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
132+
defaultStyle: false,
133+
},
143134
{
144135
type: "category",
145136
label: "Security Engine",
@@ -208,11 +199,6 @@ const sidebarsUnversionedConfig: SidebarConfig = {
208199
},
209200
],
210201
},
211-
{
212-
label: "Blocklists",
213-
type: "doc",
214-
id: "blocklists/intro",
215-
},
216202
{
217203
type: "category",
218204
label: "Alerts",
@@ -287,6 +273,16 @@ const sidebarsUnversionedConfig: SidebarConfig = {
287273
},
288274
],
289275
},
276+
{
277+
type: "html",
278+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
279+
defaultStyle: false,
280+
},
281+
{
282+
label: "Blocklists",
283+
type: "doc",
284+
id: "blocklists/intro",
285+
},
290286
{
291287
id: "console/allowlists",
292288
type: "doc",
@@ -295,44 +291,137 @@ const sidebarsUnversionedConfig: SidebarConfig = {
295291
tag: "premium",
296292
},
297293
},
294+
{
295+
id: "console/threat_forecast",
296+
type: "doc",
297+
label: "Threat Forecast",
298+
customProps: {
299+
tag: "premium",
300+
},
301+
},
302+
{
303+
type: "html",
304+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
305+
defaultStyle: false,
306+
},
307+
{
308+
type: "category",
309+
label: "IP Reputation / CTI",
310+
link: {
311+
type: "doc",
312+
id: "console/ip_reputation/intro",
313+
},
314+
items: [
315+
{
316+
type: "category",
317+
label: "Search UI",
318+
link: {
319+
type: "doc",
320+
id: "console/ip_reputation/search_ui",
321+
},
322+
items: [
323+
{
324+
type: "doc",
325+
label: "Advanced Search",
326+
id: "console/ip_reputation/search_ui_advanced",
327+
},
328+
{
329+
type: "link",
330+
label: "Search Queries Syntax",
331+
href: "/u/cti_api/search_queries",
332+
customProps: {
333+
tag: "otherSection",
334+
},
335+
},
336+
],
337+
},
338+
{
339+
type: "doc",
340+
label: "IP Reputation Report",
341+
id: "console/ip_reputation/ip_report",
342+
},
343+
{
344+
type: "category",
345+
label: "API Keys",
346+
link: {
347+
type: "doc",
348+
id: "console/ip_reputation/api_keys",
349+
},
350+
items: [
351+
{
352+
type: "doc",
353+
label: "Premium API Keys",
354+
id: "console/ip_reputation/api_keys_premium",
355+
customProps: {
356+
tag: "premium",
357+
},
358+
},
359+
{
360+
type: "link",
361+
label: "CTI API Integrations",
362+
href: "/u/cti_api/api_integration/integration_intro",
363+
customProps: {
364+
tag: "otherSection",
365+
},
366+
},
367+
{
368+
type: "link",
369+
label: "Enrichment Fields Ref",
370+
href: "/u/cti_api/taxonomy/intro",
371+
customProps: {
372+
tag: "otherSection",
373+
},
374+
},
375+
],
376+
},
377+
],
378+
},
379+
{
380+
type: "html",
381+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
382+
defaultStyle: false,
383+
},
298384
{
299385
type: "category",
300-
label: "Enterprise plan",
386+
label: "Notification integrations",
301387
customProps: {
302388
tag: "premium",
303389
},
304390
items: [
305391
{
306392
type: "doc",
307-
label: "Enterprise support",
308-
id: "console/enterprise_plan/enterprise_support",
393+
label: "Overview",
394+
id: "console/notification_integrations/overview",
309395
customProps: {
310396
tag: "premium",
311397
},
312398
},
313399
{
314400
type: "doc",
315-
label: "Invoices",
316-
id: "console/enterprise_plan/enterprise_invoices",
401+
label: "Notification Rule",
402+
id: "console/notification_integrations/rule",
317403
customProps: {
318404
tag: "premium",
319405
},
320406
},
407+
{
408+
type: "doc",
409+
label: "Discord",
410+
id: "console/notification_integrations/discord",
411+
},
412+
{
413+
type: "doc",
414+
label: "Slack",
415+
id: "console/notification_integrations/slack",
416+
},
417+
418+
{
419+
type: "doc",
420+
label: "Webhook",
421+
id: "console/notification_integrations/webhook",
422+
},
321423
],
322424
},
323-
{
324-
id: "console/threat_forecast",
325-
type: "doc",
326-
label: "Threat Forecast",
327-
customProps: {
328-
tag: "premium",
329-
},
330-
},
331-
{
332-
type: "link",
333-
label: "CTI",
334-
href: "/u/cti_api/intro",
335-
},
336425
{
337426
type: "category",
338427
label: "Service API",
@@ -410,45 +499,9 @@ const sidebarsUnversionedConfig: SidebarConfig = {
410499
],
411500
},
412501
{
413-
type: "category",
414-
label: "Notification integrations",
415-
customProps: {
416-
tag: "premium",
417-
},
418-
items: [
419-
{
420-
type: "doc",
421-
label: "Overview",
422-
id: "console/notification_integrations/overview",
423-
customProps: {
424-
tag: "premium",
425-
},
426-
},
427-
{
428-
type: "doc",
429-
label: "Notification Rule",
430-
id: "console/notification_integrations/rule",
431-
customProps: {
432-
tag: "premium",
433-
},
434-
},
435-
{
436-
type: "doc",
437-
label: "Discord",
438-
id: "console/notification_integrations/discord",
439-
},
440-
{
441-
type: "doc",
442-
label: "Slack",
443-
id: "console/notification_integrations/slack",
444-
},
445-
446-
{
447-
type: "doc",
448-
label: "Webhook",
449-
id: "console/notification_integrations/webhook",
450-
},
451-
],
502+
type: "html",
503+
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
504+
defaultStyle: false,
452505
},
453506
{
454507
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.

0 commit comments

Comments
 (0)