Skip to content
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

Jump to bottom

[Security Solution][DQD][Tech Debt] Dissolve index properties markdown #191264

Merged
merged 1 commit into from
Aug 28, 2024
Merged

[Security Solution][DQD][Tech Debt] Dissolve index properties markdown #191264

merged 1 commit into from
Aug 28, 2024

Conversation

kapral18
Copy link
Contributor

addresses #190964

Fifth in the series of PRs to address general DQD tech debt

This one builds on previous 4 PRs

#190970
#190978
#191233
#191245

Gist of changes:

  • split gigantic markdown helper file and colocate the parts where they belong
  • dedupe translations
  • cleanup dead code

@kapral18 kapral18 self-assigned this Aug 26, 2024
@kapral18 kapral18 requested a review from a team as a code owner August 26, 2024 10:31
@kapral18 kapral18 added technical debt Improvement of the software architecture and operational architecture Team:Threat Hunting Security Solution Threat Hunting Team Team:Threat Hunting:Explore v8.16.0 labels Aug 26, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting (Team:Threat Hunting)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting-explore (Team:Threat Hunting:Explore)

@kapral18 kapral18 added the release_note:skip Skip the PR/issue when compiling release notes label Aug 26, 2024
@kapral18 kapral18 force-pushed the improve/DQD/190964-tech-debt-cleanup-5 branch 5 times, most recently from a795095 to f5fe127 Compare August 28, 2024 08:14
angorayc
angorayc approved these changes Aug 28, 2024
View reviewed changes
Copy link
Contributor

@angorayc angorayc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally, LGTM, thank you @kapral18

...k/packages/security-solution/ecs_data_quality_dashboard/impl/data_quality_panel/constants.ts
Comment on lines +63 to +69
export const ECS_FIELD_REFERENCE_URL =
'https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html';

/** The documentation link shown in the `Data Quality` dashboard */
export const ECS_REFERENCE_URL = 'https://www.elastic.co/guide/en/ecs/current/ecs-reference.html';
export const MAPPING_URL =
'https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html';
Copy link
Contributor

@angorayc angorayc Aug 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing to do with this change, just want to make a note of a potential task:
As we are going to have ESS and serverless docs separately.
It would be great for us to review all the doc links we have in security solution, and retrieve them with getDocLinks e.g.: https://github.com/elastic/kibana/pull/189075/files#diff-aa872c6e8f0a6d2bc64ca2721a46a81cad6b6c7b62112b50849f2c05f3680e9fR33
so it takes care of the Kibana version and Kibana type.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't know about the tool, thanks

@angorayc angorayc mentioned this pull request Aug 28, 2024
Open
@kapral18
Copy link
Contributor Author

/ci

@kapral18 kapral18 force-pushed the improve/DQD/190964-tech-debt-cleanup-5 branch from f5fe127 to 5766457 Compare August 28, 2024 11:00
@kapral18 kapral18 enabled auto-merge (squash) August 28, 2024 11:01
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
securitySolution 5724 5726 +2

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/ecs-data-quality-dashboard 6 8 +2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
securitySolution 18.0MB 18.0MB +3.9KB
Unknown metric groups

API count

id before after diff
@kbn/ecs-data-quality-dashboard 14 16 +2

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @kapral18

@kapral18 kapral18 merged commit f79b714 into elastic:main Aug 28, 2024
36 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angorayc angorayc angorayc approved these changes

@semd semd Awaiting requested review from semd

@agusruidiazgd agusruidiazgd Awaiting requested review from agusruidiazgd

Assignees

@kapral18 kapral18

Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Threat Hunting:Explore Team:Threat Hunting Security Solution Threat Hunting Team technical debt Improvement of the software architecture and operational architecture v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kapral18 @elasticmachine @kibana-ci @angorayc @kibanamachine