new(ci): added github pages around rules overview file. #116
Conversation
poiana
added
kind/feature
|
/cc @incertum |
mkdocs.yml
Outdated
| site_name: Falcosecurity Rules | ||
| site_url: https://github.com/falcosecurity/rules | ||
| nav: | ||
| - Home: index.md |
There was a problem hiding this comment.
We have a single file, the overview one.
Signed-off-by: Federico Di Pierro <nierro92@gmail.com>
FedeDP
force-pushed
the
new/inventory_pages
branch
from
18c97d8
to
a14ecff
Compare
| @@ -0,0 +1,2 @@ | |||
| mkdocs | |||
There was a problem hiding this comment.
Python requirements for the mkdocs tool.
| @@ -0,0 +1,6 @@ | |||
| site_name: Falcosecurity Rules | |||
There was a problem hiding this comment.
Mkdocs config file; we only have a single page, the overview one.
|
|
||
| - name: Generate inventory | ||
| run: | | ||
| python rules_inventory/scripts/rules_overview_generator.py --rules_file=rules/falco_rules.yaml > docs/overview.md |
There was a problem hiding this comment.
We generate the overview page dynamically.
There was a problem hiding this comment.
In a follow up PR we could find a new home for the python script? For example directly more hidden in the .github? Let me know and I was gonna update the script now that most rules are already tagged.
There was a problem hiding this comment.
We can do that for sure!
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: FedeDP, incertum The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind feature
Any specific area of the project related to this PR?
/area documentation
What this PR does / why we need it:
This PR adds a github page around rules overview file.
Old file
rules_inventory/rules_overview.mdis removed because it is now useless.NOTE: no file needs to be pushed; the overview is generated in the CI and deployed to gh pages without pushing anyhing on the repo.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: