Organise Tracing Policies - #5268
Open
paularah wants to merge 5 commits into
Open
Conversation
Signed-off-by: Paul Arah <paularah.self@gmail.com>
Signed-off-by: Paul Arah <paularah.self@gmail.com>
Signed-off-by: Paul Arah <paularah.self@gmail.com>
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
some initial work here, still WIP. I choose to organise the policies around usecases. Then, i'll slightly change how we put policies in the docs. You write the policy, put it in the correct usecase directory, and then reference the path. LMK what you think. |
This file contains hidden or 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
1 participant
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.
Description
Summary
The Tetragon project currently lacks a centralized, well-organized collection of tracing policies. As a result, there is no single place where users can discover high-quality tracing policy examples or learn how to write their own.
This PR addresses that by organizing the existing tracing policies referenced throughout the documentation into a dedicated
/policiesdirectory, grouped by use case. This makes it significantly easier for users to discover relevant policies, understand how they work, and use them as references when authoring new tracing policies.In addition, this PR introduces three new Hugo shortcodes for referencing tracing policies from the documentation. These shortcodes provide several benefits:
Documentation describing how to use these shortcodes has been added to the documentation contribution guide.
As an example, the Kernel Modules section under the Host System use case has been updated to use the new shortcodes. Converting the remaining documentation to use these shortcodes will be done in a separate follow-up PR.
Changelog