docs icon indicating copy to clipboard operation
docs copied to clipboard

Fix anchor locations

Open halkeye opened this issue 3 years ago β€’ 6 comments

Proposed changes

Currently, if you go to https://docs.docker.com/compose/release-notes/#1290 the header (h*) is actually cutover by the header (top bar).

Ex: https://docs.docker.com/compose/release-notes/#1290

image

vs

image

Unreleased project version (optional)

N/A: Pure docs site change

Related issues (optional)

N/A

halkeye avatar Dec 30 '21 20:12 halkeye

βœ”οΈ Deploy Preview for docsdocker ready!

πŸ”¨ Explore the source changes: 03cee09aa4a945837a2ca5bd0d0bffae698889f3

πŸ” Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/61ce1a90cd0d5800076a7074

😎 Browse the preview: https://deploy-preview-14060--docsdocker.netlify.app

netlify[bot] avatar Dec 30 '21 20:12 netlify[bot]

https://deploy-preview-14060--docsdocker.netlify.app/compose/release-notes/#1290 looks the same to me as https://docs.docker.com/compose/release-notes/#1290 ?

timja avatar Dec 31 '21 08:12 timja

https://deploy-preview-14060--docsdocker.netlify.app/compose/release-notes/#1290 looks the same to me as https://docs.docker.com/compose/release-notes/#1290 ?

it does look like when coming in from external site, it does sorta work, but when you click on the chain icon next to header, it jumps to under the topbar.

halkeye avatar Dec 31 '21 17:12 halkeye

So my guess is that its https://github.com/docker/docker.github.io/blob/master/js/docs.js#L165

halkeye avatar Dec 31 '21 17:12 halkeye

Thanks for looking into this; yes, I recall the layout was a bit quirky in this area and collected a good amount of legacy code, css, and "oh,let's apply a quick hack here and there" over the years. I tried to clean up some of that, but it's been a good 7 years or so since I did any front-end work πŸ˜…, so there may be some remaining issues (ideally, we should do a good cleanup / overhaul / rewrite of the docs "theme").

I'll try to reserve some time soon to have a look at your changes, and to check if it doesn't affect some of the other "hacks" that are in place 😬

thaJeztah avatar Jan 06 '22 13:01 thaJeztah

We essentially had the same issue on jenkins.io which Is how I learned about it. I think with this you can probably safely get rid of most of the hacks, but I didn't want to mess with very much, CSS tends to be brittle on long running sites :)

halkeye avatar Jan 07 '22 03:01 halkeye

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions. As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a /remove-lifecycle stale comment. If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

docker-robott avatar Nov 26 '22 01:11 docker-robott

Deploy Preview for docsdocker ready!

Name Link
Latest commit 6facfd0090fa8a2cd81ca977877d5fe2f7e6c031
Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/638197e10d13ba00091dd6e4
Deploy Preview https://deploy-preview-14060--docsdocker.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Nov 26 '22 04:11 netlify[bot]

/remove-lifecycle stale

halkeye avatar Nov 26 '22 04:11 halkeye