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.

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

Update the public docs for Network Beaconing Identification package #4036

Closed
Tracked by #4117
sodhikirti07 opened this issue Oct 12, 2023 · 8 comments · Fixed by #4137
Closed
Tracked by #4117

Update the public docs for Network Beaconing Identification package #4036

sodhikirti07 opened this issue Oct 12, 2023 · 8 comments · Fixed by #4137
Assignees
Labels
Docset: ESS Issues that apply to docs in the Stack release Docset: Serverless Issues for Serverless Security Effort: Small Issues that can be resolved quickly Feature: Entity Analytics Features or enhancements for any of the Entity pages Priority: High Issues that are time-sensitive and/or are of high customer importance Team: Docs Team: Entity Analytics Team: Security Platform Includes Cyber Threat Intelligence (CTI) team v8.11.0

Comments

@sodhikirti07
Copy link

Description

Since we've introduced Network Beaconing Identification as part of our integration packages, we aim to revise the public documentation page of this package. We'll eliminate the previous links that direct users to install the package through detections-rules repo and instead guide them to the updated integration documentation for the package.

Related docs

Old Links:

New documentation:

@jmikell821
Copy link
Contributor

@sodhikirti07 @SourinPaul do we need to delete the .md file? https://github.com/elastic/detection-rules/blob/main/docs/experimental-machine-learning/beaconing.md. We usually don't touch the files in the detection-rules repo unless we have to, but I can create a separate task issue if it needs to be deleted from here. cc: @ajosh0504

@natasha-moore-elastic
Copy link
Contributor

@sodhikirti07, @SourinPaul is this update for both classic and serverless docs?

@natasha-moore-elastic natasha-moore-elastic added Feature: Entity Analytics Features or enhancements for any of the Entity pages Team: Entity Analytics Effort: Small Issues that can be resolved quickly Effort: Medium Issues that take moderate but not substantial time to complete Docset: ESS Issues that apply to docs in the Stack release Priority: High Issues that are time-sensitive and/or are of high customer importance and removed Effort: Medium Issues that take moderate but not substantial time to complete labels Oct 31, 2023
@sodhikirti07
Copy link
Author

@sodhikirti07, @SourinPaul is this update for both classic and serverless docs?

The update is applicable to both.

@sodhikirti07 @SourinPaul do we need to delete the .md file? https://github.com/elastic/detection-rules/blob/main/docs/experimental-machine-learning/beaconing.md. We usually don't touch the files in the detection-rules repo unless we have to, but I can create a separate task issue if it needs to be deleted from here

I'll defer it to Sourin, but I suggest retaining it for the potential users who are using an older version and wish to install this package.

@natasha-moore-elastic natasha-moore-elastic added the Docset: Serverless Issues for Serverless Security label Oct 31, 2023
@ajosh0504
Copy link
Contributor

My two cents: Agree w/ @sodhikirti07 regarding keeping old docs. This is if users run into installation issues with the integration at any point and need to install things manually. So we can maybe make it clear that integrations are the preferred installation mechanism, and the README in the detection-rules repo is more of a backup/if folks want to install assets manually for some reason (eg: tuning the transform before installation).

@SourinPaul
Copy link

I agree with both the recommendations above:

  • Retain the .md file in the detection rules repo
  • Append the .md file with a Note: section (before the Detailed Steps section) to state

On this note, @sodhikirti07 can you please help append the below to the .md?

Integration package [link to fleet integration page] now provides a user-friendly experience to implement this detection package. If you wish to fine-tune any of the package components, you may install the package manually by following these steps.

Lastly, we should delete the existing doc-page, once the references are updated.

Thanks!

@sodhikirti07 sodhikirti07 reopened this Nov 9, 2023
@pantea-elastic pantea-elastic added the Team: Security Platform Includes Cyber Threat Intelligence (CTI) team label Nov 9, 2023
@sodhikirti07
Copy link
Author

Reopening this issue: Going to work on consolidating information from this HTML page to the integration docs of Network Beaconing Identification.
Related comment and PR: #4192 (comment)

@sodhikirti07 sodhikirti07 self-assigned this Nov 9, 2023
@natasha-moore-elastic
Copy link
Contributor

natasha-moore-elastic commented Nov 10, 2023

Reopening this issue: Going to work on consolidating information from this HTML page to the integration docs of Network Beaconing Identification. Related comment and PR: #4192 (comment)

Hi @sodhikirti07, thanks for your help with this! We actually have a different issue for this, which is still open (and is also tied to the PR you linked to). I've added a task to that issue for your consolidation work.

@sodhikirti07
Copy link
Author

@natasha-moore-elastic Thank you! This PR consolidates the beaconing related information from the HTML page to the integration packages's README. With that, you can go ahead and merge #4192 to delete beaconing from Technical review and add Network Beaconing Identification integration under this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docset: ESS Issues that apply to docs in the Stack release Docset: Serverless Issues for Serverless Security Effort: Small Issues that can be resolved quickly Feature: Entity Analytics Features or enhancements for any of the Entity pages Priority: High Issues that are time-sensitive and/or are of high customer importance Team: Docs Team: Entity Analytics Team: Security Platform Includes Cyber Threat Intelligence (CTI) team v8.11.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants