Skip to content

Commit 06d0851

Browse files
rr404jdv
andauthored
Readeability adjustements (#1077)
* css adjsutments for readeability and — repalcement in content recently added by me --------- Co-authored-by: jdv <julien@crowdsec.net>
1 parent 8ce10de commit 06d0851

23 files changed

Lines changed: 73 additions & 72 deletions

File tree

crowdsec-docs/docs/appsec/quickstart/haproxy_spoa.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Make sure the following are already done on the machine running HAProxy (each is
1313

1414
1. **CrowdSec Security Engine** installed and running — see the [Linux quickstart](/u/getting_started/installation/linux).
1515
2. **HAProxy** already running and proxying your application(s).
16-
3. **HAProxy SPOA bouncer** (`crowdsec-haproxy-spoa-bouncer`) installed and registered against the CrowdSec LAPI — see the [SPOA bouncer guide](/u/bouncers/haproxy_spoa).
16+
3. **HAProxy SPOA bouncer** (`crowdsec-haproxy-spoa-bouncer`) installed and registered against the CrowdSec LAPI. See the [SPOA bouncer guide](/u/bouncers/haproxy_spoa).
1717

1818
## 1. Install the AppSec rule collections
1919

crowdsec-docs/docs/appsec/rules_deploy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ labels:
4040
4141
Once the rule behaves as expected, the remaining steps package it for CrowdSec, wire it into the acquisition pipeline, and test it end to end.
4242
43-
## Step 1 Stage the Rule File
43+
## Step 1 - Stage the Rule File
4444
4545
CrowdSec loads AppSec rules from `/etc/crowdsec/appsec-rules/`. Copy your YAML rule into that directory (create a `custom/` subfolder to keep things tidy if you manage several rules):
4646

@@ -56,7 +56,7 @@ Make sure the `name` inside the rule file matches the file name convention you p
5656
If you run CrowdSec in a container, copy the file into the volume that is mounted at `/etc/crowdsec/appsec-rules/` inside the container.
5757
:::
5858

59-
## Step 2 Create an AppSec Configuration
59+
## Step 2 - Create an AppSec Configuration
6060

6161
An AppSec configuration lists which rules to load and how to handle matches. Create a new file under `/etc/crowdsec/appsec-configs/` that targets your custom rule:
6262

@@ -73,7 +73,7 @@ Key points:
7373
- `inband_rules` (and/or `outofband_rules`) accept glob patterns, so you can load multiple rules with a single entry such as `custom/block-*`.
7474
- During the reload step CrowdSec validates the syntax; if anything is off, the reload fails and the service logs the parsing error.
7575

76-
## Step 3 Reference the Configuration in the Acquisition File
76+
## Step 3 - Reference the Configuration in the Acquisition File
7777

7878
The AppSec acquisition file (`/etc/crowdsec/acquis.d/appsec.yaml`) controls which configurations are active for the WAF component. Add your configuration to the `appsec_configs` list. Order matters: later entries override conflicting defaults such as `default_remediation`.
7979

@@ -89,7 +89,7 @@ source: appsec
8989

9090
If you only want to run your custom configuration, remove other entries and keep the list with a single item.
9191

92-
## Step 4 Reload CrowdSec and Validate the Load
92+
## Step 4 - Reload CrowdSec and Validate the Load
9393

9494
Apply the changes by reloading the CrowdSec service:
9595

@@ -106,7 +106,7 @@ sudo cscli appsec-configs list | grep block-nonnumeric-user-id
106106

107107
The rule should appear as `enabled`, and the configuration should show up in the list. CrowdSec logs confirm the configuration was loaded without errors.
108108

109-
## Step 5 Functional Test with `curl`
109+
## Step 5 - Functional Test with `curl`
110110

111111
Trigger the behaviour your rule is meant to catch to ensure it blocks as expected. For the example rule, send a request with a non-numeric `user_id` value:
112112

crowdsec-docs/docs/getting_started/sdk_intro.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ CrowdSec offers lightweight SDKs for Python and PHP to help developers seamlessl
99
By using these SDKs, you can report signals such as suspicious IP activity or confirmed attacks directly to the Central API (CAPI). In return, your users gain access to the CrowdSec Community Blocklist, a curated and constantly updated list of IPs involved in malicious behavior observed across the global CrowdSec network.
1010

1111
Why Integrate the SDK:
12-
- **Simple Integration** Add signal sharing with just a few lines of code
13-
- **Community-Powered Protection** Contributions help power our global threat intelligence network
14-
- **Mutual Benefit** Your platform shares valuable intelligence and gains stronger real-time protection in return
12+
- **Simple Integration**: Add signal sharing with just a few lines of code
13+
- **Community-Powered Protection**: Contributions help power our global threat intelligence network
14+
- **Mutual Benefit**: Your platform shares valuable intelligence and gains stronger real-time protection in return
1515

1616
## Supported SDKs
1717

crowdsec-docs/docs/intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Under the hood, the Security Engine has various components:
5454
- The [Local API](local_api/intro.md) acts as a middleman:
5555
- Between the [Log Processors](/log_processor/intro.mdx) and the [Remediation Components](/u/bouncers/intro) which are in charge of enforcing decisions.
5656
- And with the [Central API](/central_api/intro.md) to share alerts and receive blocklists.
57-
- The [Remediation Components](/u/bouncers/intro) (also called bouncers) block malicious IPs at your chosen levelIpTables, firewalls, web servers, or reverse proxies. [See the full list on the CrowdSec Hub.](https://app.crowdsec.net/hub/remediation-components)
57+
- The [Remediation Components](/u/bouncers/intro) (also called bouncers) block malicious IPs at your chosen level: IpTables, firewalls, web servers, or reverse proxies. [See the full list on the CrowdSec Hub.](https://app.crowdsec.net/hub/remediation-components)
5858

5959
## Deployment options
6060

crowdsec-docs/src/components/data/cti-integrations.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const ctiIntegrations: CtiIntegrationData[] = [
1313
slug: "ipdex",
1414
href: "/u/cti_api/api_integration/integration_ipdex",
1515
plugin: "CrowdSec CTI Reports",
16-
desc: "IPDEX extracts IP addresses from your logs and cross-references them against CrowdSec's global threat intelligence network instantly.",
16+
desc: "IPDEX extracts IP addresses from your logs and cross-references them against CrowdSec's global threat intelligence network instantly.",
1717
color: "#e55c2f",
1818
},
1919
{
@@ -29,7 +29,7 @@ export const ctiIntegrations: CtiIntegrationData[] = [
2929
slug: "gigasheet",
3030
href: "/u/cti_api/api_integration/integration_gigasheet",
3131
plugin: "No-Code API Enrichment",
32-
desc: "Enrich spreadsheet columns with CTI data using Gigasheet's no-code API enrichment feature — no scripting required.",
32+
desc: "Enrich spreadsheet columns with CTI data using Gigasheet's no-code API enrichment feature. No scripting required.",
3333
color: "#00b4d8",
3434
},
3535
{

crowdsec-docs/src/css/code.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
}
66

77
pre {
8-
@apply rounded-lg font-semibold;
8+
@apply rounded-lg font-medium;
99
}
1010

1111
.prism-code .token.plain {
@@ -18,5 +18,5 @@ pre {
1818
}
1919

2020
code:not(.prism-code code) {
21-
@apply bg-gray-100 dark:bg-gray-50 border-primary/20 border-solid border text-primary px-1 py-0.5 rounded-md font-semibold;
21+
@apply bg-gray-100 dark:bg-gray-50 border-primary/20 border-solid border text-primary px-1 py-0.5 rounded-md font-medium;
2222
}

crowdsec-docs/src/css/colors.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,8 @@ html[data-theme="dark"],
192192
--ifm-global-shadow-md: 0px;
193193
--ifm-code-font-size: 95%;
194194
--ifm-font-family-base: "Instrument Sans", sans-serif; /* For body text */
195-
--ifm-font-family-monospace: "Courier New", monospace; /* For code blocks */
195+
--ifm-font-family-monospace:
196+
"Roboto Mono", ui-monospace, "SF Mono", "Cascadia Mono", "Segoe UI Mono", Menlo, Consolas, monospace; /* For code blocks */
196197
--ifm-dropdown-background-color: rgb(var(--card));
197198

198199
/* Algolia global search colors */

crowdsec-docs/src/css/custom.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
@import url("https://fonts.googleapis.com/css2?family=Instrument+Sans:ital,wght@0,400..700;1,400..700&display=swap");
1+
@import url("https://fonts.googleapis.com/css2?family=Instrument+Sans:ital,wght@0,400..700;1,400..700&family=Roboto+Mono:wght@400;500&display=swap");
22

33
@import "tailwindcss/base";
44
@import "tailwindcss/components";
@@ -113,7 +113,7 @@ div.markdown {
113113
padding: 14px 16px;
114114
}
115115

116-
/* Quick-access strip label + pill buttons in a row (matches homepage "Already running?" strip) */
116+
/* Quick-access strip - label + pill buttons in a row (matches homepage "Already running?" strip) */
117117
.doc-quick-strip {
118118
display: flex;
119119
align-items: center;

crowdsec-docs/src/pages/index.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ const SchemaBlock = ({ id, color, eyebrowIcon, eyebrow, title, ctaLabel, ctaHref
183183
}}
184184
/>
185185

186-
{/* header always visible, clickable to toggle */}
186+
{/* header - always visible, clickable to toggle */}
187187
<button
188188
type="button"
189189
onClick={onToggle}
@@ -359,7 +359,7 @@ const intents: IntentCardProps[] = [
359359
icon: <img src="/img/icons/shield.webp" className="h-8 w-8 border-0" alt="Blocklists" />,
360360
accent: GREEN,
361361
title: "Push a Blocklists into my firewall, CDN or WAF",
362-
desc: "You manage network perimeter devices and want a URL to subscribe to — no agent to install.",
362+
desc: "You manage network perimeter devices and want a URL to subscribe to. No agent to install.",
363363
pill: "Blocklist Integration Endpoint",
364364
href: "/blocklists",
365365
aka: ["Threat Feeds", "IOC Streams", "Deny-list"],
@@ -389,7 +389,7 @@ const schemas: Omit<SchemaBlockProps, "open" | "onToggle">[] = [
389389
num: 1,
390390
icon: "⚡",
391391
title: "Install the Security Engine",
392-
desc: "Runs on your server, detects attack patterns in real time — immediately protected, and continuously updated with CrowdSec Community Blocklist.",
392+
desc: "Runs on your server, detects attack patterns in real time. Immediately protected, and continuously updated with CrowdSec Community Blocklist.",
393393
},
394394
{
395395
num: 2,
@@ -448,15 +448,15 @@ const schemas: Omit<SchemaBlockProps, "open" | "onToggle">[] = [
448448
color: BLUE,
449449
eyebrowIcon: "🔍",
450450
eyebrow: "IP Reputation & CTI",
451-
title: "Query threat intel in the browser or via API in your tools",
451+
title: "Query threat intel in the browser or via API in your tools",
452452
ctaLabel: "Explore CTI →",
453453
ctaHref: "/u/cti_api/intro",
454454
steps: [
455455
{
456456
num: 1,
457457
icon: "🖥️",
458458
title: "Look up any IP in the Console",
459-
desc: "Search instantly from our Web UI— get reputation score, behaviors, attack history, and CVE links.",
459+
desc: "Search instantly from our Web UI. Get reputation score, behaviors, attack history, and CVE links.",
460460
},
461461
{
462462
num: 2,
@@ -610,7 +610,7 @@ const HomePage = () => {
610610
</div>
611611
</section>
612612

613-
{/* How each path works accordion */}
613+
{/* How each path works - accordion */}
614614
<section className="py-6 px-4">
615615
<div className="container mx-auto" style={{ maxWidth: "940px" }}>
616616
<div

crowdsec-docs/unversioned/bouncers/cloudflare-workers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ The Remediation Component does the following:
293293

294294
:::info
295295
Autonomous mode is ideal for users who prefer not to run a continuous process on their host/VM.
296-
Combined with [Blocklist as a Service (BLaaS)](/u/integrations/remediationcomponent), this provides the minimal footprint deploymentonly running setup/cleanup commands when needed.
296+
Combined with [Blocklist as a Service (BLaaS)](/u/integrations/remediationcomponent), this provides the minimal footprint deployment, only running setup/cleanup commands when needed.
297297
:::
298298

299299
In autonomous mode (enabled with the `-S` flag), the Remediation Component functions without requiring a continuously running Go daemon process. Instead:

0 commit comments

Comments
 (0)