mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-04 02:04:06 +00:00
chore(scan-config): improve wording and docs (#11859)
This commit is contained in:
@@ -33,6 +33,10 @@ All notable changes to the **Prowler UI** are documented in this file.
|
||||
- Filter the Overview, Findings, Resources, Scans, and Providers views by provider group [(#11659)](https://github.com/prowler-cloud/prowler/pull/11659)
|
||||
- CIS Controls v8.1 compliance support, including its detail view and report mapping [(#11700)](https://github.com/prowler-cloud/prowler/pull/11700)
|
||||
|
||||
### 🔄 Changed
|
||||
|
||||
- Improve scan configuration wording and add a documentation link to clarify baseline settings and how custom scan configurations override them [(#11859)](https://github.com/prowler-cloud/prowler/pull/11859)
|
||||
|
||||
---
|
||||
|
||||
## [1.31.1] (Prowler v5.31.1)
|
||||
|
||||
@@ -21,6 +21,7 @@ import {
|
||||
import { Modal } from "@/components/shadcn/modal";
|
||||
import { useToast } from "@/components/ui";
|
||||
import { CustomLink } from "@/components/ui/custom/custom-link";
|
||||
import { DOCS_URLS } from "@/lib/external-urls";
|
||||
import {
|
||||
convertToYaml,
|
||||
defaultScanConfigurationYaml,
|
||||
@@ -192,25 +193,16 @@ function ScanConfigurationForm({
|
||||
<ul className="text-default-500 text-tiny mb-1 list-disc pl-5">
|
||||
<li>
|
||||
Follows the structure of{" "}
|
||||
<CustomLink
|
||||
size="xs"
|
||||
href="https://docs.prowler.com/user-guide/cli/tutorials/configuration_file"
|
||||
>
|
||||
<code className="bg-default-100 text-default-600 rounded px-1 py-0.5 font-mono">
|
||||
prowler/config/config.yaml
|
||||
</CustomLink>
|
||||
; include only the keys you want to override.
|
||||
</li>
|
||||
<li>The configuration is validated on save.</li>
|
||||
<li>
|
||||
Learn more about configuring scans{" "}
|
||||
<CustomLink
|
||||
size="xs"
|
||||
href="https://docs.prowler.com/user-guide/tutorials/prowler-app-scan-configuration"
|
||||
>
|
||||
</code>
|
||||
; include only the keys you want to override. Learn more{" "}
|
||||
<CustomLink size="xs" href={DOCS_URLS.SCAN_CONFIGURATION}>
|
||||
here
|
||||
</CustomLink>
|
||||
.
|
||||
</li>
|
||||
<li>The configuration is validated on save.</li>
|
||||
</ul>
|
||||
<Textarea
|
||||
id="scan-configuration-yaml"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
"use client";
|
||||
|
||||
import { Plus, Trash2 } from "lucide-react";
|
||||
import { Info, Plus, Trash2 } from "lucide-react";
|
||||
import { useState } from "react";
|
||||
|
||||
import {
|
||||
@@ -13,7 +13,9 @@ import { ClearFiltersButton } from "@/components/filters/clear-filters-button";
|
||||
import { Button, Card } from "@/components/shadcn";
|
||||
import { Modal } from "@/components/shadcn/modal";
|
||||
import { useToast } from "@/components/ui";
|
||||
import { CustomLink } from "@/components/ui/custom/custom-link";
|
||||
import { DataTable } from "@/components/ui/table";
|
||||
import { DOCS_URLS } from "@/lib/external-urls";
|
||||
import { ProviderProps } from "@/types/providers";
|
||||
import { ScanConfigurationData } from "@/types/scan-configurations";
|
||||
|
||||
@@ -148,6 +150,19 @@ export function ScanConfigurationsManager({
|
||||
|
||||
return (
|
||||
<>
|
||||
<div className="text-text-neutral-secondary mb-6 flex max-w-3xl items-start gap-2 text-sm">
|
||||
<Info className="mt-0.5 size-4 shrink-0" />
|
||||
<p>
|
||||
By default, every provider uses Prowler's built-in configuration
|
||||
baseline. Create a Scan Configuration to override specific values and
|
||||
attach it to the providers that should use it. Learn more{" "}
|
||||
<CustomLink size="sm" href={DOCS_URLS.SCAN_CONFIGURATION}>
|
||||
here
|
||||
</CustomLink>
|
||||
.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="mb-6">
|
||||
<BatchFiltersLayout
|
||||
testIdPrefix="scan-configuration"
|
||||
|
||||
@@ -14,6 +14,7 @@ import {
|
||||
} from "@/components/shadcn/select/select";
|
||||
import { useToast } from "@/components/ui";
|
||||
import { CustomLink } from "@/components/ui/custom/custom-link";
|
||||
import { DOCS_URLS } from "@/lib/external-urls";
|
||||
import { ScanConfigurationData } from "@/types/scan-configurations";
|
||||
|
||||
// Sentinel for the "Default" option: detaches the provider so its scans fall
|
||||
@@ -188,10 +189,7 @@ function ManageScanConfigForm({
|
||||
{
|
||||
" uses Prowler's scan configuration baseline. Read more about it in the "
|
||||
}
|
||||
<CustomLink
|
||||
size="xs"
|
||||
href="https://docs.prowler.com/user-guide/tutorials/prowler-app-scan-configuration"
|
||||
>
|
||||
<CustomLink size="xs" href={DOCS_URLS.SCAN_CONFIGURATION}>
|
||||
documentation
|
||||
</CustomLink>
|
||||
.
|
||||
|
||||
@@ -11,6 +11,8 @@ export const DOCS_URLS = {
|
||||
AWS_ORGANIZATIONS:
|
||||
"https://docs.prowler.com/user-guide/tutorials/prowler-cloud-aws-organizations",
|
||||
ALERTS: "https://docs.prowler.com/user-guide/tutorials/prowler-app-alerts",
|
||||
SCAN_CONFIGURATION:
|
||||
"https://docs.prowler.com/user-guide/tutorials/prowler-app-scan-configuration",
|
||||
ATTACK_PATHS_CUSTOM_QUERIES:
|
||||
"https://docs.prowler.com/user-guide/tutorials/prowler-app-attack-paths#writing-custom-opencypher-queries",
|
||||
} as const;
|
||||
|
||||
Reference in New Issue
Block a user