Skip to content

Commit b9ce3f7

Browse files
author
jdv
committed
nano menu fix & canges
1 parent 2cf3c52 commit b9ce3f7

5 files changed

Lines changed: 56 additions & 62 deletions

File tree

‎crowdsec-docs/sidebarsUnversioned.ts‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ const sidebarsUnversionedConfig: SidebarConfig = {
1111
},
1212
{
1313
type: "link",
14-
label: "Web UI 📖",
14+
label: "Web UI",
1515
href: "/u/console/ip_reputation/intro",
16+
customProps: {
17+
tag: "otherSection",
18+
},
1619
},
1720
{
1821
type: "doc",
@@ -45,16 +48,16 @@ const sidebarsUnversionedConfig: SidebarConfig = {
4548
"cti_api/api_integration/integration_thehive",
4649
],
4750
},
48-
{
49-
type: "link",
50-
label: "Swagger",
51-
href: "https://crowdsecurity.github.io/cti-api/",
52-
},
5351
{
5452
type: "html",
5553
value: "<hr style='margin: 0.75rem 0; opacity: 0.35;' />",
5654
defaultStyle: false,
5755
},
56+
{
57+
type: "doc",
58+
label: "Advanced Query Syntax",
59+
id: "cti_api/search_queries",
60+
},
5861
{
5962
type: "category",
6063
label: "Taxonomy",
@@ -69,6 +72,16 @@ const sidebarsUnversionedConfig: SidebarConfig = {
6972
"cti_api/taxonomy/benign",
7073
],
7174
},
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+
},
7285
{
7386
type: "doc",
7487
label: "FAQ",
@@ -314,8 +327,11 @@ const sidebarsUnversionedConfig: SidebarConfig = {
314327
},
315328
{
316329
type: "link",
317-
label: "Search Queries Syntax 📖",
330+
label: "Search Queries Syntax",
318331
href: "/u/cti_api/search_queries",
332+
customProps: {
333+
tag: "otherSection",
334+
},
319335
},
320336
],
321337
},
@@ -342,13 +358,19 @@ const sidebarsUnversionedConfig: SidebarConfig = {
342358
},
343359
{
344360
type: "link",
345-
label: "CTI API Integrations 📖",
361+
label: "CTI API Integrations",
346362
href: "/u/cti_api/api_integration/integration_intro",
363+
customProps: {
364+
tag: "otherSection",
365+
},
347366
},
348367
{
349368
type: "link",
350-
label: "Technical Documentation 📖",
369+
label: "Technical Documentation",
351370
href: "/u/cti_api/taxonomy/intro",
371+
customProps: {
372+
tag: "otherSection",
373+
},
352374
},
353375
],
354376
},

‎crowdsec-docs/src/theme/DocSidebarItem/Link/index.tsx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { ThemeClassNames } from "@docusaurus/theme-common";
55
import { Badge } from "@site/src/ui/badge";
66
import type { Props } from "@theme/DocSidebarItem/Link";
77
import clsx from "clsx";
8-
import { ExternalLinkIcon } from "lucide-react";
8+
import { ExternalLinkIcon, Signpost } from "lucide-react";
99
import React from "react";
1010

