Refactor Artifacts, VQL and Notebooks sections #990
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
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.
The goal of this refactor is to allow these core topics to be expanded more easily in future.
Artifacts, VQL and Notebooks are now much more complex than they used to be so they can't all be squashed together under the "VQL" topic. As core concepts they deserve their own sections. This also allows us to expand these topics without creating another level in the hierarchy.
I've created stub pages in the new sections for proposed future topics and marked them as draft (so they are hidden for now). Stubs for Sigma and YARA are also added under the VQL section, which is where I think they should be located.
The new sections also mirror the related reference pages. This allows readers to see and access the relevant references while they are engaging with documentation on a topic.
Pages that have been moved have aliases added to avoid 404s while google search indexing catches up.