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

ebpf-library: Libbpf documentation layout #68

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

dylandreimerink
Copy link
Collaborator

This PR adds a rough directory structure for future libbpf as well as index files future content (without the links).

This commit adds a rough directory structure for future libbpf
as well as index files future content (without the links).

This should help when populating the libbpf documentation.

Signed-off-by: Dylan Reimerink <[email protected]>
@DaFray31
Copy link
Contributor

DaFray31 commented Oct 14, 2024

Looks clean

Out of the scope of the PR :
My opinion, the left menu is bit mess ? Should we remove the "Linux References", and to have directly Concepts, Programs types, etc. (because its a "useless" click) ?
But that ask question about where to place the first concept page (with BTF and ELF).

In the concept page of Linux References you said :

This is an index of Linux specific eBPF concepts and features. For more generic eBPF concepts that are not Linux specific, see the eBPF concepts page.

But technically, eBPF on others systems (think about windows), have the same concepts, functions etc (with some hic yes).

@dylandreimerink
Copy link
Collaborator Author

Looks clean

👍 Then I will merge it.

Out of the scope of the PR :
My opinion, the left menu is bit mess ? Should we remove the "Linux References", and to have directly Concepts, Programs types, etc. (because its a "useless" click) ?

Yes, agreed. That should just be a matter of restructuring the SUMMARY.md files. (currently it resembles the actual structure perhaps a bit to much).

But that ask question about where to place the first concept page (with BTF and ELF).

In the concept page of Linux References you said :

This is an index of Linux specific eBPF concepts and features. For more generic eBPF concepts that are not Linux specific, see the eBPF concepts page.

Right. The whole reason for the Linux sub-section is the Windows support. My thought was that we would have a generic concepts page for features that are universal, and then have Linux and Windows specific concepts in their own places. But perhaps that makes it more difficult than it has to be.

But technically, eBPF on others systems (think about windows), have the same concepts, functions etc (with some hic yes).

Right, I need to dive into this more honestly. I know the eBPF-for-Windows project is trying to keep as much of the API compatible. But there will be differences. Perhaps we should just document the Linux vs Windows availability on the page itself and have all "Concepts" together in one dir/list/overview.

@dylandreimerink dylandreimerink merged commit 01c4d99 into master Oct 15, 2024
1 check passed
@dylandreimerink dylandreimerink deleted the feature/libbpf-doc-layout branch November 18, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants