Thanks Taher it's clear now :)

Regards

Gil


Le samedi 08 sept. 2018 à 19:46:17 (+0300), Taher Alkhateeb a écrit :
> The asciidoc design is really simple: you have two main documents in
> the system found under docs/asciidoc. One is the user manual and the
> other one is the developer manual.
> 
> Each one of these documents is in turn, pointing to other documents
> that by default are placed in /src/docs/asciidoc in each component and
> holds the same component name. So if you want to add this
> documentation, you will:
> - Add an "include" section in the main documentation document
> - Create your document in src/docs/asciidoc
> - Provide the contents
> - Test using ./gradlew generateOfbizDocumentation
> On Fri, Sep 7, 2018 at 5:20 PM Gil Portenseigne
> <[email protected]> wrote:
> >
> > Hello,
> >
> > I just published a new version of impersonation feature (OFBIZ-10515),
> > and i wrote down some asciidoc documentation.
> >
> > I got some questions to documentation team to get the best practice
> > around it.
> >
> > I write down a documentation within:
> > framework/security/src/doc/asciidoc/_include/security-impersonation.adoc
> > but i'm not sure about the location, since the gradle doc tasks do not
> > take it into account. I guess i'm wrong. If you can point me where is
> > the best place for this kind of documentation.
> >
> > On another hand, i wanted to reference an icon within common-theme, i
> > set the property :
> > :imagesdir: ../../../../../../themes/common-theme/webapp/images/img/
> >
> > Which is in my opinion a bad choice. I guess it's better to duplicate
> > the image within the documentation tree.
> >
> > Thanks and regards,
> >
> > Gil

Reply via email to