📖 (doc): Add under the docs/draft how to profilling with pprof

[camilamacedo86]

This one as just a doc to show we can use pprof with the components
The usage of pprof can help us solve bugs and analyse issues
It is blocked by #1875 because we need to add a flag.

It is related to (Motivated by):

• catalogd web api benchmarking #1607
• Add tests to generate pprof files #1040
• [epic] v1.0.0 Performance and Scale #920

[netlify]

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	f12c8f7
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/67dc0c5b224f34000883b32e
😎 Deploy Preview	https://deploy-preview-1876--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[camilamacedo86]

/hold until we get merged #1875

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.94%. Comparing base (0c87596) to head (f12c8f7).
Report is 29 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1876 +/- ##
==========================================
- Coverage 69.00% 68.94% -0.06% 
==========================================
Files 66 66 Lines 5236 5236 ==========================================
- Hits 3613 3610 -3 - Misses 1392 1394 +2 - Partials 231 232 +1 

Flag	Coverage Δ
e2e	50.35% <ø> (-0.08%)	⬇️
unit	56.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[anik120]

I don't think this is needed in the user docs.

The docs folder hosts the OLMv1 user docs, and this is a dev doc.

[camilamacedo86]

Hi @anik120

Thank you for your input and help. As far I understand our documentation as a whole is valid for both end users and maintainers.

IHMO: I believe it is important to have documentation that explains how to enable and use it with the components. This will be helpful for end users when they encounter issues and need gather further details, as well as for us (maintainers) when we are looking to debug an issue

[camilamacedo86]

/hold cancel

We can move forward now

[anik120]

Yea we probably need to have a conversation about where we want dev docs to be. Usually it's not in the same place because that causes confusion. We don't want our non-technical users to be flooded with dev docs.

Eg: k8s has user docs here , and separate dev docs here.

I've never run into any dev docs while using kubernetes.io.

[camilamacedo86]

HI @anik120

Yea we probably need to have a conversation about where we want dev docs to be. Usually it's not in the same place because that causes confusion. We don't want our non-technical users to be flooded with dev docs.

Being able to profile is valuable not only for maintainers but also for end users.
For example, here's a relevant community request: #1040

Additionally, the docs/draft directory is a suitable place to keep draft documentation for this cases.
We already use it for things like the personas doc:
https://github.com/operator-framework/operator-controller/tree/main/docs/draft/project

I understand we’ve previously discussed this, and to clarify:
Files in docs/draft do NOT get published on the website.

Anyway, we have already a dedicated section on our website for maintainers and contributors.
But we also want to avoid adding new docs to the website without a big criteria, that is why we have been using the docs/draft instead.

Hi @anik120,

As we discussed privately, we brought this up in today’s community meeting, and there were no objections to adding this document under docs/draft.

Following your suggestion—I’m dismissing your review on this one so we can move forward. That said, please don’t hesitate to reach out if you’d like to revisit it. We can always update, refine, or change the document as needed in the future.

Thanks so much!