docs: Add note about environment variable DOTNET_EnableDiagnostics

[simonswine]

This adds some instructions how to make sure profiling is working in dotnet 8.

See dotnet/runtime#96227

[github-actions]

This PR must be merged before a backport PR will be created.

[github-actions]

This PR must be merged before a backport PR will be created.

[github-actions]

The backport to release/v1.5 failed:

Validation Failed: "Could not resolve to a node with the global id of 'T_kwDOAG3Mbc4AczmP'."

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3291-to-release/v1.5 origin/release/v1.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 7aaf8e1e172982143f1913de0ff9fcc6689b60c8

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-3291-to-release/v1.5
# Create the PR body template
PR_BODY=$(gh pr view 3291 --json body --template 'Backport 7aaf8e1e172982143f1913de0ff9fcc6689b60c8 from #3291{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.5] docs: Add note about environment variable `DOTNET_EnableDiagnostics`" --body-file - --label "type/docs" --label "backport" --base release/v1.5 --milestone release/v1.5 --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-3291-to-release/v1.5

# Create a pull request where the `base` branch is `release/v1.5` and the `compare`/`head` branch is `backport-3291-to-release/v1.5`.

# Remove the local backport branch
git switch main
git branch -D backport-3291-to-release/v1.5