Docker.github.io: "Edit this page" links don't work on reference docs not on docker.github.io

[londoncalling]

Problem description

On reference docs pulled from repos other than https://github.com/docker/docker.github.io/, the Edit this page links don't work

Problem location, examples

e.g, see:
https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/
https://docs.docker.com/engine/reference/api/docker_remote_api/

Suggestions for a fix

API docs are in the docker/docker repo here: https://github.com/docker/docker/tree/master/docs/api

We need to find a way of making the Edit this page links on those pages link to the correct pages on the docker/docker repo. The code for this is in the file: https://github.com/docker/docker.github.io/blob/master/_layouts/docs.html

Related issues, links

@ahmetalpbalkan caught the problem and mentioned it on a tweet here: https://twitter.com/AhmetAlpBalkan/status/816769099841667072

Interested folks

@thaJeztah @ahmetalpbalkan @johndmulhausen @mstanleyjones

[thaJeztah]

Tricky bit here is that the docker/docker repository generally only accepts PR's on "master", but these docs are published from (e.g.) the 1.12.x branch; the "edit" link would then link to a version of the page that doesn't match what's published. Also, direct editing on GitHub will result in issues with the DCO check on the docker/docker repository

[londoncalling]

@thaJeztah , that's tricky ! ... I wonder if we could selectively not include the Edit this page link on those pages ... and ask them to send feedback instead? A good solution might be to grey out the option to "Edit this page" on pages that do not reside in docker.github.io and/or replace that option with a line that says the page is in a different repo so use the "Request docs changes" link instead. I'll see if there is a way to do this.

[mdlinville]

OOH what if we had them go to the /issues/ page for docker/docker so they could file an issue?

[thaJeztah]

Yes, I think an option to open an issue would be good, from there on, we can point them to the right location to open a pull request.

[johndmulhausen]

@johndmulhausen Look for this logic; add stuff to YAML file:

{% assign edit_url = "https://github.com/docker/docker.github.io/edit/master/" | append: page.path %} {% for entry in site.data.not_edited_here.overrides %} {% if page.url contains entry.path %} {% if entry.source %}{% assign edit_url = entry.source %}