Skip to content

docs: fix README links leading nowhere #3009

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

Jump to bottom
Merged
brancz merged 1 commit into from
Dec 17, 2024
Merged

docs: fix README links leading nowhere #3009

brancz merged 1 commit into from
Dec 17, 2024

Conversation

@BunningsWarehouseOfficial
Copy link
Contributor

@BunningsWarehouseOfficial BunningsWarehouseOfficial commented Dec 16, 2024

No description provided.

@CLAassistant
Copy link

CLAassistant commented Dec 16, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@BunningsWarehouseOfficial
Copy link
Contributor Author

BunningsWarehouseOfficial commented Dec 16, 2024

The website at https://www.parca.dev/docs/parca-agent/ is also giving an inconsistent message as to what the default sampling rate is:

Parca Agent is an always-on sampling profiler that uses eBPF to capture raw profiling data with very low overhead. It observes user-space, and kernel-space stack traces 100 times per second...

https://www.parca.dev/docs/parca-agent-design/#cpu-sampling-frequency

We sample at 19Hz (19 times per second)...

@BunningsWarehouseOfficial
Copy link
Contributor Author

BunningsWarehouseOfficial commented Dec 17, 2024

The Java Support page also seems out of date given the current status of #1 and my own personal experience playing around with Java profiling.

brancz
brancz approved these changes Dec 17, 2024
View reviewed changes
Copy link
Member

@brancz brancz left a comment

Choose a reason for hiding this comment

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

Thank you!

Yes, there are various things out of date, everything you mentioned needs to be fixed in the docs. Want to give us a hand? :)

@brancz brancz merged commit b60e4a7 into parca-dev:main Dec 17, 2024
7 checks passed
@BunningsWarehouseOfficial
Copy link
Contributor Author

BunningsWarehouseOfficial commented Dec 18, 2024

Yeah sure, I could help out with docs, I just wasn't confident on my ability to do so accurately given that I used Parca for the first time only 2 days ago 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brancz brancz brancz approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@BunningsWarehouseOfficial @CLAassistant @brancz