[Bug] Fix URL links in autogenerated security docs #3474
Merged
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
terrancedejesus
added
Area: DED
documentation
terrancedejesus
requested review from
Mikaayenson,
eric-forte-elastic and
shashank-elastic
Mikaayenson
reviewed
Feb 23, 2024
eric-forte-elastic
approved these changes
Feb 23, 2024
Mikaayenson
approved these changes
Feb 23, 2024
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
protectionsmachine
pushed a commit
that referenced
this pull request
Feb 23, 2024
* added content() class method for guide and setup * removed non-existent variable * removed unnecessary newlines * adjusted levels for titles * reverting changes * added method to convert markdown links to asciidoc * adjusted regex to include trailing periods * fixing linting errors * adjusted regex pattern * added content() class method for guide and setup * stripped # out of investigation guide, setup or note * adjusted formatting outcome * changed function call * fixed linting errors * fixing auto-formatting for rule asciidoc * fixing URL link removal * fixing URL link removal * removed strip() from string for setup * fixed linting errors * fixed linting errors * adjusting code formatting for convert_markdown_to_asciidoc (cherry picked from commit 8e0ca42)
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.
Summary
Security docs for prebuilt rule releases are currently generating links that do not pass tests upstream. We need to adjust accordingly in
docs.py. More details to come.Additional details
This PR introduces changes to
doc.pywhich programmatically creates security rule AsciiDocs that are pushed as updates in a PR to elastic/security-docs.Thread conversation with docs team for debugging
What was the issue?
investigation_guideandsetup, when generating the rule asciidoc, we would write these strings to the file as asciidoc codeblocks, with the source being markdownCI Job with broken links reference
NOTE: OSQuery code still appears in the final rule documentation and thus does not render into a hyperlink like it does in the Kibana UI.
Solution evidence
Bugs Fixed
Setupis added to the rule but was missing. This was completed in a previous PR.Comparison from Preview Sites
Note that with these changes do remove markdown
#headers and thus we loose the markdown header levels since we are converting these to asciidoc and making them bolded strings. The reason we do not attempt to convert them to asciidoc levels is because of the leveling sequential requirements noted here.Suggested changes:
Existing:
