Skip to content
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.

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

refactor(docs/plugins): update plugin documentation for 1.0.0 version changes #581

Merged
merged 13 commits into from
Jun 3, 2022

Conversation

jasondellaluce
Copy link
Contributor

What type of PR is this?

/kind content

Any specific area of the project related to this PR?

/area documentation

What this PR does / why we need it:

Following up the developments of falcosecurity/falco#1948, this PR updates the plugin documentation with the most up-to-date changes.

Which issue(s) this PR fixes:

Special notes for your reviewer:

This PR needs to stay WIP until Falco 0.32 gets released (falcosecurity/falco#1993), so that the website snapshot for Falco 0.31.X can be preserved with the current state of the plugins documentation.

…lities

Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
…of plugin type

Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
…f plugin type

Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
This follows up the recent changes regarding explicit list field types, the new event_to_string signature,
the new field arg required/supported semantics, and the separator field in list_open_params.

Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
…d remove C++ SDK walkthrough

Moving the SDK walkthrough in an ad-hoc section allow more in-depth overviews, and will work better for the future.
The choice of removing the C++ SDK walkthrough is motivated by the fact that it has lately been updated actively, which
makes it not-operational for the most recent plugin API changes. For now, the section has been removed and will be
restored in the future once the C++ SDK is refactored to support the newest API changes.

Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
@jasondellaluce jasondellaluce force-pushed the update/plugins-docs branch 2 times, most recently from 748c23e to 67c236c Compare May 10, 2022 16:44
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
… SDK Go

Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Copy link
Member

@leogr leogr left a comment

Choose a reason for hiding this comment

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

This is a great improvement:heart_eyes_cat:

Just left some nits.

content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
content/en/docs/plugins/_index.md Outdated Show resolved Hide resolved
Signed-off-by: Jason Dellaluce <jasondellaluce@gmail.com>
Co-authored-by: Leonardo Grasso <me@leonardograsso.com>

Co-authored-by: Leonardo Grasso <me@leonardograsso.com>
@jasondellaluce jasondellaluce changed the title wip: refactor(docs/plugins): update plugin documentation for 1.0.0 version changes refactor(docs/plugins): update plugin documentation for 1.0.0 version changes Jun 3, 2022
Copy link
Member

@leogr leogr left a comment

Choose a reason for hiding this comment

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

⛱️

@poiana poiana added the lgtm label Jun 3, 2022
@poiana
Copy link

poiana commented Jun 3, 2022

LGTM label has been added.

Git tree hash: c1be41e47cdf4f3d9f9ac9fac3a34468ca016b45

@poiana
Copy link

poiana commented Jun 3, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jasondellaluce, 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:
  • OWNERS [jasondellaluce,leogr]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@poiana poiana merged commit 2caf246 into master Jun 3, 2022
@poiana poiana deleted the update/plugins-docs branch June 3, 2022 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants