https://github.com/perfwiki/main
perf: Linux profiling with performance counters
https://github.com/perfwiki/main
linux linux-kernel performance
Last synced: 12 months ago
JSON representation
perf: Linux profiling with performance counters
- Host: GitHub
- URL: https://github.com/perfwiki/main
- Owner: perfwiki
- Created: 2024-08-10T04:11:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T18:58:53.000Z (over 1 year ago)
- Last Synced: 2024-10-24T04:55:27.722Z (over 1 year ago)
- Topics: linux, linux-kernel, performance
- Homepage: https://perfwiki.github.io
- Size: 42.6 MB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [perfwiki.github.io](https://perfwiki.github.io/)
This repository contains the markdown migration of the perf.wiki.kernel.org pages.
We can browse perf wiki on terminal environment with [glow](https://github.com/charmbracelet/glow?tab=readme-ov-file#installation).
# Check the [perfwiki.github.io](https://perfwiki.github.io/) in the localhost
If you want to check the MkDocs UI as a webpage in this workspace,
You only need to do it once at the beginning: `pip install mkdocs-material mkdocs-git-revision-date-localized-plugin`.
Do `mkdocs serve`, Then go to http://127.0.0.1:8000/
```sh
$ virtualenv .venv
$ source .venv/bin/activate
# You only need to do it once at the beginning:
# Debian: sudo apt-get install -y python3-virtualenv
# Redhat: sudo dnf install -y python3-virtualenv
# pip install mkdocs-material mkdocs-git-revision-date-localized-plugin
$ mkdocs serve
...
Watching paths for changes: 'docs', 'mkdocs.yml'
Serving on http://127.0.0.1:8000/
```
# Automated deployment from markdown
If the markdown results are pushed to `origin/main`, [Github CI](.github/workflow/ci.yml) will automatically run and deploy to the `gh-deploy` branch.
If manual updates to the [perfwiki.github.io](https://perfwiki.github.io/) are needed, you can run `mkdocs gh-deploy` directly to deploy it.
If anyone would like to contribute content, feel free to submit a Pull Request on the [github.com/perfwiki/main](https://github.com/perfwiki/main) repo, or you can email me by including me in the mailing list.
```sh
$ git add .
$ git commit
$ git push
```
or You can also send me a patch file if you prefer. If you want to assign
other people to the email, you can add them.
```
# Don’t forget to change the address below to my "@gmail.com" :)
$ git send-email --to='Yunseong Kim ; ' \
--cc='linux-perf-users@vger.kernel.org; ' \
--confirm=always your/path/0001-your-patch
```
# Adding Tab
You can add the links in the left-hand tab by modifying the [mkdocs.yml](mkdocs.yml) file.
```yml
nav:
- Main Page: index.md
- Tutorial : tutorial.md
...
- Your New Tab: your-new-page.md
...
```