-
Notifications
You must be signed in to change notification settings - Fork 34
Added two new FAQs #895
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
Added two new FAQs #895
Conversation
📝 WalkthroughWalkthroughTwo new FAQ documentation pages are added to the Testsigma docs. One explains how to retrieve OTPs embedded within HTML tags using addons and NLP actions; the other provides a configuration guide for the OracleDB Add-on including JDBC URL setup and query examples. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md:
- Line 62: The example JDBC URL currently includes the password wrapped in angle
brackets; update the JDBC string
**jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
to remove the brackets so the password is shown as **password=123456789012**
(i.e., replace `password=<123456789012>` with `password=123456789012`) so
placeholders remain bracketed elsewhere but actual example values are not.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.mdsrc/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md
[grammar] ~23-~23: Ensure spelling is correct
Context: ...s. To use the OTP in test execution, an addon is used to remove these extra character...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~35-~35: Ensure spelling is correct
Context: ...type/). --- ## Steps to Install the Addon 1. From the left navigation bar, go to **Ad...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
[grammar] ~24-~24: Ensure spelling is correct
Context: ...ction. --- ## Steps to Install the Addon 1. From the left navigation bar, go to **Ad...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: CI
🔇 Additional comments (2)
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md (1)
1-72: Overall documentation quality is strong.The FAQ is well-structured with clear installation and configuration steps. The YAML front-matter is correct, images are appropriately referenced, and the guide provides helpful context (e.g., Service Name vs. SID notes). Consider verifying that the referenced S3 image URLs are publicly accessible and stable.
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md (1)
1-64: Well-organized documentation with clear workflows.The FAQ effectively guides users through extracting OTPs from HTML-embedded emails using addons and NLP actions. The structure follows a logical progression: prerequisites → addon installation → configuration steps. Steps are detailed and include helpful visual references via images. The regex pattern example (
>\d{6}<) and character removal example (><) are concrete and helpful.Verify that:
- The linked documentation on MailboxFunctions is current and publicly accessible.
- All referenced S3 image URLs are stable and publicly available.
|
|
||
| Example URL using the screenshot details: | ||
|
|
||
| **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA** |
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.
Remove angle brackets from password in example JDBC URL.
The example JDBC URL shows the password as <123456789012>, but angle brackets should only wrap placeholders, not actual values. Passwords should be provided without angle brackets.
🔧 Proposed fix
- **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
+ **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=123456789012&internal_logon=SYSDBA**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA** | |
| **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=123456789012&internal_logon=SYSDBA** |
🤖 Prompt for AI Agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
at line 62, The example JDBC URL currently includes the password wrapped in
angle brackets; update the JDBC string
**jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
to remove the brackets so the password is shown as **password=123456789012**
(i.e., replace `password=<123456789012>` with `password=123456789012`) so
placeholders remain bracketed elsewhere but actual example values are not.
Added two new FAQs as per the tickets:
https://testsigma.atlassian.net/browse/DOC-487
https://testsigma.atlassian.net/browse/DOC-497
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.