Hi All,
Yes I totally agree. Actually we should have links to the generated
documentation in HTML format like we have a link for the API.
We should use the generateOfbizDocumentation and generatePluginDocumentation Gradle tasks in Buildbot to generate the documentation like we do for the
API (API is actually also a documentation).
Then we should have as less as possible links to get to the documentation from one site page. One for user, developer manuals and one for each plugins
documentation
We should use the wiki only for stuff which can't be in the generated
documentation, ie for stuff which are not releases specific.
While at it, we need to agree about some points:
With generatePluginDocumentation, plugins are apart, so are their
documentations consider standalone guides?
I suggest to have only 3 toc levels w/o numbers. Else the toc could be several pages (at least user doc.) before reaching the content. And numbers
don't add anything rather confuse, the simpler the better.
Maybe it's possible to have a general toc and tocs by component?
Opinions ?
@Mathieu, about your question
As a side note: Do you know why the OFBiz website is still referencing the
Confluence Wiki as the Developper/User manuals?
I think it's because Asciidoc content and process is still a WIP...
Jacques
Le 12/11/2018 à 08:28, Pierre Smits a écrit :
On Fri, 9 Nov 2018 at 22:01, Mathieu Lirzin <mathieu.lir...@nereide.fr>
wrote:
Shouldn't the documentation be available on the Web directly in HTML
form with the output of AsciiDoctor?
+ 1 Documentation must be available via our web pages. While developers
may benefit from having it local, we must help deciders and influencers
(accountants, business consultants, etc.) in an easy way to evaluate the
product.
It should not be that difficult to generate release specific documentation
as part of the release process and hook it into the website.
Best regards,
Pierre Smits
*Apache Trafodion <https://trafodion.apache.org>, Vice President*
*Apache Directory <https://directory.apache.org>, PMC Member*
Apache Incubator <https://incubator.apache.org>, committer
*Apache OFBiz <https://ofbiz.apache.org>, contributor (without privileges)
since 2008*
Apache Steve <https://steve.apache.org>, committer
On Mon, Nov 12, 2018 at 7:31 AM Paul Foxworthy <p...@cohsoft.com.au> wrote:
On Fri, 9 Nov 2018 at 22:01, Mathieu Lirzin <mathieu.lir...@nereide.fr>
wrote:
Shouldn't the documentation be available on the Web directly in HTML
form with the output of AsciiDoctor?
Thanks Mathieu. That was my thought too.
Cheers
Paul Foxworthy
--
Coherent Software Australia Pty Ltd
PO Box 2773
Cheltenham Vic 3192
Australia
Phone: +61 3 9585 6788
Web: http://www.coherentsoftware.com.au/
Email: i...@coherentsoftware.com.au
