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

[Daniel P. Berrangé]

On Wed, Apr 08, 2020 at 07:05:17PM +0200, Andrea Bolognani wrote:
> On Wed, 2020-04-08 at 16:21 +0100, Daniel P. Berrangé wrote:
> > +++ 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"; \
> 
> The indentation is all wrong here.

Opps yes. I will love it when we remove make :-)

> 
> > @@ -438,6 +442,7 @@ manpages/%.html.in: manpages/%.rst
> >  	    style=subsite.xsl; \
> >  	  fi; \
> >  	  $(XSLTPROC) --stringparam pagename $$name \
> > +            --stringparam pagesrc $$src \
> 
> Here too.
> 
> > +++ b/docs/page.xsl
> > @@ -150,6 +151,12 @@
> >            </div>
> >          </div>
> >          <div id="footer">
> > +          <div id="contact">
> 
> The id is wrong, you need a new one for this footer section.

Yes

> 
> > +            <h3>Contribute</h3>
> > +            <ul>
> > +              <li><a href="https://gitlab.com/libvirt/libvirt/-/blob/master/docs/{$pagesrc}">edit this page</a></li>
> > +            </ul>
> > +          </div>
> 
> I think the "edit this page" link would actually be more prominent
> if it were the third one (last one on the left) in the footer rather
> than the first one. Please give it a try.

Sure, that works.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|