1111
export default function DocSidebarItemLink({ item, onItemClick, activePath, level, index, ...props }: Readonly<Props>): React.JSX.Element {
@@ -31,7 +31,7 @@ export default function DocSidebarItemLink({ item, onItemClick, activePath, leve
3131
{
3232
"menu__link--active": isActive,
3333
},
34-
tag ? "flex items-center justify-between" : "flex items-center"
34+
tag === "premium" ? "flex items-center justify-between" : "flex items-center"
3535
)}
3636
autoAddBaseUrl={autoAddBaseUrl}
3737
aria-current={isActive ? "page" : undefined}
@@ -47,6 +47,9 @@ export default function DocSidebarItemLink({ item, onItemClick, activePath, leve
4747
Premium
4848
</Badge>
4949
)}
50+
{tag === "otherSection" && (
51+
<Signpost className="ml-1 h-4 text-foreground/80" />
52+
)}
5053
{!isInternalLink && <ExternalLinkIcon className="ml-1 h-4 text-foreground/80" />}
5154
</Link>
5255
</li>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: getting_started
2+
id: getting_started_deprecated
33
title: Getting started
44
---
55

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import ThemedImage from "@theme/ThemedImage";
77
import useBaseUrl from "@docusaurus/useBaseUrl";
88
import FormattedTabs from '@site/src/components/formatted-tabs';
99

10+
<snippet-extract data-extract="console_signup">
1011
## Sign Up
1112

1213
:::info
@@ -31,7 +32,9 @@ Head over to the [CrowdSec Console ↗️](https://app.crowdsec.net/signup) and
3132
If you have chosen to sign up with email and password, you will receive a verification email. Click the link or enter the code to verify your account
3233

3334
:::info
34-
If you do not receive an email, check your spam folder. If it is still missing, click "Resend verification email" on the login page.
35+
If you do not receive an email, check your spam folder.
36+
If it is still missing, click "Resend verification email" on the login page.
37+
3538
_If more than 5 minutes have passed, [contact us](mailto:support@crowdsec.net)._
3639
:::
3740

@@ -49,4 +52,5 @@ When you log in for the first time, we ask a few questions to understand your us
4952

5053
:::info
5154
The survey is optional. We use the information to tailor your experience and better understand users.
52-
:::
55+
:::
56+
</snippet-extract>

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

Lines changed: 13 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,60 +9,25 @@ import FormattedTabs from '@site/src/components/formatted-tabs';
99

1010
# Enroll your Security Engine in CrowdSec Console
1111

12-
The CrowdSec Console is a web interface for managing your CrowdSec Security Engines.
13-
It provides dashboards and activity views to make monitoring and analysis easier.
14-
The Console also lets you add advanced features, including third-party blocklists, so you can extend protection with external intelligence.
15-
This guide assumes CrowdSec is already installed. If not, start with one of these guides:
12+
The CrowdSec Console is a web interface providing management and extra features for CrowdSec Products.
13+
14+
For Security Engine users, the Console offers:
15+
- A centralized view of your security posture across all your machines.
16+
- The ability to manage additional blocklists
17+
- And many quality of life and advanced features to enhance your protection.
18+
19+
The following guide assumes you have successfully installed one or more CrowdSec Security Engines.
20+
If not, start with one of these guides:
1621

1722
- [Install on Linux](/getting_started/installation/linux.mdx)
1823
- [Install on FreeBSD](/getting_started/installation/freebsd.mdx)
1924
- [Install on Windows](/getting_started/installation/windows.mdx)
2025
- [Install on MacOS](/getting_started/installation/macos.mdx)
2126
- [Install on Kubernetes](/getting_started/installation/kubernetes.mdx)
2227

23-
### Sign Up
24-
25-
Head over to the [CrowdSec Console](https://app.crowdsec.net/signup) and sign up for a new account.
26-
27-
<a href="https://app.crowdsec.net/signup" target="_blank">
28-
<ThemedImage
29-
alt="CrowdSec Signup Screen"
30-
sources={{
31-
light: useBaseUrl("/img/console_login_light.png"),
32-
dark: useBaseUrl("/img/console_login_dark.png"),
33-
}}
34-
/>
35-
</a>
36-
37-
### Verify Email
38-
39-
After signing up, you will receive a verification email. Click the link or enter the code to verify your account.
40-
41-
#### Missing Email?
42-
43-
If you do not receive an email, check your spam folder. If it is still missing, click "Resend verification email" on the login page.
44-
45-
:::info
46-
If more than 5 minutes have passed, [contact us](mailto:support@crowdsec.net).
47-
:::
48-
49-
### Survey
50-
51-
When you log in for the first time, we ask a few questions to understand your use case.
52-
53-
<ThemedImage
54-
alt="CrowdSec Survey"
55-
sources={{
56-
light: useBaseUrl("/img/console_signup_survey_light.png"),
57-
dark: useBaseUrl("/img/console_signup_survey_dark.png"),
58-
}}
59-
/>
60-
61-
:::info
62-
The survey is optional. We use the information to tailor your experience and better understand users.
63-
:::
28+
<snippet-extract data-extract-copy="getting_started:console_signup"></snippet-extract>
6429

65-
### Engines page
30+
## Engines page
6631

6732
After signing up, the first page you see is the engines page, where you can view enrolled engines and their status.
6833

@@ -106,7 +71,7 @@ INFO[2024-02-21T16:50:17Z] Please restart crowdsec after accepting the enrollmen
10671
```
10772

10873

109-
### Accept enrollment
74+
## Accept enrollment
11075

11176
Once you execute the command, a new engine appears on the engines page. Select it and click "Accept enroll."
11277

@@ -122,7 +87,7 @@ Once you execute the command, a new engine appears on the engines page. Select i
12287
If you do not see the engine, use the refresh button near "Add Security Engine".
12388
:::
12489

125-
### Restart CrowdSec
90+
## Restart CrowdSec
12691

12792
After accepting the enrollment, restart the CrowdSec service.
12893

0 commit comments

Comments
 (0)