[Mayan EDMS: 1397] USER MANUAL

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Mayan EDMS: 1397] USER MANUAL

Gabriel Diteko
Hi.

Is there a user manual somewhere? Even if its just a basic one.

--

---
You received this message because you are subscribed to the Google Groups "Mayan EDMS" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Mayan EDMS: 1505] Re: USER MANUAL

rosarior
Administrator
Hi,

A subproject was started to create an AsciiDoc manual (https://gitlab.com/mayan-edms/manual) it is still in the early stages and we need everybody's help moving it forwards.
AsciiDoc (http://asciidoctor.org) is a very easy markup language and much easier than the currently used RestructuredText., hence the decision to use it. Contributing is simple: Just clone the repository, make changes and submit them. The changes can be made from the GitLab web UI too.

On Thursday, June 30, 2016 at 3:26:35 AM UTC-4, Gabriel Diteko wrote:
Hi.

Is there a user manual somewhere? Even if its just a basic one.

--

---
You received this message because you are subscribed to the Google Groups "Mayan EDMS" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Mayan EDMS: 1507] Re: USER MANUAL

roger.hunwicks
Roberto

I think a user-centric manual using a simpler markup language than RestructuredText is a great idea. I also like Asciidoc. But have you considered Markdown as an alternative? Sphinx supports Markdown (see http://blog.readthedocs.com/adding-markdown-support/) so in theory you could use Sphinx as the tool and Markdown as the markup language and then fall back to embedded RST when you want to express something that isn't easily available in Markdown like diagrams.

That way you could keep a single tool that builds both the developer documentation and the user documentation, while still having markup that non-technical users would be happy to edit on Github.

Regards

Roger

--

---
You received this message because you are subscribed to the Google Groups "Mayan EDMS" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Loading...