falco
falco copied to clipboard
falcosecurity
[WIP] update(docs): add overview and versioning sections to falco release.md
Co-authored-by: Leonardo Grasso [email protected] Signed-off-by: Melissa Kilby [email protected]
What type of PR is this?
Uncomment one (or more)
/kind <>lines:
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind release
If contributing rules or changes to rules, please make sure to also uncomment one of the following line:
/kind rule-update
/kind rule-create
Any specific area of the project related to this PR?
Uncomment one (or more)
/area <>lines:
/area build
/area engine
/area rules
/area tests
/area proposals
/area CI
What this PR does / why we need it:
Add more technical clarity to the release doc, see https://github.com/falcosecurity/falco/issues/2195
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
@leogr - started with adding an overview section and as discussed more information around versioning of Falco components. Perhaps we should adjust the old sections to the new style you started for libs https://github.com/falcosecurity/libs/pull/580? Would you want to take care of the next commit and I can then help polish things afterwards? Please feel free to overwrite and improve anything I wrote so far :)
Does this PR introduce a user-facing change?:
NONE
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by: incertum
Once this PR has been reviewed and has the lgtm label, please assign fededp for approval by writing /assign @fededp in a comment. For more information see:The Kubernetes Code Review Process.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
@leogr - started with adding an overview section and as discussed more information around versioning of Falco components. Perhaps we should adjust the old sections to the new style you started for libs falcosecurity/libs#580? Would you want to take care of the next commit and I can then help polish things afterwards? Please feel free to overwrite and improve anything I wrote so far :)
:+1:
I plan to do that once we have released libs (so we at least can say we have tried it :smile_cat: )
@leogr Added additional details into the doc as suggested. Ok to ask for more polishing commit. After that we can merge and you can edit the rest in a follow up PR.