[libvirt PATCH] docs: add 'edit this page' link to footer of every page

Ján Tomko jtomko at redhat.com
Wed Apr 8 16:08:59 UTC 2020


On a Wednesday in 2020, Daniel P. Berrangé wrote:
>To encourage contributors to make changes to the main website, add a
>footer link to every page which links to the corresponding source file
>in git. With gitlab, they are able to edit content directly in the web
>browser and then submit a merge request.

Should this patch wait until we switch to merge requests for libvirt?

(Also, for repositories where I can push directly, the text about
opening a merge request is not present and pressing 'submit changes'
pushes a commit to master right away - can notifications be set for
push events too? I don't seem to be getting any, despite setting
'watch' for the libvirt project)

>This gives a way to contribute
>content that is arguably easier than our wiki which requires manual
>account creation, while this will also benefit from maintainer review.
>
>Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
>---
> docs/Makefile.am | 5 +++++
> docs/page.xsl    | 7 +++++++
> docs/site.xsl    | 1 +
> docs/subsite.xsl | 1 +
> 4 files changed, 14 insertions(+)
>
>@@ -150,6 +151,12 @@
>           </div>
>         </div>
>         <div id="footer">
>+          <div id="contact">
>+            <h3>Contribute</h3>
>+            <ul>
>+              <li><a href="https://gitlab.com/libvirt/libvirt/-/blob/master/docs/{$pagesrc}">edit this page</a></li>

Consider s/blob/edit/ to go directly to the editing page, at the cost of
showing the gitlab login page instead of the source file to users who
aren't logged in.

Reviewed-by: Ján Tomko <jtomko at redhat.com>

Jano
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20200408/d10f5756/attachment-0001.sig>


More information about the libvir-list mailing list