Skip to content

[crowdsec-manager] Document Hub Browser feature (8 nav entries, 12 API endpoints, zero docs) #3

@strausmann

Description

@strausmann

Summary

The Hub Browser is a major feature of CrowdSec Manager with 8 navigation entries and 12 API endpoints. It has zero documentation — not even a stub page.

Source

Gap analysis: docs/upstream-contributions/crowdsec-manager/docs-analyse.md (Section 3.1)

What Needs to Be Documented

The Hub Browser allows users to browse, install, and manage CrowdSec Hub components (collections, parsers, scenarios, postoverflows, etc.) directly from the UI.

UI Pages

  • Hub.tsx — Hub Home (HUB section)
  • HubBrowser.tsx — Hub Browser
  • HubCategory.tsx — Hub Categories (7 category pages)
  • Scenarios.tsx — Scenarios management

API Endpoints (/hub/)

  • GET /hub/list — List installed hub items
  • POST /hub/upgrade — Upgrade hub item
  • GET /hub/categories — List available categories
  • GET /hub/:category/items — List items in category
  • POST /hub/:category/install — Install item
  • POST /hub/:category/remove — Remove item
  • POST /hub/:category/manual-apply — Manual apply
  • GET /hub/preferences — Get hub preferences
  • PUT /hub/preferences — Update hub preferences
  • GET /hub/history — Hub operation history

Files to Create

  • content/docs/features/hub-browser.mdx — Main feature page
  • Add entry to content/docs/features/meta.json

Acceptance Criteria

  • New page features/hub-browser.mdx created
  • Explains what the Hub Browser is and why it's useful
  • Documents all 7 hub categories (collections, parsers, scenarios, postoverflows, etc.)
  • Explains install, upgrade, and remove workflows
  • Explains hub preferences configuration
  • Hub history section documented
  • Cross-references to the Scenarios feature page

Effort Estimate

M (2–3 hours)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestphase:1-criticalPhase 1: Critical gapspriority:highHoch: Wichtige fehlende Features oder Guidesproject:crowdsec-managerCrowdSec Manager Docsscope:hubCrowdSec Manager: Hub Browserteam:devDevelopment: Code-Analyse, API-Doku, Feature-Mapping

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions