Skip to content

Commit 7c3b445

Browse files
LaurenceJJonesLaurenceJJones
authored
enhancement: css fixes and add customgpt on main page and footer (#828)
* enhancement: css fixes and add customgpt on main page and footer * enhancement: go lint myself * enhancement: go lint myself * enhancement: update css and section single/multi server * enhance: CTI on mainbar * enhance: Fix styling on console promo * enhance: fix redirects * enhance: add cti page to console that links to cti_api * enhance: fix cti navigation * enhance: move integrations
1 parent 8c5f43e commit 7c3b445

Some content is hidden

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

46 files changed

+375
-243
lines changed

‎crowdsec-docs/docusaurus.config.ts‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,7 @@ const NAVBAR_ITEMS: NavbarItem[] = [
8686
position: "left",
8787
label: "Blocklists",
8888
},
89-
{
90-
label: "API(s)",
91-
position: "left",
92-
items: [
93-
{ label: "CTI API", to: "/u/cti_api/getting_started" },
94-
{ label: "Service API 🏅", to: "/u/service_api/getting_started" },
95-
],
96-
},
89+
{ to: "/u/cti_api/intro", position: "left", label: "CTI" },
9790
{ to: "/u/console/intro", position: "left", label: "Console" },
9891
{
9992
label: "Resources",
@@ -147,6 +140,8 @@ const FOOTER_LINKS = [
147140
{ label: "Discourse", href: "https://discourse.crowdsec.net/" },
148141
{ label: "Discord", href: "https://discord.gg/crowdsec" },
149142
{ label: "Twitter", href: "https://twitter.com/crowd_security" },
143+
{ label: "LinkedIn", href: "https://www.linkedin.com/company/crowdsec/" },
144+
{ label: "YouTube", href: "https://www.youtube.com/@crowdsec" },
150145
],
151146
},
152147
{
@@ -159,6 +154,8 @@ const FOOTER_LINKS = [
159154
label: "Tutorial",
160155
href: "https://crowdsec.net/blog/category/tutorial/",
161156
},
157+
{ label: "Academy", href: "https://academy.crowdsec.net/" },
158+
{ label: "Custom GPT", href: "https://chatgpt.com/g/g-682c3a61a78081918417571116c2b563-crowdsec-documentation" },
162159
],
163160
},
164161
];
@@ -182,11 +179,11 @@ const redirects = [
182179
to: "/u/getting_started/installation/freebsd",
183180
},
184181
{
185-
from: "/docs/next/getting_started/install_crowdsec",
182+
from: "/docs/getting_started/install_crowdsec",
186183
to: "/u/getting_started/installation/linux",
187184
},
188185
{
189-
from: "/docs/next/getting_started/install_crowdsec_freebsd",
186+
from: "/docs/getting_started/install_crowdsec_freebsd",
190187
to: "/u/getting_started/installation/freebsd",
191188
},
192189
];
@@ -306,6 +303,7 @@ const config: Config = {
306303
sidebarPath: "./sidebarsUnversioned.ts",
307304
},
308305
],
306+
309307
["./plugins/gtag/index.ts", { trackingID: "G-0TFBMNTDFQ" }],
310308
["@docusaurus/plugin-client-redirects", { redirects }],
311309
tailwindPlugin,

‎crowdsec-docs/sidebarsUnversioned.ts‎

