Post by Sharoon ThomasPost by Dale ScottSent: Tuesday, July 22, 2014 3:00:02 AM
Subject: Re: [tryton] How does Dashboard Module work?
Post by Cédric KrierSo timeto submit a patch for the documentation.
+1 It will help all of us if you can find the time to summarize
what you've learned. I'm still working basic material workflows,
but will want to explore dashboards soon and I doubt I'm alone...
I forgot to ask where specifically should this type of documentation
exist, and how *exactly* does one submit a documentation patch, and
would documentation like this be best put on http://doc.tryton.org,
https://code.google.com/p/tryton/wiki,
http://tryton-documentation.readthedocs.org, or somewhere else
entirely (e.g. personal blogs)?
I'm especially interested in understanding where *should* end-user
module documentation be maintained, and the dashboard module is an
example (although it seems to involve both a site administrator to
configure modules so they are available for use in dashboards, and the
end-user who configures their own dashboard). After figuring out how
to *use* Tryton for my own purposes, I'd like to contribute HowTos or
Tutorials, but need direction for how to best benefit the community.
Happy to have this in http://tryton-documentation.readthedocs.org
The first section is the user guide where we explain basic concepts of
Tryton. Perhaps, modules could also be documented there.
You can send a pull request
on https://github.com/tryton/tryton-documentation and we will help you
put it together.
That being said, the ideal place to have such documentation is the
module itself, which would then appear on doc.tryton.org
<http://doc.tryton.org>
Hi,
The sources of http://doc.tryton.org are the "doc" directories of
trytond, trytond and modules repositories hosted at
http://hg.tryton.org. This is the most official documentation. In order
to improve this one, the workflow (a review is included) explained here
[1] must be followed. In my opinion this one is developer oriented.
The content of https://code.google.com/p/tryton/wiki should be removed
and integrated to the official documentation. The modifications of the
wiki aren't reviewed: informations are useful but authors didn't take
the time to follow the workflow of doc.tryton.org. [2 (french)]
As Sharoon stated, source of http://tryton-documentation.readthedocs.org
is https://github.com/tryton/tryton-documentation. In order to improve
this one, follow the github workflow and create a pull request.
This doc is splitted in 4 parts:
- http://tryton-administration-manual.readthedocs.org/ is end-user oriented
- http://tryton-documentation.readthedocs.org/ is developer oriented.
- a demo module
- tryton client doc (same as http://doc.tryton.org/3.2/tryton/doc/)
I don't know why tryton-documentation isn't merged with doc.tryton.org,
it seems this was discussed at the TUB2013 [3].
A brief description of the module (like [4]) could be added to
doc.tryton.org and an end-user documentation could be added to
tryton-administration-manual.
[1] https://code.google.com/p/tryton/wiki/HowtoContribute
[2] http://www.tryton.org/~irclog/fr/2013-01-23.log.html
[3] http://comments.gmane.org/gmane.comp.python.tryton/5594
[4] http://doc.tryton.org/3.2/modules/bank/doc/index.html
Pierre-Louis
