Fix session variable search discoverability in documentation #20762
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enhance session variable descriptions with variable names to improve search discoverability. Session variables like default_transaction_use_follower_reads were not findable via search because variable names appeared only in filtered table cells while descriptions lacked the variable names. The fix prepends session variable names to their descriptions for session-variables.html, making them discoverable without creating additional index records. Fixes issue where customers couldn't find documented session variables through main docs search functionality.
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Session variables like
default_transaction_use_follower_readswere not discoverable throughdocs search, despite being documented. Customers searching for these variables got "No
results" even though the documentation existed.
Root Cause
Solution
Enhanced the indexing logic to prepend session variable names to their descriptions for the
session-variables.html page. This makes variables discoverable without creating additional
index records.
Before: Search for
default_transaction_use_follower_reads→ 0 resultsAfter: Search finds session-variables.html with "default_transaction_use_follower_reads:
If set to on, all read-only transactions use..."
Changes
enhance_session_variable_content()function to detect and enhance session variabledescriptions
Impact
Testing