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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate doxygen documentation #1513

Closed
wants to merge 6 commits into from
Closed

Generate doxygen documentation #1513

wants to merge 6 commits into from

Conversation

leodido
Copy link
Member

@leodido leodido commented Dec 24, 2020

What type of PR is this?

/kind documentation

/kind feature

Any specific area of the project related to this PR?

/area build

What this PR does / why we need it:

This PR introduces a way to build the Falco development docs. 馃帀

Docs for developers, and people that want to contribute to Falco, are a long-standing feature needed by our community. Thus, I decided to package this gift for our awesome community 馃巵

Namely, this PR:

  • introduces a new target - ie., GenerateDocs - to generate Doxygen documentation
    • to work it requires doxygen, jinja2, and pygments installed on the machine
    • uses mosra/m.css (A no-nonsense, no-JavaScript CSS framework for content-oriented websites)
      • live demo of a possible final result here 馃憟
  • introduces CPM (that I intend to use to simplify the way we handle all our dependencies)
    • it's a CMake module that adds dependency management capabilities to CMake
    • It's built as a thin wrapper around CMake's FetchContent module that adds version control, caching, a simple API
    • read more at the provided link for extensive documentation about it

How to try it out

cmake -Hdocumentation -Bbuild/docs
cmake --build build/docs --target GenerateDocs

Then open the build/docs/doxygen/html/index.html file in your browser.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Things to do to consider it 100% done:

  • add doxygen comments to our source code
  • fine-tune the generated docs structure (navbars, etc.)
  • fine-tune the generated docs content
  • publish the HTML using a CI job (to discuss with the community how/where/etc.)
    • community choose to put development docs on a new website (falcosecurity.dev)
    • obtain falcosecurity.dev

/hold

Does this PR introduce a user-facing change?:

new: Falco development docs at ...

Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
@poiana
Copy link

poiana commented Dec 24, 2020

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign leodido after the PR has been reviewed.
You can assign the PR to them by writing /assign @leodido in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

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

@leodido
Copy link
Member Author

leodido commented Dec 24, 2020

Some screenshots of the current (not final) outcome:

image
image
image
image
image
image

@leodido
Copy link
Member Author

leodido commented Dec 25, 2020

/milestone 0.27.0

@poiana poiana added this to the 0.27.0 milestone Dec 25, 2020
Signed-off-by: Leonardo Grasso <me@leonardograsso.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.

I love this 馃ぉ

Really nice and clean 馃憤

PS
I have adjusted the license's badge link that should fix the README rendering issue.

@fntlnz fntlnz modified the milestones: 0.27.0, 0.28.0 Jan 15, 2021
@leodido
Copy link
Member Author

leodido commented Feb 3, 2021

Update:

thanks to the CNCF (@caniszczyk) we now have falcosecurity.dev 馃コ and we can unblock this effort

@leodido
Copy link
Member Author

leodido commented Apr 9, 2021

/milestone 0.28.1

@poiana poiana modified the milestones: 0.28.0, 0.28.1 Apr 9, 2021
@leogr leogr modified the milestones: 0.28.1, 0.29.0 Apr 26, 2021
@leogr leogr modified the milestones: 0.29.0, 0.30.0 Jun 17, 2021
@deepskyblue86
Copy link
Contributor

Up!

@leogr leogr modified the milestones: 0.30.0, 0.31.0 Sep 28, 2021
@poiana
Copy link

poiana commented Dec 27, 2021

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@jasondellaluce
Copy link
Contributor

/milestone 0.32.0

@poiana poiana modified the milestones: 0.31.0, 0.32.0 Jan 19, 2022
@leogr
Copy link
Member

leogr commented Jan 19, 2022

Hey @leodido

What do you think about unblocking this PR so that we can continue this effort in subsequent PRs?

Even though the current status of this PR does not achieve the final result, it seems to be working. Thus, IMO, it is worth merging it as-is now.
Wdyt? 馃槂

@poiana
Copy link

poiana commented Feb 18, 2022

Stale issues rot after 30d of inactivity.

Mark the issue as fresh with /remove-lifecycle rotten.

Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle rotten

@poiana
Copy link

poiana commented Mar 20, 2022

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community.
/close

@poiana
Copy link

poiana commented Mar 20, 2022

@poiana: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community.
/close

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.

@poiana poiana closed this Mar 20, 2022
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.

None yet

6 participants