Skip to content

Docs - Added Test Observability as a reporter#10113

Merged
christian-bromann merged 3 commits intowebdriverio:mainfrom
sourav-kundu:patch-3
Apr 5, 2023
Merged

Docs - Added Test Observability as a reporter#10113
christian-bromann merged 3 commits intowebdriverio:mainfrom
sourav-kundu:patch-3

Conversation

@sourav-kundu
Copy link
Contributor

@sourav-kundu sourav-kundu commented Apr 4, 2023

BrowserStack Test Observability is a standalone test reporter, a debugging tool, and also surfaces test suite health-related metrics. It works even when tests are not run on the BrowserStack platform similar to other reporters and hence adding the docs of it as part of reporters.

Proposed changes

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

BrowserStack Test Observability is a standalone test reporter, a debugging tool, and also surfaces test suite health-related metrics. It works even when tests are not run on the BrowserStack platform similar to other reporters and hence adding the docs of it as part of reporters.
@christian-bromann
Copy link
Member

@sourav-kundu thanks for raising the PR. The service is already listed under the service section. Note that this is not a user facing documentation page and is more meant for contributor to understand the repo contents. I don't think listing the service twice clears up any confusion. Feel free to extend the description of the service entry in line 115 and mention that the service is also doing reporting work.

@sourav-kundu
Copy link
Contributor Author

sourav-kundu commented Apr 5, 2023

@christian-bromann Sure, I've modified the PR to accommodate the changes. We'll send a separate PR for public facing documentation for Test Observability.

Thanks

@christian-bromann christian-bromann added the PR: Docs 📝 PRs that contain changes to the documentation label Apr 5, 2023
Copy link
Member

@christian-bromann christian-bromann 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! 👍

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

Labels

PR: Docs 📝 PRs that contain changes to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants