[Proposal] "Edit this page on GitHub" link

[kubawolanin]

The goal of this proposal is to encourage more people to contribute to the documentation pages.

So let's say that user visits this page.
Adding the following example code at the beginning of .content class:

<a href="{{TODO}}" style="float: right">Edit this page on GitHub</a>

Would result in effect like this:

The URL would then redirect (or open a new tab if target="_blank" was used) to a GitHub article. In the example above it would be this page.

Resources:

• How do I create "Edit this page" links in Jekyll? jekyll/jekyll-help#5

[ThomDietrich]

Hey Kuba!
That's a good idea! I was also thinking about adding such a link. I wanted to go with a Materialize floating action button for it.

The big problem is that the majority of content in docs is not actually hosted in the docs repo and the URL to the original file would need to be known. To that end I started to add the source front matter to files, see here for an example. However (it would be possible) not all files can be provided with that field easily. That's why I've just recently discussed the idea of additional metadata for addons with @kaikreuzer. We wanted to discuss this in more detail at the Smart Home Day. You should join! 😉 (Let me know if you are interested in more details)

Best! Thomas

[kubawolanin]

Let me know if you are interested in more details

Sure I am :)
And I really like the idea of incorporating floating button there.

Cheers,
Kuba

[bgilmer77]

Would the source front matter be applicable to other areas of the docs? As you know, we have other places where an article may appear in openhab-docs, but it is actually an ESH article. (Or is this a different concept?)

[ThomDietrich]

The exact same topic yes. I've started another discussion that hopefully will soon help with the this feature

[Confectrician]

I've started another discussion that hopefully will soon help with the this feature

Could you link it here, if its a public visible discussion?
Would be nice to have an impression of the whole topic.

[ThomDietrich]

Sure, here you go: eclipse-archived/smarthome#4503 (also @kubawolanin)

[kaikreuzer]

@ghys has added such links on the new website, so I guess this can be closed.