cleanup(docs): edit libs page content for technical clarity #1307
Conversation
incertum
force-pushed
the
libs-page-edits
branch
3 times, most recently
from
13aba7a to
9bd9e6a
Compare
docs/syscalls.md
Outdated
|
|
||
| ## Glossary | ||
|
|
||
| * 🟢 -> means that the syscall is implemented as a specific event | ||
| * 🟡 -> means that the syscall is implemented as a generic event | ||
| The Falco Projects' kernel drivers support monitoring a range of syscalls. For a subset of syscalls (indicated with 🟡), we only monitor when the syscalls are triggered (internally in libs, we refer to these as generic syscalls), but we do not extract the syscall arguments for those. |
There was a problem hiding this comment.
Is this part a leftover?
It is lready present in the index page :)
There was a problem hiding this comment.
🤦♀️ it was intentional, ok tried to give it a whole new spin, let me know what you think about the new version.
Apart from the language edits I mostly hope these changes may make the navigation a bit easier.
Lastly, folks may just directly navigate to the supported syscalls table, why not put the Glossary right there?
There was a problem hiding this comment.
Lastly, folks may just directly navigate to the supported syscalls table, why not put the Glossary right there?
Because tables are autogenerated thus it is much harder to make changes like the one you are doing right now (it would require GO source file changes to syscalls-bumper in the syscalls table case, and to kernel-testing repo for the kernel matrixes).
There was a problem hiding this comment.
I think it is better to leave glossaries to the opening page, and then leave the autogenerated pages on their own.
|
/milestone 0.13.0 |
incertum
force-pushed
the
libs-page-edits
branch
from
9bd9e6a to
a61ada3
Compare
Signed-off-by: Melissa Kilby <[email protected]>
incertum
force-pushed
the
libs-page-edits
branch
from
a61ada3 to
6663b74
Compare
|
LGTM label has been added. Git tree hash: aa626b98f4ae1de90895dd554e03c8efd9863bd6
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Andreagit97, 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 cleanup
Any specific area of the project related to this PR?
Does this PR require a change in the driver versions?
What this PR does / why we need it:
@FedeDP as promised a while back, proposing some changes to the
libspage.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: