docs: improve documentation and description of base_syscalls option #2515
Conversation
happy-dude
force-pushed
the
base_syscalls_description
branch
from
1bae490 to
866c637
Compare
|
Generally, I moved things around in a format where it flows from
|
|
Also, I would like to add a blurb about the |
There was a problem hiding this comment.
@happy-dude 🤩 OMG this is amazing! Could we get your help to improve the config descriptions throughout over time 🙃 ?
Thanks so much truly ❤️ !
Re -A @jasondellaluce would you have ideas? It's not technically related to base_syscalls and we do have good warning messages, but at the same time mentioning it here could not hurt if we find a good way of doing it?
| # When enabled, this option is designed to | ||
| # (1) ensure that Falco's state engine is successfully built-up correctly | ||
| # (2) be the most system resource-friendly by activating the least number of | ||
| # additional syscalls (outside of those enabled for enabled rules) |
There was a problem hiding this comment.
❤️ amazing Stanley!!!! Much better way of selling this feature.
happy-dude
force-pushed
the
base_syscalls_description
branch
from
866c637 to
9ea43c9
Compare
|
Resolved some suggestions, typos, and wording, thanks @incertum ! |
happy-dude
force-pushed
the
base_syscalls_description
branch
from
9ea43c9 to
f5cfb31
Compare
|
Commit + rebased another suggestion. Also added a new commit that cleans up some extraneous whitespace on some lines. Can drop if it doesn't belong in this PR 👍 |
happy-dude
force-pushed
the
base_syscalls_description
branch
from
f5cfb31 to
c30be41
Compare
happy-dude
force-pushed
the
base_syscalls_description
branch
from
c30be41 to
d7494bb
Compare
There was a problem hiding this comment.
This is an incredible work! Thank you very much @happy-dude !
Great research and wording!!
Thank you, left some comments!
|
/milestone 0.35.0 |
happy-dude
force-pushed
the
base_syscalls_description
branch
from
8e6ce93 to
f01bbe6
Compare
|
Apologies for the delay, thanks for the suggestions, Federico! Made use of the super-neat GitHub batch + signoff + commit feature and rebased latest suggestions :) Removing WIP tag from PR and looking for approvals for merge 🙏 |
happy-dude
changed the title
|
LGTM label has been added. Git tree hash: ac830d8e3ccf5414d58ccbe9f822ccbfd8a22710
|
Co-authored-by: Federico Di Pierro <nierro92@gmail.com> Co-authored-by: Melissa Kilby <melissa.kilby.oss@gmail.com> Signed-off-by: Stanley Chan <pocketgamer5000@gmail.com>
Signed-off-by: Stanley Chan <pocketgamer5000@gmail.com>
happy-dude
force-pushed
the
base_syscalls_description
branch
from
f01bbe6 to
72acbe9
Compare
|
LGTM label has been added. Git tree hash: d7c47eda10886aa16261e9e3074ecbd83887d612
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: FedeDP, Happy-Dude, leogr 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 |
poiana
added
release-note-none
and removed
do-not-merge/release-note-label-needed
labels
What type of PR is this?
/kind documentation
What this PR does / why we need it:
base_syscallsoption.Which issue(s) this PR fixes:
(no issue ticket filed)
Special notes for your reviewer:
cc @incertum @jasondellaluce for review, thanks for help!
Does this PR introduce a user-facing change?:
No, since this is a net-new feature going into Falco
0.35+