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

Docs: architecture + performance, scalability, resource consumption bounds + failure modes + coding guidelines #619

Closed
fntlnz opened this issue May 24, 2019 · 7 comments
Assignees
Labels
cncf Issues regarding the CNCF processes help wanted kind/documentation wontfix

Comments

@fntlnz
Copy link
Contributor

fntlnz commented May 24, 2019

I was digging into the documentation at falco.org and couldn't find a document with the architectural details of falco.
It would be useful for new contributors and users since both need to understand what falco is doing in order to contribute and use it.

@leodido
Copy link
Member

leodido commented Jul 3, 2019

We also need this in order to match the CNCF due diligence technical requirements.
One example is the notary one.

@leodido leodido added the cncf Issues regarding the CNCF processes label Jul 3, 2019
@leodido leodido changed the title Docs: architecture documentation Docs: architecture + performance, scalability, resource consumption bounds + coding guidelines Jul 3, 2019
@leodido leodido changed the title Docs: architecture + performance, scalability, resource consumption bounds + coding guidelines Docs: architecture + performance, scalability, resource consumption bounds + failure modes + coding guidelines Jul 3, 2019
@leodido
Copy link
Member

leodido commented Jul 3, 2019

I edited the title in order to use this issue as a reference also for other documents we need to write for the CNCF due diligence technical requirements.

Namely:

  • document the performance, scalability, complexity, reliability, security trade-offs made, and whether they are tunable by the user or not
  • document the failure modes
  • document and enforce the coding guidelines
    • lua
    • c++
    • cmake
    • yaml
    • dockerfile
    • go

@stale
Copy link

stale bot commented Oct 27, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Oct 27, 2019
@fntlnz
Copy link
Contributor Author

fntlnz commented Oct 28, 2019

We still want this stalebot!

@stale stale bot removed the wontfix label Oct 28, 2019
@mfdii mfdii self-assigned this Dec 4, 2019
@stale
Copy link

stale bot commented Feb 2, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Feb 2, 2020
@stale stale bot closed this as completed Feb 9, 2020
@leodido leodido reopened this Sep 21, 2020
@leodido
Copy link
Member

leodido commented Sep 21, 2020

/help

@poiana
Copy link
Contributor

poiana commented Sep 21, 2020

@leodido:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@stale stale bot closed this as completed Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf Issues regarding the CNCF processes help wanted kind/documentation wontfix
Projects
None yet
Development

No branches or pull requests

4 participants