Improve the integration tests framework documentation

[belimawr]

What does this PR do?

It improves the integration tests framework documentation on how to debug test from the remove VMs.

Why is it important?

It improves the integration tests framework documentation on how to debug test from the remove VMs.

Checklist

• [ ] My code follows the style guidelines of this project
• [ ] I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• [ ] I have made corresponding change to the default configuration files
• [ ] I have added tests that prove my fix is effective or that my feature works
• [ ] I have added an entry in ./changelog/fragments using the changelog tool
• [ ] I have added an integration test or an E2E test

## Disruptive User Impact
## How to test this PR locally
## Related issues

Questions to ask yourself

• How are we going to support this in production?
• How are we going to measure its adoption?
• How are we going to debug this?
• What are the metrics I should take care of?
• ...

[elasticmachine]

Pinging @elastic/elastic-agent (Team:Elastic-Agent)

[mergify]

This pull request does not have a backport label. Could you fix it @belimawr? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

• backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

[mergify]

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b improve-integ-test-docs upstream/improve-integ-test-docs
git merge upstream/main
git push upstream improve-integ-test-docs

[mergify]

backport-v8.x has been added to help with the transition to the new branch 8.x.

[elasticmachine]

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

[mergify]

backport-v8.x has been added to help with the transition to the new branch 8.x.

[swiatekm]

Looks good as far as I can tell, but I'd prefer someone more familiar with the framework to review too.

[belimawr]

It seems this PR is waiting on SonarQube even though it only changes documentation. 🤔

I enabled auto-merge and I'll look more into it tomorrow.

[ycombinator]

No need for SonarQube check on this docs-only PR. Force merging...