Lines changed: 147 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -9,59 +9,96 @@ const sidebarsUnversionedConfig: SidebarConfig = {
99
label: "Introduction",
1010
id: "cti_api/intro",
1111
},
12-
{
13-
type: "doc",
14-
label: "Getting Started",
15-
id: "cti_api/getting_started",
16-
},
1712
{
1813
type: "category",
19-
label: "Taxonomy",
14+
label: "Web UI",
2015
items: [
21-
"cti_api/taxonomy/intro",
22-
"cti_api/taxonomy/cti_object",
23-
"cti_api/taxonomy/scores",
24-
"cti_api/taxonomy/scenarios",
25-
"cti_api/taxonomy/behaviors",
26-
"cti_api/taxonomy/classifications",
27-
"cti_api/taxonomy/false_positives",
28-
"cti_api/taxonomy/benign",
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+
},
2941
],
3042
},
3143
{
32-
type: "link",
33-
label: "Swagger",
34-
href: "https://crowdsecurity.github.io/cti-api/",
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: "category",
54+
label: "Taxonomy",
55+
items: [
56+
"cti_api/taxonomy/intro",
57+
"cti_api/taxonomy/cti_object",
58+
"cti_api/taxonomy/scores",
59+
"cti_api/taxonomy/scenarios",
60+
"cti_api/taxonomy/behaviors",
61+
"cti_api/taxonomy/classifications",
62+
"cti_api/taxonomy/false_positives",
63+
"cti_api/taxonomy/benign",
64+
],
65+
},
66+
{
67+
type: "link",
68+
label: "Swagger",
69+
href: "https://crowdsecurity.github.io/cti-api/",
70+
},
71+
],
3572
},
3673
{
3774
type: "category",
3875
label: "Integrations",
3976
link: {
4077
type: "doc",
41-
id: "cti_api/integration_intro",
78+
id: "cti_api/api_integration/integration_intro",
4279
},
4380
items: [
44-
"cti_api/integration_ipdex",
45-
"cti_api/integration_chrome",
46-
"cti_api/integration_gigasheet",
47-
"cti_api/integration_intelowl",
48-
"cti_api/integration_maltego",
49-
"cti_api/integration_misp",
50-
"cti_api/integration_msticpy",
51-
"cti_api/integration_opencti",
52-
"cti_api/integration_paloalto_xsoar",
53-
"cti_api/integration_qradar",
54-
"cti_api/integration_securitycopilot",
55-
"cti_api/integration_sekoia_xdr",
56-
"cti_api/integration_splunk_siem",
57-
"cti_api/integration_splunk_soar",
58-
"cti_api/integration_thehive",
81+
"cti_api/api_integration/integration_ipdex",
82+
"cti_api/api_integration/integration_chrome",
83+
"cti_api/api_integration/integration_gigasheet",
84+
"cti_api/api_integration/integration_intelowl",
85+
"cti_api/api_integration/integration_maltego",
86+
"cti_api/api_integration/integration_misp",
87+
"cti_api/api_integration/integration_msticpy",
88+
"cti_api/api_integration/integration_opencti",
89+
"cti_api/api_integration/integration_paloalto_xsoar",
90+
"cti_api/api_integration/integration_qradar",
91+
"cti_api/api_integration/integration_securitycopilot",
92+
"cti_api/api_integration/integration_sekoia_xdr",
93+
"cti_api/api_integration/integration_splunk_siem",
94+
"cti_api/api_integration/integration_splunk_soar",
95+
"cti_api/api_integration/integration_thehive",
5996
],
6097
},
6198
{
6299
type: "doc",
63-
label: "Search Queries",
64-
id: "cti_api/search_queries",
100+
label: "FAQ",
101+
id: "cti_api/faq",
65102
},
66103
],
67104
consoleSidebar: [
@@ -196,42 +233,6 @@ const sidebarsUnversionedConfig: SidebarConfig = {
196233
label: "Remediation Metrics",
197234
id: "console/remediation_metrics",
198235
},
199-
{
200-
type: "category",
201-
label: "CTI",
202-
items: [
203-
{
204-
type: "doc",
205-
label: "Getting started",
206-
id: "console/cti/getting_started",
207-
},
208-
{
209-
type: "doc",
210-
label: "CTI API Keys",
211-
id: "console/cti/cti_api_keys",
212-
},
213-
{
214-
type: "doc",
215-
label: "IP report",
216-
id: "console/cti/ip_report",
217-
},
218-
{
219-
type: "doc",
220-
label: "Advanced search",
221-
id: "console/cti/advanced_search",
222-
},
223-
{
224-
type: "doc",
225-
label: "CVE Explorer",
226-
id: "console/cti/cve_explorer",
227-
},
228-
{
229-
type: "doc",
230-
label: "FAQ",
231-
id: "console/cti/faq",
232-
},
233-
],
234-
},
235236
{
236237
type: "category",
237238
label: "Decision",
@@ -293,11 +294,84 @@ const sidebarsUnversionedConfig: SidebarConfig = {
293294
},
294295
{
295296
type: "link",
297+
label: "CTI",
298+
href: "/u/cti_api/intro",
299+
},
300+
{
301+
type: "category",
296302
label: "Service API",
297-
href: "/u/service_api/getting_started",
298303
customProps: {
299304
tag: "premium",
300305
},
306+
items: [
307+
{
308+
type: "doc",
309+
id: "console/service_api/getting_started",
310+
label: "Getting Started",
311+
customProps: {
312+
tag: "premium",
313+
},
314+
},
315+
{
316+
type: "category",
317+
label: "Quickstart",
318+
customProps: {
319+
tag: "premium",
320+
},
321+
items: [
322+
"console/service_api/quickstart/authentication",
323+
"console/service_api/quickstart/blocklists",
324+
"console/service_api/quickstart/integrations",
325+
"console/service_api/quickstart/allowlists",
326+
"console/service_api/quickstart/metrics",
327+
],
328+
},
329+
{
330+
type: "doc",
331+
label: "Blocklists",
332+
id: "console/service_api/blocklists",
333+
},
334+
{
335+
type: "doc",
336+
label: "Integrations",
337+
id: "console/service_api/integrations",
338+
},
339+
{
340+
type: "category",
341+
label: "SDKs",
342+
customProps: {
343+
tag: "premium",
344+
},
345+
items: [
346+
{
347+
type: "doc",
348+
label: "Python",
349+
id: "console/service_api/sdks/python",
350+
customProps: {
351+
tag: "premium",
352+
},
353+
},
354+
],
355+
},
356+
{
357+
type: "link",
358+
label: "Swagger",
359+
href: "https://admin.api.crowdsec.net/v1/docs#/",
360+
},
361+
{
362+
type: "link",
363+
label: "Redoc",
364+
href: "https://admin.api.crowdsec.net/v1/redoc",
365+
},
366+
{
367+
type: "doc",
368+
id: "console/service_api/faq",
369+
label: "FAQ",
370+
customProps: {
371+
tag: "premium",
372+
},
373+
},
374+
],
301375
},
302376
{
303377
type: "category",
@@ -533,50 +607,7 @@ const sidebarsUnversionedConfig: SidebarConfig = {
533607
label: "CTI",
534608
},
535609
],
536-
serviceApiSideBar: [
537-
{
538-
type: "doc",
539-
id: "service_api/getting_started",
540-
label: "Getting Started",
541-
},
542-
{
543-
type: "category",
544-
label: "Quickstart",
545-
items: [
546-
"service_api/quickstart/authentication",
547-
"service_api/quickstart/blocklists",
548-
"service_api/quickstart/integrations",
549-
"service_api/quickstart/allowlists",
550-
"service_api/quickstart/metrics",
551-
],
552-
},
553-
{
554-
type: "category",
555-
label: "SDKs",
556-
items: [
557-
{
558-
type: "doc",
559-
label: "Python",
560-
id: "service_api/sdks/python",
561-
},
562-
],
563-
},
564-
{
565-
type: "link",
566-
label: "Swagger",
567-
href: "https://admin.api.crowdsec.net/v1/docs#/",
568-
},
569-
{
570-
type: "link",
571-
label: "Redoc",
572-
href: "https://admin.api.crowdsec.net/v1/redoc",
573-
},
574-
{
575-
type: "doc",
576-
id: "service_api/faq",
577-
label: "FAQ",
578-
},
579-
],
610+
580611
guidesSideBar: [
581612
"user_guides/intro",
582613
{
@@ -705,7 +736,6 @@ export const {
705736
remediationSideBar,
706737
blocklistsSideBar,
707738
troubleshootingSideBar,
708-
serviceApiSideBar,
709739
guidesSideBar,
710740
gettingStarted,
711741
} = sidebarsUnversionedConfig;

0 commit comments

Comments
 (0)