-
Notifications
You must be signed in to change notification settings - Fork 36
DOP-6197: anchors outside composables #1568
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
Conversation
✅ Deploy Preview for docs-frontend-stg ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for csharp ready
|
✅ Deploy Preview for atlas ready
|
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.
I left two small nits, but other than that, LGTM.
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.
I left two small nits, but other than that, LGTM
Stories/Links:
DOP-6197
This PR fixes anchor tags sibling to composable tutorials.
Current Behavior:
Current behavior with anchor tags outside the composable tutorials: https://www.mongodb.com/docs/atlas/atlas-search/about/feature-compatibility/#supported-clients
^ The page initially loads with the proposed content, but gets pushed down by Composable Content.
Previous PR had fixed anchor tags within composable tutorials. fix still applies: http://mongodb.com/docs/atlas/atlas-search/tutorial/#create-the--index.-18
Staging Links:
Both anchor links working whether its inside/outside composables
Anchor tags within composable:
https://deploy-preview-1568--docs-frontend-stg.netlify.app/docs/atlas/atlas-search/tutorial/#create-the--index.-18
Anchor tags outside composable
https://deploy-preview-1568--docs-frontend-stg.netlify.app/docs/atlas/atlas-search/about/feature-compatibility/#supported-clients
Regression checks:
No selections: https://deploy-preview-1568--docs-frontend-stg.netlify.app/docs/atlas/atlas-search/tutorial
Bad selections: https://deploy-preview-1568--docs-frontend-stg.netlify.app/docs/atlas/atlas-search/tutorial?deployment-type=jargon
Extra query params https://deploy-preview-1568--docs-frontend-stg.netlify.app/docs/atlas/atlas-search/tutorial?extra-query=extra-value
Not found hash https://deploy-preview-1568--docs-frontend-stg.netlify.app/docs/atlas/atlas-search/tutorial#extra-hash-404
Notes:
- correct any wrong selections,
persist any URL parts (hash, query parms)
outside scope of composable
- if needed update, go to new URL with corrected/
updated query params
- useHashAnchor kicks in after URL update
- set composable state to show the correct content
based on URL
- correct any wrong selections,
persist any URL parts (hash, query parms)
outside scope of composable
- set composable state to show correct content
- go to new URL with params reflecting composable
state
- useHashAnchor kicks in after URL update
- composable tutorials state reads from query params
- update the url query params
README updates