chore: use docs-dev instead of docs dir for docs
#4522
Merged
+18
−15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
traut
added
documentation
traut
requested review from
Mikaayenson,
eric-forte-elastic and
terrancedejesus
as code owners
Mikaayenson
approved these changes
Mar 6, 2025
Enhancement - GuidelinesThese guidelines serve as a reminder set of considerations when addressing adding a feature to the code. Documentation and Context
Code Standards and Practices
Testing
Additional Checks
|
detection_rules/docs.py
Outdated
| @@ -24,6 +24,8 @@ | |||
| from .rule_loader import DeprecatedCollection, RuleCollection | |||
| from .utils import load_etc_dump, save_etc_dump | |||
|
|
|||
| DOCS_DIR = "docs-dev" | |||
There was a problem hiding this comment.
The entire file, is about generating docs in security-docs repository.
Which i feel they are not using for 9.0.0, why are we introducing new directory structure here ?
the package directory being referenced here is for https://github.com/elastic/security-docs/tree/8.17/docs/detections/prebuilt-rules/downloadable-packages
rule details are here https://github.com/elastic/security-docs/tree/8.17/docs/detections/prebuilt-rules/rule-details
There was a problem hiding this comment.
thank you for spotting this! should be fixed now!
traut
force-pushed
the
adjust-docs-path-in-code
branch
from
16bce3d to
425422a
Compare
Test-cli command has correct expected output 👍 Details
|
| @@ -24,6 +24,8 @@ | |||
| from .rule_loader import DeprecatedCollection, RuleCollection | |||
| from .utils import load_etc_dump, save_etc_dump | |||
|
|
|||
| REPO_DOCS_DIR = "docs-dev" | |||
There was a problem hiding this comment.
Do we still need this?
There was a problem hiding this comment.
it's better to have the constant to use instead of inline values sprinkled through the code (that's exactly the reason I got confused with all "docs" directories)
There was a problem hiding this comment.
I dont this constant is in need for this particular file. This is all external references to security-docs repo.
eric-forte-elastic
approved these changes
Mar 6, 2025
traut
force-pushed
the
adjust-docs-path-in-code
branch
2 times, most recently
from
3753d6e to
adc902c
Compare
Mikaayenson
requested changes
Mar 6, 2025
There was a problem hiding this comment.
@traut Just noticed that we also need to update references in the workflows like attack-coverage-update.yml
We probably need to just do a deeper search for "docs" references.
|
Can we test with |
|
Gist update works as expected 🟢 Details
detection-rules on adjust-docs-path-in-code [?] is v0.4.18 via v3.12.9 (detection-rules-build) on eric.forte took 9s
❯ python -m detection_rules dev update-navigator-gists --update-coverage
█▀▀▄ ▄▄▄ ▄▄▄ ▄▄▄ ▄▄▄ ▄▄▄ ▄▄▄ ▄▄▄ ▄ ▄ █▀▀▄ ▄ ▄ ▄ ▄▄▄ ▄▄▄
█ █ █▄▄ █ █▄▄ █ █ █ █ █ █▀▄ █ █▄▄▀ █ █ █ █▄▄ █▄▄
█▄▄▀ █▄▄ █ █▄▄ █▄▄ █ ▄█▄ █▄█ █ ▀▄█ █ ▀▄ █▄▄█ █▄▄ █▄▄ ▄▄█
Token:
Updated ATT&CK coverage URL(s) in /home/forteea1/Code/detection-rules/docs-dev/ATT&CK-coverage.md
Gist update status on 139 files: 200 OK
|
|
thank you for helping out here, @eric-forte-elastic 🙇 |
traut
force-pushed
the
adjust-docs-path-in-code
branch
from
ec42623 to
b506e21
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Issue link(s):
Summary - What I changed
Path used for docs in the code updated from
docstodocs-devChecklist
bug,enhancement,schema,maintenance,Rule: New,Rule: Deprecation,Rule: Tuning,Hunt: New, orHunt: Tuningso guidelines can be generatedmeta:rapid-mergelabel if planning to merge within 24 hoursContributor checklist