elastic / detection-rules

https://www.elastic.co/guide/en/security/current/detection-engine-overview.html
Other
1.92k stars 492 forks source link

[FR] Generate Release Docs for deprecated Rules #3897

Open shashank-elastic opened 2 months ago

shashank-elastic commented 2 months ago

Repository Feature

Core Repo - (rule management, validation, testing, lib, cicd, etc.)

Problem Description

Investigation

Looking at some of our old PR where we have had deprecated rules as a sample investigation point .

In the Original Design

  1. Code Line reference skips adding deprecated rules for rule details generation.
  2. Hence the Builds will have missing doc links and will fail, eventually prompting us to remove those links from summary and appendix

Desired Solution

Rule Deprecation Design Spec

Deprecated rule in the docs

A bit offtopic: once we stop sending rule updates - add a note to the downloadable rule updates page that this version no longer receives out-of-band updates

Considered Alternatives

Additional Context

Historical Issue : https://github.com/elastic/detection-rules/issues/3032

botelastic[bot] commented 3 weeks ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

botelastic[bot] commented 2 weeks ago

This has been closed due to inactivity. If you feel this is an error, please re-open and include a justifying comment.