-
Notifications
You must be signed in to change notification settings - Fork 215
docs: add the glossary terms in the 3 version #604
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Pratik Mahalle <[email protected]>
To generate Unit Tests for this PR, please click here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new glossary section in version 3.0.0 by adding definitions for several key testing concepts and updates the static mapping to include these entries.
- Added new glossary markdown files for various testing methodologies.
- Updated
glossaryEntries.js
to register the new terms in the documentation sidebar.
Reviewed Changes
Copilot reviewed 12 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
versioned_docs/version-3.0.0/concepts/reference/glossary/visual-regression-testing.md | Adds glossary entry for Visual Regression Testing |
versioned_docs/version-3.0.0/concepts/reference/glossary/reliability-testing.md | Adds glossary entry for Reliability Testing |
versioned_docs/version-3.0.0/concepts/reference/glossary/qa-automation.md | Adds glossary entry for QA Automation |
versioned_docs/version-3.0.0/concepts/reference/glossary/observibility-testing.md | Adds glossary entry for Observability Testing |
versioned_docs/version-3.0.0/concepts/reference/glossary/negative-testing.md | Adds glossary entry for Negative Testing |
versioned_docs/version-3.0.0/concepts/reference/glossary/load-testing.md | Adds glossary entry for Load Testing |
versioned_docs/version-3.0.0/concepts/reference/glossary/junit.md | Adds glossary entry for JUnit |
versioned_docs/version-3.0.0/concepts/reference/glossary/grpc.md | Adds glossary entry for gRPC |
versioned_docs/version-3.0.0/concepts/reference/glossary/defect-management.md | Adds glossary entry for Defect Management |
versioned_docs/version-3.0.0/concepts/reference/glossary/data-driven-testing.md | Adds glossary entry for Data-Driven Testing |
versioned_docs/version-3.0.0/concepts/reference/glossary/component-testing.md | Adds glossary entry for Component Testing |
static/data/glossaryEntries.js | Registers all new glossary entries in the sidebar |
@@ -0,0 +1,139 @@ | |||
--- | |||
id: observability-testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The filename 'observibility-testing.md' does not match the 'observability-testing' id and links; rename the file to 'observability-testing.md' to avoid broken documentation links.
Copilot uses AI. Check for mistakes.
|
||
## Types of Software Component Testing | ||
|
||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error in image alt text: 'Typinge' should be 'Types'.
 | |
 |
Copilot uses AI. Check for mistakes.
|
||
JUnit provides `assertThrows()` method for testing exception scenarios. This approach is cleaner than try-catch blocks and provides better error messages. Test both the exception type and message when relevant to ensure comprehensive coverage. | ||
|
||
### Q: What's the best way to handle test data setup?\*\* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extraneous '**' at the end of the question; remove the extra asterisks for consistent formatting.
Copilot uses AI. Check for mistakes.
Summary
This pull request updates the documentation and adds a new glossary section/terms to improve clarity and accessibility for users.
Changes