Add a Tetragon documentation website and rename base folder crds into examples
#778
Conversation
|
do we have any stats on how often the links are used? |
|
Thanks for looking at the CI changes :)
It shouldn't be needed, just merging = approved => deployed on the website. wdyt? |
I really don't know but the report is still being actively distributed and it would be as easy as replacing the link redirection to permalinks I guess so, it would be nice to do it before moving this stuff. This is a blocker and we need to solve this before merging. |
mtardy
force-pushed
the
pr/mtardy/docs-website
branch
from
52a6d2b to
1268c18
Compare
|
For now, the easiest decision is to not delete it. So I just left One downside I overlooked as well is that I am deleting @tixxdz example configuration folder: https://github.com/cilium/tetragon/tree/main/docs/configuration/tetragon.conf.d. Maybe I could move it under |
|
We already have |
@willfindlay do you mean |
|
Yeah sorry that's what I meant.
Yeah I like this as an idea. Especially because they're not really CRDs... |
+1000, it just confuses everybody and then we are all saying CRD all the time instead of CR or TracingPolicy! |
mtardy
force-pushed
the
pr/mtardy/docs-website
branch
from
1268c18 to
c67709e
Compare
mtardy
changed the title
crds into examples
mtardy
force-pushed
the
pr/mtardy/docs-website
branch
from
c67709e to
066d532
Compare
|
So now this PR does a bit more than intended:
Please look at the individual commits to review, it will be easier, especially for the renaming step. This PR will break the link to documentation like https://github.com/cilium/tetragon/blob/main/docs/tracingpolicy/README.md, this is intended because we will then redirect people to the properly built website documentation when this thing merges. |
mtardy
force-pushed
the
pr/mtardy/docs-website
branch
from
066d532 to
a1f5a57
Compare
Signed-off-by: Mahe Tardy <[email protected]>
Also add a paths-ignore to most workflows in order to skip code related workflows on docs changes. See the following link for more information: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-excluding-paths Signed-off-by: Mahe Tardy <[email protected]>
- mostly rename 'crds' into 'examples' and thus replace 'crds/examples' with 'examples/tracingpolicy' and simplify other directory structure under 'examples'. - fix all the links available in the repository from docs and code to point to the new 'examples' hierarchy instead of the old ones. - move the configuration dir struct example from 'docs/configuration' to 'examples/configuration'. - remove the symbolic link to the CRD definition yaml. - update the README of the new 'examples' folder. Signed-off-by: Mahe Tardy <[email protected]>
mtardy
force-pushed
the
pr/mtardy/docs-website
branch
from
a1f5a57 to
8d48096
Compare
This website is not finished, the goal is to merge it "as-is", not advertising it for now, finish the home page and branding and then advertise it!
When merging this, I need some manual steps to be performed on the repository settings to configure the GitHub page.
The main pain point that need to be addressed is that currently, this PR breaks the soft links that were made to the existing documentation that moved. Including examples from @sharlns and Jed report.