docs: add 'edit this page' link to footer of every page

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. 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.

Reviewed-by: Ján Tomko <jtomko@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 61862c4ab783217f5b9bf6367d38660e5020c441..404121a2a2b71ac9b73d7eacdcfc29d8802adc6f 100644 (file)
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -429,6 +429,10 @@ manpages/%.html.in: manpages/%.rst
 %.html.tmp: %.html.in site.xsl subsite.xsl page.xsl \
                $(acl_generated)
        $(AM_V_GEN)name=`echo $@ | sed -e 's/.tmp//'`; \
+         genhtmlin=`echo $@ | sed -e 's/.tmp/.in/'`; \
+         rst=`echo $@ | sed -e 's/.html.tmp/.rst/'`; \
+         src="$$genhtmlin"; \
+         test -f "$$genhtmlin" && src="$$rst"; \
          dir=`dirname $@` ; \
          if test "$$dir" = "."; \
          then \
@@ -438,6 +442,7 @@ manpages/%.html.in: manpages/%.rst
            style=subsite.xsl; \
          fi; \
          $(XSLTPROC) --stringparam pagename $$name \
+           --stringparam pagesrc $$src \
            --stringparam builddir '$(abs_top_builddir)' \
            --stringparam timestamp $(timestamp) --nonet \
            $(top_srcdir)/docs/$$style $< > $@ \

diff --git a/docs/libvirt.css b/docs/libvirt.css
index 18e55dac5981c0bb6366729e7ef0a6cc2d4a6dd5..a6f343908d5255e8699ceab2beea902d61131c99 100644 (file)
--- a/docs/libvirt.css
+++ b/docs/libvirt.css
@@ -453,7 +453,7 @@ br.clear {
     text-decoration: underline;
 }
 
-#contact, #community {
+#contact, #community, #contribute {
     float: left;
     padding: 0px;
     margin-left: 3em;

diff --git a/docs/page.xsl b/docs/page.xsl
index ddae5ab50809c4755389eb88368c6214e792146e..69238714004d652f27150df7d78e12a4e6103673 100644 (file)
--- a/docs/page.xsl
+++ b/docs/page.xsl
@@ -77,6 +77,7 @@
   <!-- This is the master page structure -->
   <xsl:template match="/" mode="page">
     <xsl:param name="pagename"/>
+    <xsl:param name="pagesrc"/>
     <xsl:param name="timestamp"/>
     <xsl:text disable-output-escaping="yes">&lt;!DOCTYPE html&gt;
 </xsl:text>
@@ -165,6 +166,12 @@
               <li><a href="http://serverfault.com/questions/tagged/libvirt">serverfault</a></li>
             </ul>
           </div>
+          <div id="contribute">
+            <h3>Contribute</h3>
+            <ul>
+              <li><a href="https://gitlab.com/libvirt/libvirt/-/blob/master/docs/{$pagesrc}">edit this page</a></li>
+            </ul>
+          </div>
           <div id="conduct">
             Participants in the libvirt project agree to abide by <a href="{$href_base}governance.html#codeofconduct">the project code of conduct</a>
           </div>

diff --git a/docs/site.xsl b/docs/site.xsl
index c9d41f2c93af67b4e45e78d32673aef6e8389672..73ddd8ca6b33ffda4284cdece85abec15213d735 100644 (file)
--- a/docs/site.xsl
+++ b/docs/site.xsl
@@ -27,6 +27,7 @@
   <xsl:template match="/">
     <xsl:apply-templates select="." mode="page">
       <xsl:with-param name="pagename" select="$pagename"/>
+      <xsl:with-param name="pagesrc" select="$pagesrc"/>
       <xsl:with-param name="timestamp" select="$timestamp"/>
     </xsl:apply-templates>
   </xsl:template>

diff --git a/docs/subsite.xsl b/docs/subsite.xsl
index f56ac0491c02aa6246b07cd1708ced1f96a1f810..bfd34eebd2748faf073a4ef7c975d5dcbdffbd26 100644 (file)
--- a/docs/subsite.xsl
+++ b/docs/subsite.xsl
@@ -17,6 +17,7 @@
   <xsl:template match="/">
     <xsl:apply-templates select="." mode="page">
       <xsl:with-param name="pagename" select="$pagename"/>
+      <xsl:with-param name="pagesrc" select="$pagesrc"/>
       <xsl:with-param name="timestamp" select="$timestamp"/>
     </xsl:apply-templates>
   </xsl:template>