Skip to content
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.

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

docs: events discription, usage, examples #943

Merged
merged 2 commits into from
Aug 6, 2024

Conversation

miripiruni
Copy link
Member

Whats here:

  • Events overview in docs/events/index.md
  • Documentation about each event in docs/events/
  • About events interception in docs/events-interception.md

Whats next: visualization (diagram) for better understanding.

@miripiruni miripiruni marked this pull request as ready for review July 26, 2024 13:17
Copy link
Member

@shadowusr shadowusr left a comment

Choose a reason for hiding this comment

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

Very cool PR, a huge leap towards well-documented Testplane API. Left a few comments, feel free to react as you wish

docs/events-interception.md Show resolved Hide resolved
docs/events/index.md Outdated Show resolved Hide resolved
docs/events/index.md Outdated Show resolved Hide resolved
@@ -0,0 +1,190 @@
# About events interception {#events-interception}
Copy link
Member

Choose a reason for hiding this comment

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

We have one more page about testplane events here: https://github.com/gemini-testing/testplane/blob/2ced168569b3262137a094bed331b763805a1268/docs/events.md

I think these should either be merged or original events.md should include links to the new articles

docs/events-interception.md Outdated Show resolved Hide resolved
docs/events/suite-end.md Outdated Show resolved Hide resolved
docs/events/test-end.md Outdated Show resolved Hide resolved
docs/events/test-pass.md Outdated Show resolved Hide resolved
docs/events/usage-examples/collecting-stats.md Outdated Show resolved Hide resolved
docs/events/usage-examples/running-tests-with-helpers.md Outdated Show resolved Hide resolved
Copy link
Member Author

@miripiruni miripiruni 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 for review! Fixed.

@miripiruni miripiruni merged commit e1a68b5 into gemini-testing:master Aug 6, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants