Skip to content

Resolves [docs]: Add More Glossary Terms to Testing Glossary Page #551

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

BillyDoesDev
Copy link

@BillyDoesDev BillyDoesDev commented Jun 18, 2025

What has changed?

Fix broken link to Stubs in Glossary. Added "observability-testing" as a new Glossary item.

This PR Resolves #2770

Type of change

  • Bug fix (non-breaking change which fixes an issue).
  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

The build has been tested using the docker-compose file provided.
The dockerfile starts the app via:

yarn install
yarn build
yarn start

Running the docker container with host 0.0.0.0 (so we expose the host machine as well), we get:
image

Output gif:

anim

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

Copy link

@github-actions github-actions bot 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 and congratulations 🎉 for opening your very first pull request in keploy

@BillyDoesDev
Copy link
Author

@nehagup Could you please review this PR when you have time? 🙏
Thank you so much!

@amaan-bhati
Copy link
Member

hey @BillyDoesDev Thanks for raising this pr with observability testing and fixing the chore typo, can you please add a bit more of content in the observability page, you can try adding a few more images o diagrams to explain it. You can also write a bit more of content to explain the concept.

@BillyDoesDev
Copy link
Author

Thank you so much for the feedback, @amaan-bhati!
I'll make the necessary changes and get back to you soon.

added an example for testing observability in a python app

Signed-off-by: BillyDoesDev <[email protected]>
@BillyDoesDev
Copy link
Author

Hey, @amaan-bhati! I have made the observability page more verbose by explaining more on what it is and how it helps, and also including a simple python example to test it out.

The rest of the content remains the same, highlighting how Keploy could help prevent potential issues in the first place, before even diving into observability logs and traces.

Here's a quick preview:
anim-new

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