Skip to content

[9.0] Fix several doc links in security solution (#243176) #243529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kibanamachine wants to merge 1 commit into from
Closed

[9.0] Fix several doc links in security solution (#243176) #243529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions ...ns/security/plugins/security_solution/public/common/components/links_to_docs/doc_link.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ import { ExternalLink } from './external_link';
import { COMMON_ARIA_LABEL_ENDING } from './links_translations';

interface DocLinkProps {
guidePath?: string;
docPath: string;
linkText: string;
}

const DocLink: FC<DocLinkProps> = ({ guidePath = 'security', docPath, linkText }) => {
const DocLink: FC<DocLinkProps> = ({ docPath, linkText }) => {
const { services } = useKibana();
const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = services.docLinks;
const { ELASTIC_WEBSITE_URL } = services.docLinks;

const url = `${ELASTIC_WEBSITE_URL}guide/en/${guidePath}/${DOC_LINK_VERSION}/${docPath}`;
const url = `${ELASTIC_WEBSITE_URL}docs/${docPath}`;
const ariaLabel = `${linkText} - ${COMMON_ARIA_LABEL_ENDING}`;

return (
Expand Down
12 changes: 8 additions & 4 deletions ...ty/plugins/security_solution/public/common/components/links_to_docs/links_translations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,35 @@ export const COMMON_ARIA_LABEL_ENDING = i18n.translate(
}
);

export const SOLUTION_REQUIREMENTS_LINK_PATH = 'sec-requirements.html';
export const SOLUTION_REQUIREMENTS_LINK_PATH =
'solutions/security/get-started/elastic-security-requirements';
export const SOLUTION_REQUIREMENTS_LINK_TEXT = i18n.translate(
'xpack.securitySolution.documentationLinks.solutionRequirements.text',
{
defaultMessage: 'Elastic Security system requirements',
}
);

export const DETECTIONS_REQUIREMENTS_LINK_PATH = 'detections-permissions-section.html';
export const DETECTIONS_REQUIREMENTS_LINK_PATH =
'solutions/security/detect-and-alert/detections-requirements';
export const DETECTIONS_REQUIREMENTS_LINK_TEXT = i18n.translate(
'xpack.securitySolution.documentationLinks.detectionsRequirements.text',
{
defaultMessage: 'Detections prerequisites and requirements',
}
);

export const ML_JOB_COMPATIBILITY_LINK_PATH = 'alerts-ui-monitor.html#ml-job-compatibility';
export const ML_JOB_COMPATIBILITY_LINK_PATH =
'troubleshoot/security/detection-rules#ml-job-compatibility';
export const ML_JOB_COMPATIBILITY_LINK_TEXT = i18n.translate(
'xpack.securitySolution.documentationLinks.mlJobCompatibility.text',
{
defaultMessage: 'ML job compatibility',
}
);

export const COVERAGE_OVERVIEW_LINK_PATH = 'rules-coverage.html';
export const COVERAGE_OVERVIEW_LINK_PATH =
'solutions/security/detect-and-alert/mitre-attandckr-coverage';
export const COVERAGE_OVERVIEW_LINK_TEXT = i18n.translate(
'xpack.securitySolution.documentationLinks.coverageOverview.text',
{
Expand Down
8 changes: 5 additions & 3 deletions ...y_solution/public/detection_engine/rule_creation_ui/components/step_define_rule/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,14 +395,16 @@ const StepDefineRuleComponent: FC<StepDefineRuleProps> = ({
id="xpack.securitySolution.dataViewSelectorText1"
defaultMessage="Use Kibana "
/>
<DocLink guidePath="kibana" docPath="data-views.html" linkText="Data Views" />
<DocLink
docPath="explore-analyze/find-and-organize/data-views"
linkText="Data Views"
/>
<FormattedMessage
id="xpack.securitySolution.dataViewSelectorText2"
defaultMessage=" or specify individual "
/>
<DocLink
guidePath="kibana"
docPath="index-patterns-api-create.html"
docPath="api/doc/kibana/group/endpoint-data-views"
linkText="index patterns"
/>
<FormattedMessage
Expand Down
8 changes: 2 additions & 6 deletions ...nents/rule_details/three_way_diff/final_edit/fields/data_source/data_source_info_text.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,12 @@ export function DataSourceInfoText(): JSX.Element {
id="xpack.securitySolution.dataViewSelectorText1"
defaultMessage="Use Kibana "
/>
<DocLink guidePath="kibana" docPath="data-views.html" linkText="Data Views" />
<DocLink docPath="explore-analyze/find-and-organize/data-views" linkText="Data Views" />
<FormattedMessage
id="xpack.securitySolution.dataViewSelectorText2"
defaultMessage=" or specify individual "
/>
<DocLink
guidePath="kibana"
docPath="index-patterns-api-create.html"
linkText="index patterns"
/>
<DocLink docPath="api/doc/kibana/group/endpoint-data-views" linkText="index patterns" />
<FormattedMessage
id="xpack.securitySolution.dataViewSelectorText3"
defaultMessage=" as your rule's data source to be searched."
Expand Down