[Docs] Anchor parameter is stripped out of redirected links part 1

[aswanson-nr]

Related Gatsby Issue

gatsbyjs/gatsby#27582

Release Date

We merged gatsbyjs/gatsby#32334 and released it in gatsby@next so you could try it out there. It'll then be released on July 20th in 3.10

Description

The redirects generated by the gatsby-plugin-meta-redirect plugin do not remove the trailing slash. This causes any #anchor parameters to be stripped out of the link and most likely applies to query parameters as well.

Steps to reproduce

1. Go to https://docs.newrelic.com/docs/insights/new-relic-insights/using-new-relic-query-language/nrql-reference#functions)[https://docs.newrelic.com/docs/insights/new-relic-insights/using-new-relic-query-language/nrql-reference#functions
2. Notice that the page redirects
3. Notice that the #functions was removed from the URL and the page did not scroll down to that section

Expected

When a user clicks on the link in the example above, they should land on the Functions section of the page.

Other information

• @jerelmiller submitted an issue to the plugin we use to generate these redirects to add an option to remove trailing slashes Feature request: Add option to remove trailing slash nsresulta/gatsby-plugin-meta-redirect#11

Acceptance Criteria

• Test using Gastby next release
• If tests pass, upgrade to Gatsby 3.10 when available.
• Upgrade Developer SIte
• Merge Developer develop branch in to feature/o11y-packs
• Upgrade OSS site
• Upgrade private docs
• Upgrade Theme

[austin-schaefer]

Thanks @aswanson-nr . There are a lot of redirects on the site and a lot of anchor links, so a fix here will be very helpful!

[jpvajda]

from @zstix I believe those redirects come from https://www.gatsbyjs.com/docs/reference/config-files/actions/#createRedirect in Gatsby. Not sure if we have the option to pass along the extra URL params

[rudouglas]

Notes:
Not sure if this is an issue anymore, i've having trouble reproducing it.

https://docs.newrelic.com/docs/insights/new-relic-insights/using-new-relic-query-language/nrql-reference#functions
Redirects to
https://docs.newrelic.com/docs/query-your-data/nrql-new-relic-query-language/get-started/nrql-syntax-clauses-functions/

Example Anchors that redirect correctly:

• https://docs.newrelic.com/docs/query-your-data/nrql-new-relic-query-language/get-started/nrql-syntax-clauses-functions/#state-select
• https://docs.newrelic.com/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language/#start-learning
• https://docs.newrelic.com/docs/telemetry-data-platform/ingest-manage-data/get-started/get-know-telemetry-data-platform/#capabilities
• https://docs.newrelic.com/docs/full-stack-observability/observe-everything/get-started/get-started-full-stack-observability/#start-anywhere
• https://docs.newrelic.com/docs/alerts-applied-intelligence/new-relic-alerts/get-started/introduction-alerts/#security

Tested on Chrome/Firefox/Safari and all seem to be anchoring correctly

[jpvajda]

We netted out that this is still a problem in Sprint Planning today

[moonlight-komorebi]

@jpvajda it looks like we can't implement this easily since gatsby doesn't have support for this currently (see here).

is it cool if i close this ticket out?

[jpvajda]

I'm going to bump Gatsby about it, and try to get an ETA of when this may be available in Gatsby.

[pieh]

Hey @jpvajda! We published today new release (gatsby@3.5.1), I'm currently veryfying it and will open PR with bump if all things look good.

Ops, sorry I was meant to respond to different issue - sorry for confussion

[rudouglas]

This may be a moot point now if the Gatsby update fixes this, but I figured out a workaround for this, i've got this working in develop build successfully, but for some reason it's not working in production, i'm confused about why these would work differently so it would be good to learn more about the redirection process.

Here's the branch with the changes I made: https://github.com/newrelic/docs-website/tree/ruairi/anchor-redirect

I used sessionStorage and a few of the Browser API's to achieve this.

screen-recording-2021-05-19-1502.webm.mp4

Maybe it has something to do with the fact that it throws a 404 first in develop

Notes:
The Issue linked by Alec seems to be separate to this but does seem to be an issue: nsresulta/gatsby-plugin-meta-redirect#11

[pieh]

I want to correct myself - I meant to write this to different (but still related to redirects) issue ( #1874 ). For forwarding query params and hash, we didn't implement that in Gatsby yet

[austin-schaefer]

Hey @roadlittledawn , let's look at this for a sustaining ticket in the next sprint or two.

[jpvajda]

We have a sustaining epic planned in January to kick off Q4, this is a good candidate for that epic, so added it.

[roadlittledawn]

looks like this was fixed in gatsby v3.13, so upgrading to this may fix this? https://www.gatsbyjs.com/docs/reference/release-notes/v3.13/#notable-bugfixes--improvements

gatsbyjs/gatsby#32850

[jpvajda]

We are planning an upgrade to gatsby 4 for the docs site in our sustaining sprint, that should take care of this I believe.

[rudouglas]

@roadlittledawn I did try that when it was initially released but it didn't seem to fix the issue

[jpvajda]

closing for a nice fresh issue out of the oven 🍪 as this has so much history, we'll work from a new issue to resolve this soon

[jpvajda]

#5163