How about just linking to a GitHub edit? For example, let's say I'm on the
queues page:
http://www.rsyslog.com/doc/queues.html

The "edit" button could just be a link to this (ideally, the same version
as the one you're looking at):
https://github.com/rsyslog/rsyslog-doc/edit/master/source/queues.rst

AFAIK, GitHub will fork the repo for you and you should be able to add
small changes (typo, one paragraph...) in under a minute. Hopefully, if
many users contribute with a small thing, it will make a big change in the
end.

Best regards,
Radu

On Wed, Apr 9, 2014 at 12:42 PM, Rainer Gerhards
<[email protected]>wrote:

> I found the "rst_epilog" sphinx config directive[1], which sounds like the
> right tool to add this kind of link. However, I do not know how to refer to
> the source file, so I am still stuck.
>
> Rainer
>
> [1] http://sphinx-doc.org/config.html ; search for "rst_epilog"
>
>
> On Tue, Apr 1, 2014 at 10:22 PM, Rainer Gerhards
> <[email protected]>wrote:
>
> > Excellent idea. I think it should be done via the sphinx theme, so no
> need
> > to modify the site software.  Maybe James knows what to do? Someone else?
> >
> > Rainer
> >
> > Sent from phone, thus brief.
> > Am 01.04.2014 21:57 schrieb "David Lang" <[email protected]>:
> >
> > sounds great, find out what it takes to set it up.
> >>
> >> David Lang
> >>
> >> On Tue, 1 Apr 2014, Radu Gheorghe wrote:
> >>
> >>  Date: Tue, 1 Apr 2014 20:37:51 +0300
> >>> From: Radu Gheorghe <[email protected]>
> >>> Reply-To: rsyslog-users <[email protected]>
> >>> To: rsyslog-users <[email protected]>
> >>> Subject: [rsyslog] Edit on GitHub button for doc pages?
> >>>
> >>> Hi,
> >>>
> >>> Recently, the Elasticsearch people added an "Edit" button on the
> >>> documentation pages which allows you to jump directly to a page on
> GitHub
> >>> that has the docs cloned, ready for you to make a change and submit a
> >>> pull
> >>> request.
> >>>
> >>> I think this is a brilliant idea and something that will help the
> rsyslog
> >>> project a lot. Like, if someone spots a confusing typo or some missing
> >>> information, that person could fix it on the spot.
> >>>
> >>> Do you think this is something that can be added to rsyslog.com? I'm
> not
> >>> sure how it can be done technically, but I can look it up. Or ask the
> >>> Elasticsearch people how they did it :)
> >>>
> >>> Best regards,
> >>> Radu
> >>>
> >>>  _______________________________________________
> >> rsyslog mailing list
> >> http://lists.adiscon.net/mailman/listinfo/rsyslog
> >> http://www.rsyslog.com/professional-services/
> >> What's up with rsyslog? Follow https://twitter.com/rgerhards
> >> NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad
> >> of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you
> >> DON'T LIKE THAT.
> >>
> >
> _______________________________________________
> rsyslog mailing list
> http://lists.adiscon.net/mailman/listinfo/rsyslog
> http://www.rsyslog.com/professional-services/
> What's up with rsyslog? Follow https://twitter.com/rgerhards
> NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad
> of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you
> DON'T LIKE THAT.
>



-- 
Performance Monitoring * Log Analytics * Search Analytics
Solr & Elasticsearch Support * http://sematext.com/
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of 
sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE 
THAT.

Reply via email to