Skip to content

Commit 1dcae84

Browse files
author
jdv
committed
lint + clean
1 parent 2ff6a80 commit 1dcae84

10 files changed

Lines changed: 119 additions & 423 deletions

File tree

branch-changes.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Branch changes — jdv-cti-move-and-add-let-and-options
2+
3+
A summary of the conceptual changes introduced in this branch vs `main`, grouped by theme.
4+
5+
---
6+
7+
## 1. CTI / IP Reputation — separation of UI docs from API docs
8+
9+
**Core idea:** the CTI section previously mixed Web UI pages and API pages together under `cti_api/`. This branch splits them cleanly: UI-facing pages move to the Console, API-facing pages stay in `cti_api/`.
10+
11+
- `cti_api/getting_started` → renamed and moved to `console/ip_reputation/search_ui`
12+
- `cti_api/ip_report` → moved to `console/ip_reputation/ip_report` (title changed from "Ip report" to "IP Reputation Report")
13+
- `cti_api/advanced_search` → moved to `console/ip_reputation/search_ui_advanced`
14+
- New `console/ip_reputation/intro` created as the landing page for the whole IP Reputation section in the Console
15+
- New `console/ip_reputation/cve_explorer` created (full CVE Explorer reference, currently not wired into the sidebar)
16+
- `cti_api/api_getting_started` (the old combined getting-started page that covered both UI and API) **deleted**
17+
18+
---
19+
20+
## 2. CTI sidebar restructured to reflect the split
21+
22+
- The `ctiApiSidebar` "Web UI" category (which listed `getting_started`, `ip_report`, `advanced_search`, `search_queries`, `cve_explorer`) is replaced by a single external link pointing to the Console IP Reputation section
23+
- The `ctiApiSidebar` "API" category (which contained `api_getting_started` and the Swagger link) is replaced by a direct link to `cti_api/api_introduction`
24+
- `search_queries` promoted to a top-level entry in `ctiApiSidebar` (renamed "Advanced Query Syntax")
25+
- Taxonomy category and Swagger link moved after a visual separator, making the sidebar hierarchy: intro → Web UI link → API Access → Integrations → [separator] → Query Syntax → Taxonomy → [separator] → Swagger → FAQ
26+
27+
---
28+
29+
## 3. Console sidebar — IP Reputation added as a first-class section
30+
31+
- A new `"IP Reputation / CTI"` category added to `consoleSidebar` with its own structure:
32+
- Search UI (with Advanced Search nested inside, plus a cross-link to query syntax)
33+
- IP Reputation Report
34+
- API Keys (with Premium API Keys nested, plus cross-links to Integrations and Taxonomy)
35+
- The old `consoleSidebar` entry `{ type: "link", label: "CTI", href: "/u/cti_api/intro" }` removed — replaced by the above proper category
36+
- `Threat Forecast` moved earlier in the sidebar (now sits above IP Reputation, before Notification integrations)
37+
- `Blocklists` moved lower in the sidebar, now placed after Decisions/Allowlists/Threat Forecast, separated by a visual `<hr>`
38+
- `Notification integrations` moved later in the sidebar (was before Service API, now after Service API)
39+
- Visual `<hr>` separators added between logical groups throughout the sidebar
40+
41+
---
42+
43+
## 4. New IP Reputation pages created
44+
45+
- `console/ip_reputation/intro` — overview of what IP Reputation / CTI offers: IP search, advanced search, IP report, Live Exploit Tracker, and API access with quota table
46+
- `console/ip_reputation/api_keys` — step-by-step key creation with screenshots, plus an intro to integrations, curl, and the ipdex tool
47+
- `console/ip_reputation/api_keys_premium` — explains Premium plan benefits (higher free quota + purchasable high-quota keys), pricing pointer, and a warning block about CTI key trial interactions
48+
- `console/ip_reputation/cve_explorer` — full CVE Explorer reference (search, quick-filter cards, result list, detail page, exploitation timeline, detected IPs, blocklist wishlist)
49+
50+
---
51+
52+
## 5. Live Exploit Tracker introduced as the evolution of CVE Explorer
53+
54+
- Mentioned in `console/ip_reputation/intro` as the successor to CVE Explorer, living outside the Console at `tracker.crowdsec.net`
55+
- Described as adding Opportunity Score, Momentum Score, Exploitation Status, and CVE timeline on top of what CVE Explorer offered
56+
- The old `cti_api/cve_explorer` page remains on disk (orphaned — not wired into any sidebar on this branch)
57+
58+
---
59+
60+
## 6. CTI API introduction page rewritten
61+
62+
- `cti_api/api_introduction` previously had a minimal "Objective / Datasets / CTI Information / How to access it" structure
63+
- Rewritten to: explain what the API is for, cover the two datasets (smoke/fire), authentication, and three usage paths — integrations (with link), cURL snippet, and ipdex (with both web UI and CLI described)
64+
- The old `cti_api/intro` page (which had a TODO comment and mixed Web UI / API content) replaced with a clean API-focused intro: what the API gives you (table), datasets, taxonomy index, getting-started steps, integrations table
65+
66+
---
67+
68+
## 7. Integration intro page got a real introduction
69+
70+
- `cti_api/api_integration/integration_intro` previously had no intro text — just a table of integrations
71+
- A short intro paragraph added explaining that native integrations exist, but curl and custom scripts/playbooks work too, with a curl snippet and Swagger link
72+
73+
---
74+
75+
## 8. ipdex page expanded to cover the Web UI
76+
77+
- `cti_api/api_integration/integration_ipdex` previously only documented the CLI
78+
- Web UI section added (with `ipdex_demo.png` screenshot and link to `ipdex.crowdsec.net/docs`), CLI moved into its own subsection
79+
80+
---
81+
82+
## 9. "Enterprise" renamed to "Premium" throughout
83+
84+
- `console/enterprise_plan/enterprise_support``console/premium_upgrade/premium_support` (content updated: "Enterprise Support" → "Premium Support", "enterprise users" → "premium users", "enterprise grade organization" → "premium organization")
85+
- `console/enterprise_plan/enterprise_invoices``console/premium_upgrade/premium_invoices` (image paths updated to match)
86+
- `consoleSidebar` category "Enterprise plan" effectively replaced by the existing `premium_upgrade` section (the enterprise items now live under `premium_upgrade/`)
87+
- Associated images moved from `console/enterprise_*` to `console/premium_*` folders
88+
89+
---
90+
91+
## 10. Console getting-started page reworked
92+
93+
- `console/getting_started` replaced from a simple `ConsolePromo` card layout (linking to Security Engine, CTI, Blocklists) to a proper sign-up guide with a themed screenshot, SSO/email options, email verification steps, and the onboarding survey
94+
- The old content preserved as `console/getting_started-deprecated` (orphaned, not in the sidebar)
95+
96+
---
97+
98+
## 11. Navbar label change
99+
100+
- Top-level nav item "CTI" renamed to "IP Reputation & CTI"
101+
- A new visual separator `<span class="navbar-separator">` added after the Console nav item

