golang/go

x/pkgsite: change browser URL to canonical path

Open

#40,936 opened on Aug 20, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
NeedsInvestigationhelp wantedpkgsite

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

If the URL passed to the frontend is path@version.

it resolves this internally to module@version/suffix.

and all the links it puts on the page have this form. However, the browser URL still says "path@version".

We could use window.history.replaceState to change the browser URL without a page reload. According to https://computerrock.com/blog/html5-changing-the-browser-url-without-refreshing-page, it is available in modern browsers.

/cc @jba @jamalc

Contributor guide

Research direction
Locate the frontend JavaScript code in the pkgsite directory that handles the browser URL. Implement a call to window.history.replaceState to change the URL displayed in the address bar to the canonical form (module@version/suffix) without reloading the page.
Tech stack
gojavascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85