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

Documentation needs tidying #4606

Open
geyslan opened this issue Feb 19, 2025 · 1 comment · May be fixed by #4639
Open

Documentation needs tidying #4606

geyslan opened this issue Feb 19, 2025 · 1 comment · May be fixed by #4639
Assignees
Milestone

Comments

@geyslan
Copy link
Member

geyslan commented Feb 19, 2025

make -f ./builder/Makefile.mkdocs mkdocs-serve
docker run --rm \
        -v /home/gg/code/tracee:/docs \
        -p 8000:8000 \
        tracee-mkdocs:latest
INFO    -  Building documentation...
INFO    -  [macros] - No default module `main` found
INFO    -  [macros] - Config variables: ['extra', 'config', 'environment', 'plugin', 'git', 'generator', 'version', 'macros', 'filters', 'filters_builtin']
INFO    -  [macros] - Config macros: ['context', 'macros_info', 'now', 'fix_url']
INFO    -  [macros] - Config filters: ['pretty', 'relative_url']
INFO    -  Cleaning site directory
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - docs/events/builtin/extra/stack_pivot.md
  - docs/events/builtin/extra/suspicious_syscall_source.md
INFO    -  Doc file 'index.md' contains an unrecognized relative link './', it was left as is. Did you mean 'index.md'?
INFO    -  Doc file 'index.md' contains an unrecognized relative link './tutorials/overview', it was left as is. Did you mean 'tutorials/overview.md'?
INFO    -  Doc file 'index.md' contains an unrecognized relative link './docs/overview', it was left as is. Did you mean 'docs/overview.md'?
INFO    -  Doc file 'index.md' contains an unrecognized relative link './contributing/overview', it was left as is. Did you mean 'contributing/overview.md'?
INFO    -  Doc file 'index.md' contains an unrecognized relative link 'macfaq', it was left as is.
INFO    -  Doc file 'index.md' contains an unrecognized relative link './contributing/overview/', it was left as is. Did you mean 'contributing/overview.md'?
INFO    -  Doc file 'contributing/setup-development-machine-with-vagrant.md' contains an absolute link '/Vagrantfile', it was left as is.
INFO    -  Doc file 'docs/install/config/cli.md' contains an absolute link '/examples/config/', it was left as is.
WARNING -  Doc file 'docs/outputs/output-options.md' contains a link '../deep-dive/ordering-events.md', but the target 'docs/deep-dive/ordering-events.md' is not found among documentation files.
INFO    -  Doc file 'docs/policies/rules.md' contains an absolute link '/docs/docs/events/index.md', it was left as is.
INFO    -  Doc file 'tutorials/tracee-vagrant.md' contains an unrecognized relative link './kubernetes-quickstart', it was left as is.
INFO    -  Doc file 'docs/events/builtin/syscalls/renameat.md' contains a link '#openat', but there is no such anchor on this page.
INFO    -  Doc file 'docs/events/builtin/syscalls/renameat.md' contains a link '#unlinkat', but there is no such anchor on this page.
INFO    -  Documentation built in 6.83 seconds
@geyslan geyslan added this to the v0.24.0 milestone Feb 19, 2025
@ShohamBit
Copy link
Collaborator

i will take this issue

@ShohamBit ShohamBit linked a pull request Mar 3, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants