No "edit me on github" links in the rendered documentation. about documentation HOT 9 CLOSED

@daniel-thompson

This is something that @shovanuk has been working on. I will ping him to make sure we keep this on the list. I think it is urgent to have these "Edit on Github" links available at the bottom of all paged that are rendered up.

Thanks!

from documentation.

@daniel-thompson http://www.96boards.org/documentation/IoTEdition/Carbon/Building/LinuxBuild/BuildShell.md/ works for me. The links within the pages open for me, can you point me to the right place?

Thanks

from documentation.

Hi Shovan

This bug is not about broken links. It is about the pain I endured when I fixed them.

Basically IMHO every generated page should contain a link back to the github source material encouraging the reader to "Edit me on github" if they find any problems.

I'm well connected to 96Boards so I knew (more or less by osmosis) that if I went grubbing about on some random github project I would be able to fix the links and send a PR. However most people (even within Linaro) don't know this. We should help them by providing links from each and every page.

The ideal UI from my point of view would be to copy the visual style of github ribbons. For http://www.96boards.org/documentation/IoTEdition/Carbon/Building/LinuxBuild/BuildShell.md/
the ribbon should link to https://github.com/96boards/documentation/edit/master/IoTEdition/Carbon/Building/LinuxBuild/BuildShell.md .

from documentation.

@shovanuk

We have talked about this in the past. There needs to be an "Edit me on Github" link at the bottom of each GitHub rendered page on the website... I could add this to the doc/.md file it self but when it would seem misplaced for those who only use GitHub and do not use the site.

Does this make sense?

from documentation.

from documentation.

@kylekirkby @shovanuk

Any update on this?

from documentation.

We have a project for 96boards Static Site here - https://projects.linaro.org/browse/MAR-221. This is one of the issues that are on that list. I will make sure this gets done first out of all feature requests/ bug fixes.

Thanks

from documentation.

Thanks, @kylekirkby

Once it rolls out, we can close this issue.

from documentation.

This has been addressed. Most pages on 96Boards.org website now have "Edit me on GitHub" options with links to the appropriate GitHub page for editing.

Great work @shovanuk and @kylekirkby , thanks for doing this!

Closing issue.

from documentation.