Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: split Tracing Policy concept page into subpages #1377

Merged
merged 1 commit into from
Aug 25, 2023

Conversation

mtardy
Copy link
Member

@mtardy mtardy commented Aug 21, 2023

Now the Tracing Policy documentation splits into three pages:

  • an example of policy, shortly explained
  • a hook point page about how to use kprobes, tracepoints, etc.
  • a selector page about filters and actions

See preview.

@mtardy mtardy added the area/documentation Improvements or additions to documentation label Aug 21, 2023
@mtardy mtardy requested a review from a team as a code owner August 21, 2023 16:32
@netlify
Copy link

netlify bot commented Aug 21, 2023

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit d95362f
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/64e8679b588007000882a7b3
😎 Deploy Preview https://deploy-preview-1377--tetragon.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mtardy mtardy linked an issue Aug 21, 2023 that may be closed by this pull request
@mtardy mtardy force-pushed the pr/mtardy/split-tracing-policy branch from 3f4707b to df30a4f Compare August 21, 2023 16:35
mtardy added a commit that referenced this pull request Aug 21, 2023
Just noticed this check started in #1377.

Signed-off-by: Mahé <[email protected]>
@mtardy
Copy link
Member Author

mtardy commented Aug 21, 2023

Need to add a link to the examples directory in the repository to the example page done

@mtardy mtardy force-pushed the pr/mtardy/split-tracing-policy branch from df30a4f to 240ae5a Compare August 22, 2023 09:29
kkourt pushed a commit that referenced this pull request Aug 22, 2023
Just noticed this check started in #1377.

Signed-off-by: Mahé <[email protected]>
Copy link
Contributor

@kkourt kkourt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Generally looks good to me, but I have some comments / suggestions. Please see below.

docs/content/en/docs/concepts/tracing-policy/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/concepts/tracing-policy/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/concepts/tracing-policy/example.md Outdated Show resolved Hide resolved
docs/content/en/docs/concepts/tracing-policy/example.md Outdated Show resolved Hide resolved
Now the Tracing Policy documentation splits into three pages:
- an example of policy, shortly explained
- a hook point page about how to use kprobes, tracepoints, etc.
- a selector page about filters and actions

Signed-off-by: Mahe Tardy <[email protected]>
@mtardy mtardy force-pushed the pr/mtardy/split-tracing-policy branch from 240ae5a to d95362f Compare August 25, 2023 08:34
@mtardy
Copy link
Member Author

mtardy commented Aug 25, 2023

Thanks!

Generally looks good to me, but I have some comments / suggestions. Please see below.

I integrated your suggestions, changed the example, and added a warning.

Copy link
Contributor

@kkourt kkourt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@mtardy mtardy merged commit ba1b914 into main Aug 25, 2023
9 checks passed
@mtardy mtardy deleted the pr/mtardy/split-tracing-policy branch August 25, 2023 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split the huge concept page for tracing policies
2 participants