crowdsec-docs/docusaurus.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ const NAVBAR_ITEMS: NavbarItem[] = [
9191
{ to: "/u/cti_api/intro", position: "left", label: "IP Reputation & CTI" },
9292
{ to: "/u/console/intro", position: "left", label: "Console" },
9393
{
94-
type: 'html',
94+
type: "html",
9595
value: '<span class="navbar-separator" aria-hidden="true"></span>',
96-
position: 'left',
96+
position: "left",
9797
},
9898
{
9999
label: "Resources",

crowdsec-docs/sidebarsUnversioned.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ const sidebarsUnversionedConfig: SidebarConfig = {
7878
defaultStyle: false,
7979
},
8080
{
81-
type: "link",
82-
label: "Swagger",
83-
href: "https://crowdsecurity.github.io/cti-api/",
81+
type: "link",
82+
label: "Swagger",
83+
href: "https://crowdsecurity.github.io/cti-api/",
8484
},
8585
{
8686
type: "doc",
@@ -323,7 +323,7 @@ const sidebarsUnversionedConfig: SidebarConfig = {
323323
{
324324
type: "doc",
325325
label: "Advanced Search",
326-
id: "console/ip_reputation/search_ui_advanced",
326+
id: "console/ip_reputation/search_ui_advanced",
327327
},
328328
{
329329
type: "link",
@@ -332,7 +332,7 @@ const sidebarsUnversionedConfig: SidebarConfig = {
332332
customProps: {
333333
tag: "otherSection",
334334
},
335-
},
335+
},
336336
],
337337
},
338338
{

crowdsec-docs/src/css/navbar.css

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

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ 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-
)}
50+
{tag === "otherSection" && (<Signpost className="ml-1 h-4 text-foreground/80" />)}
5351
{!isInternalLink && <ExternalLinkIcon className="ml-1 h-4 text-foreground/80" />}
5452
</Link>
5553
</li>

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

Lines changed: 0 additions & 35 deletions
This file was deleted.

crowdsec-docs/unversioned/console/ip_reputation/cve_explorer.md

Lines changed: 0 additions & 184 deletions
This file was deleted.

0 commit comments

Comments
 (0)