docs: various fixes #1570
Closed
docs: various fixes #1570
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
Configuring grpc and configmap options through helm or directly should be advanced configuration out of the box helm should just work. Signed-off-by: John Fastabend <[email protected]>
I don't think anyone will reasonably assume that the "Try Tetragon.." section is a production users guide on how to deploy and manage a fleet of servers running Tetragon.
Developers are not normal users lets build them their own docs sections so as to not confuse development, from deployment, from exploration. Signed-off-by: John Fastabend <[email protected]>
To get started I don't think understanding all the details of JSON events vs GRPC and so on is important. Move it into a "concepts" section. Signed-off-by: John Fastabend <[email protected]>
Metrics are a great way to pull useful information out of Tetragon lets create a section for them in Concepts. Signed-off-by: John Fastabend <[email protected]>
Filtering by namespace and pod labels is part of tracing policy move it under that unbrella item. Signed-off-by: John Fastabend <[email protected]>
There are lots of details we have for Installing Tetragon in various environments, bare-metal, docker, systems, etc. Lets create a section to capture those instead of spreading that knowledge thorughout and/or in getting started which needs to be really about shortest path to up and running tetragon. Signed-off-by: John Fastabend <[email protected]>
References should be after content IMO. Signed-off-by: John Fastabend <[email protected]>
Tetra CLI is useful for sure lets move it into installation. The getting started section can give the one line command to install it. Signed-off-by: John Fastabend <[email protected]>
Enforcement is a big enough concept we can build its own section. Signed-off-by: John Fastabend <[email protected]>
Lets document how we do benchmarks bring on the fun. Signed-off-by: John Fastabend <[email protected]>
Simplify the getting started guide
Signed-off-by: Mahe Tardy <[email protected]>
jrfastab
force-pushed
the
pr/jrfastab/docs
branch
8 times, most recently
from
d12ba5b to
9720b29
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.
No description provided.