tracee icon indicating copy to clipboard operation
tracee copied to clipboard

feat: add docs further-reading

Open krol3 opened this issue 3 years ago • 6 comments

Related the issue https://github.com/aquasecurity/tracee/issues/1314, adding a section "further Reading", like the other projects starboard and trivy.

krol3 avatar Feb 13 '22 02:02 krol3

@AnaisUrlichs would you mind reviewing this PR ? I think @krol3 is proposing something you recently mentioned to us, but I'm not sure this is what you had in mind (regarding place, formatting, etc). Thanks!

rafaeldtinoco avatar Feb 13 '22 05:02 rafaeldtinoco

@itaysk @AnaisUrlichs for a first release about more documentation in Tracee. Do you have a request change in this PR? or do you prefer to close this?

krol3 avatar Mar 17 '22 15:03 krol3

@itaysk I'll let you merge this one (based on your discussions with @AnaisUrlichs).

rafaeldtinoco avatar Apr 11 '22 13:04 rafaeldtinoco

I think we should merge it and then I can reorganise the docs a little afterwards @itaysk thoughts?

AnaisUrlichs avatar Apr 11 '22 13:04 AnaisUrlichs

LGTM! My only comment is that "reference" might be confusing heading. I am starting to think we should have just 2 types of docs : reference and tutorials. (Reference docs is like the Trivy manual and tutorial are how to solve specific scenarios). If we don't want to make the switch in this PR that's fine

itaysk avatar Apr 14 '22 09:04 itaysk

@krol3 can you rebase this and address comments ? I need to either merge or close this! Thanks!

rafaeldtinoco avatar Jun 24 '22 12:06 rafaeldtinoco

Closing this PR as it is pretty much dead right now. Please open a new one if really needed.

rafaeldtinoco avatar Aug 29 '22 12:08 rafaeldtinoco