8000 Documentation patch by ShohamBit · Pull Request #4303 · aquasecurity/tracee · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Documentation patch #4303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 30 commits into from
Sep 23, 2024
Merged

Documentation patch #4303

merged 30 commits into from
Sep 23, 2024

Conversation

ShohamBit
Copy link
Contributor
  1. Explain what the PR does:
  • fixing the configuration docs of tracee
  • added things to the global config
  • fixed docs issues
  • added the copy conntent to mkdocs
  1. Explain how to test it

view the section of:
Events in built in and extra events:

security_settime64 that wasnt working
security_path_notify wasnt exisit
set_fs_pwd wasnt exisit
tracee_info wasnt exisit

Events in built in and security events:

format wasnt exist

CLI flags in scope:

removed the option of using wildcard because it doesn't work with tracee

tutorials:
the link to Kubernetes guide didnt work

Overview file in the docs:

section the Tutorials ,Docs and Contributing wasnt correct
the macfaq was in () insted of []
contribution documentation was with out the .md

you can view less importent things in the files changed of the git hub pr

ShohamBit added 19 commits September 16, 2024 14:20< 8000 /div>
@ShohamBit
change the documentation for how to run tracee with config file, adde…
52249d5 
…d an exemple for json over the yaml file, also add a note for where to find exemple file
@ShohamBit
added a file for the futer to write a documentation on how to write a…
a7b12aa 
… config file
@ShohamBit
changed the docs and tutorials palce, and added custom configure to …
f5f1e1a 
…config install
@ShohamBit
added the option to view the custom configurtion of config file
aa3f1c1
@ShohamBit
fixed spelling issue
feec697
@ShohamBit
added the finel version of custom configuration to docs section also …
f9be897 
…changed the overview file content to olny review the custom config, cli, and kubernatics sections
@ShohamBit
change the mkdocs file to serve ass the new docs represantation of tr…
344a837 
…acee
@ShohamBit
added some changes to sutom config
dd9e7f8
@ShohamBit
added some missing flags in the yaml file
91330e2
@ShohamBit
deleted the custom configure file, marge it with the index, remove ba…
fdbd94e 
…sh and json, add view mores to sections
@ShohamBit
remove custom config from mkdocs
9558b88
@ShohamBit
added things that was missing, changes and solved issues with files,…
ddf421c 
… add a material fetures for copy to clipboard
@ShohamBit
change a bit the looks
d911b48
@ShohamBit
added final changes
6074dcd
@ShohamBit
removed wild card option for scope
589d058
@ShohamBit
changed Scope filters to Rules filter - need further changes on Even…
92fa3a6 
…ts under rules
@ShohamBit
added a modified description of scope to the scope section under conf…
221c86c 
…ig, take most of it from the cli flags section
@ShohamBit
modified rules section under policy because scope filter was confusi…
32e8030 
…ng, also change a bit the discription of other section
@ShohamBit
modify rules and scope sections
18738f9
geyslan
geyslan reviewed Sep 17, 2024
View reviewed changes
Copy link
Member
@geyslan geyslan left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did the first pass-through review (skimming).

NOTE: I didn't check the links.

@ShohamBit
Copy link
Contributor Author

thank you @geyslan, do you think i should add back the part about the wildcard or to wait for a respond from @NDStrahilevitz

ShohamBit and others added 5 commits September 18, 2024 14:20
@ShohamBit @geyslan
Update docs/docs/install/config/index.md
849ccf2 
Co-authored-by: Gregório G. <geyslan@gmail.com>
@ShohamBit @geyslan
Update docs/docs/install/config/cli.md
4418b27 
Co-authored-by: Gregório G. <geyslan@gmail.com>
@ShohamBit @geyslan
Update docs/docs/policies/rules.md
1e02ab4 
Co-authored-by: Gregório G. <geyslan@gmail.com>
@ShohamBit
resolve changes
3aeaf76
@ShohamBit
resolve more changes
d48b0fe
@geyslan
Copy link
Member
geyslan commented Sep 18, 2024

thank you @geyslan, do you think i should add back the part about the wildcard or to wait for a respond from @NDStrahilevitz

Don't mention it 👍🏼. He already answered.

ShohamBit
ShohamBit commented Sep 22, 2024
View reviewed changes
@itaysk itaysk merged commit 27f3bcf into aquasecurity:main Sep 23, 2024
25 checks passed
@ShohamBit ShohamBit deleted the documentation_patch branch September 24, 2024 09:34
@yanivagman
Copy link
Collaborator
yanivagman commented Oct 25, 2024 •
edited
Loading

Why did you rename scope filters to process filters?
There are several reasons to keep calling it scope filters:

  1. In the rule, we are further filtering the scope given in the policy
  2. This is more intuitive for the user since both policy scope and rule scope filters are filtering the same fields
  3. In the future, we want to extend the rule scope filters to also include container/pod related fields - then the term "process filters" will be incorrect

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@geyslan geyslan geyslan left review comments

@NDStrahilevitz NDStrahilevitz NDStrahilevitz left review comments

@itaysk itaysk itaysk approved these changes

Assignees

@ShohamBit ShohamBit

Labels
kind/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ShohamBit @geyslan @yanivagman @itaysk @NDStrahilevitz
0