Public comments - is there a way?

[D'Arcy Cain]

I am using Sphinx for my accounting system documentation.  As a programmer I tend to create lousy documentation and I need user input to make it better.

I suppose that I could put an email link on the page but it would be great if there was an automated way to allow online editing that sends the diffs to the programmers.  Is there any way to do that?

[Hor Meng Yoong]

Hi,

You may want to put the documentation in a private github accounts so that you term can update. 

On Tue, 29 Oct 2019, 20:57 D'Arcy Cain, <darc...@gmail.com> wrote:

I am using Sphinx for my accounting system documentation.  As a programmer I tend to create lousy documentation and I need user input to make it better.

I suppose that I could put an email link on the page but it would be great if there was an automated way to allow online editing that sends the diffs to the programmers.  Is there any way to do that?

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/39ae635c-9b6c-4ffa-bf8f-2927ccc31c27%40googlegroups.com.

[D'Arcy Cain]

I already use subversion for tracking changes but that's for the programmers.  I want to allow non technical people to send the programmers suggestions so that we can then do the check in.

I have put a mailto link on the page but it would be really great if there was some way that regular users could edit the page and have it send us the diffs.

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAEKCi_8FTTBcbg%3D2QRhdmzLwpMazJsntj496fm1oTqJyWjW-gA%40mail.gmail.com.

[Libor Jelinek]

For purposes you desribe, closest seems to embed in your html commenting services like Disqus.

Libor

Dne ne 10. 11. 2019 15:29 uživatel D'Arcy Cain <darc...@gmail.com> napsal:

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAAMTOdTQvaAAn5n2AUF9MTJCO2LnSHzLdUvF2QCa72uvGn2GiA%40mail.gmail.com.

[Jonas Camillus Jeppesen]

If users could change pages (and maybe the changes could be trakced, review, undone etc.) your page would be a wiki. Maybe a wiki is more suitable to your needs?

As for public comments (users could leave feedback, ask questions, etc.) you will have to use some other external dynamic comment system. Your static site (generated by sphinx) could include some html+javascript which submits a comment to some external webservice, that webservice could store the comment. The html+javascript in your static site could query the external website for comments and display them.

Do a web search for "static site comment system". You'll get suggetions on anything from Facebooks comment plugin to writing your own REST comment API. This seems to convey the spirit of things: https://darekkay.com/blog/static-site-comments/

/ Jonas

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAAMTOdTQvaAAn5n2AUF9MTJCO2LnSHzLdUvF2QCa72uvGn2GiA%40mail.gmail.com.