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.

Sign up for GitHub

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

chore(ci,docs): disable ToC in perf gh pages. #1930

Merged
merged 3 commits into from
Jun 21, 2024
Merged

chore(ci,docs): disable ToC in perf gh pages. #1930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4831732
chore(ci,docs): disable ToC in perf gh pages.
FedeDP Jun 21, 2024
d3dc8c5
chore(ci): directly mkdocs using downloaded svgs instead of inlining …
FedeDP Jun 21, 2024
df6df9e
chore(ci): properly use correct html tag for interactive svgs.
FedeDP Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .github/generate_inline_svg_md.py
View file
Open in desktop

This file was deleted.

22 changes: 11 additions & 11 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,24 +93,24 @@ jobs:
sed -i '1s/^/---\nhide:\n- toc\n---\n\n/' docs/matrix_X64.md
sed -i '1s/^/---\nhide:\n- toc\n---\n\n/' docs/matrix_ARM64.md

- uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
with:
python-version: 3.x

- name: Download perf svg files
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
with:
name: perf_svg

- name: Generate perf pages
run: |
python3 .github/generate_inline_svg_md.py trace_tests.svg
mv out.md docs/unit_tests.md
rm -rf out.md
python3 .github/generate_inline_svg_md.py trace_scap.svg
mv out.md docs/scap_file.md
rm -rf out.md

mv trace_tests.svg docs/trace_tests.svg
echo '<object data="../trace_tests.svg" type="image/svg+xml" id="unit_tests"></object>' > docs/unit_tests.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using the object tag, we have an interactive svg!

sed -i '1s/^/---\nhide:\n- toc\n---\n\n/' docs/unit_tests.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as for kernel testing matrixes.

mv trace_scap.svg docs/trace_scap.svg
echo '<object data="../trace_scap.svg" type="image/svg+xml" id="scap_file"></object>' > docs/scap_file.md
sed -i '1s/^/---\nhide:\n- toc\n---\n\n/' docs/scap_file.md

- uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
with:
python-version: 3.x

- run: pip install mkdocs mkdocs-material

- run: mkdocs build
Expand Down
3 changes: 2 additions & 1 deletion docs/perf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Home of Falco Perf Monitoring

Our CI is capable of continuosuly benchmarking performance of our userspace code.
Our CI is capable of continuously benchmarking performance of our userspace code.
Every PR will have a comment with the perf diff from master for multiple aspects, while on master the flamegraph are pushed to this github pages.

Navigate to the perf reports on the left, or click these links:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Properly render bullet list.

* [unit tests perf](unit_tests.md)
* [scap file reading perf](scap_file.md)
Loading