[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17232066#comment-17232066 ] ASF subversion and git services commented on OFBIZ-10303: - Commit c21892609ba593193055bc2350e1e44b602d687b in ofbiz-framework's branch refs/heads/trunk from Olivier Heintz [ https://gitbox.apache.org/repos/asf?p=ofbiz-framework.git;h=c218926 ] Documented: Add a Global Glossary for user-documentation (OFBIZ-10303) > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Labels: Documentation > Attachments: > OFBIZ-10303_Documented-Add-a-Global-Glossary-for-user-documentat.patch, > humanres.adoc.patch, ofbiz-glossary.adoc, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17196265#comment-17196265 ] Jacques Le Roux commented on OFBIZ-10303: - bq. + at the end of line are same as thanks > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Attachments: > OFBIZ-10303_Documented-Add-a-Global-Glossary-for-user-documentat.patch, > humanres.adoc.patch, ofbiz-glossary.adoc, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17196165#comment-17196165 ] Olivier Heintz commented on OFBIZ-10303: Thanks you very much for the review, I have made some corrections, and some other later ;) I should finish the docbook to asciidoc before, and the previous patch update was only to be able to have an environment with all my pending modifications on documentation to publish them on ofbizextra documentation websitewebsite Some component are not yet link to corresponding chapter because when I have created this first release, asciidoc for these components not exist + at the end of line are same as > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Attachments: > OFBIZ-10303_Documented-Add-a-Global-Glossary-for-user-documentat.patch, > humanres.adoc.patch, ofbiz-glossary.adoc, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[
https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17195893#comment-17195893
]
Jacques Le Roux commented on OFBIZ-10303:
-
Hi Olivier,
I very like it (did not apply just reviewed).
I'd replace "ofbiz "by "OFBiz" in "and with ofbiz plugins you can find
application more business specifics" :)
Also
why "Key Users" has Capitals?
technicaly should be technically
Why some, like <<_accounting>> are surrounded by << >> but not some like
Product management?
Why do we have "+" at end of lines like?
{noformat}
+type entities, like BenefitType for HR. +
+
+[NOTE]
+For creation, as Primary keys must be entered manually apply the ID general
advice. +
{noformat}
> Add a Global Glossary for Documentation Guides
> --
>
> Key: OFBIZ-10303
> URL: https://issues.apache.org/jira/browse/OFBIZ-10303
> Project: OFBiz
> Issue Type: Task
>Reporter: Olivier Heintz
>Priority: Minor
> Attachments:
> OFBIZ-10303_Documented-Add-a-Global-Glossary-for-user-documentat.patch,
> humanres.adoc.patch, ofbiz-glossary.adoc, ofbiz-glossary.adoc,
> ofbiz-glossary.adoc, user-manual.adoc.patch
>
>
> Create a ofbiz-glossary.adoc in _include directory at the top level (near
> user-manual.adoc and developer-manual.adoc)
> This file will be used for all terms which are global to ofbiz (not link to a
> component).
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17195448#comment-17195448 ] Olivier Heintz commented on OFBIZ-10303: New patch is done with git format-patch (apply it with git am) [^OFBIZ-10303-Documented-Add-a-Global-Glossary-for-user-documentat.patch] Add the global-glossary and use it in two place. > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Attachments: > OFBIZ-10303-Documented-Add-a-Global-Glossary-for-user-documentat.patch, > humanres.adoc.patch, ofbiz-glossary.adoc, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16844008#comment-16844008 ] Olivier Heintz commented on OFBIZ-10303: Add some lines about DemoData > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Attachments: humanres.adoc.patch, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16686138#comment-16686138 ] Jacques Le Roux commented on OFBIZ-10303: - Thanks Olivier, I'm considering to work more on an AsciiDoc generated online documentation (see [this thread|[https://markmail.org/message/nujdq5rmegcg3p4z])] This seems quite useful for new commers and even in some cases for seasoned developers. > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Attachments: humanres.adoc.patch, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-10303) Add a Global Glossary for Documentation Guides
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16506328#comment-16506328 ] Olivier Heintz commented on OFBIZ-10303: [^ofbiz-glossary.adoc] Currently, I put in the global glossary all definition which are useful for more than one component. Each time I add a term, I check in [[https://cwiki.apache.org/confluence/display/OFBENDUSER/Glossary].] if it's define to be sure to "migrate" the wiki page in the same time. I put the list of terms already migrated in the [https://cwiki.apache.org/confluence/display/OFBIZ/Current+Documentation+migration+status] I propose to use this file for other glossary applications when documentation for this application is not started. > Add a Global Glossary for Documentation Guides > -- > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Task >Reporter: Olivier Heintz >Priority: Minor > Attachments: humanres.adoc.patch, ofbiz-glossary.adoc, > ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-10303) Add a global glossary
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16409262#comment-16409262 ] Sharan Foga commented on OFBIZ-10303: - OK I've taken a look and agree with you that we need to wait to see if this is needed. As this change will affect humanres.adoc too - I will move the patch the patch you created that refers to the global glossary here too. That way all the changes to implement will be in one Jira issue instead of being spread over multiple ones. > Add a global glossary > - > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Sub-task >Reporter: Olivier Heintz >Assignee: Sharan Foga >Priority: Minor > Attachments: humanres.adoc.patch, ofbiz-glossary.adoc, > user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-10303) Add a global glossary
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16409194#comment-16409194 ] Sharan Foga commented on OFBIZ-10303: - Thanks [~holivier], I'll take a look at this patch as a start. Just for information, myself and [~cparker] started putting together a global glossary [[https://cwiki.apache.org/confluence/display/OFBENDUSER/Glossary].|https://cwiki.apache.org/confluence/display/OFBENDUSER/Glossary] > Add a global glossary > - > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Sub-task >Reporter: Olivier Heintz >Priority: Minor > Attachments: ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
[jira] [Commented] (OFBIZ-10303) Add a global glossary
[ https://issues.apache.org/jira/browse/OFBIZ-10303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16408543#comment-16408543 ] Olivier Heintz commented on OFBIZ-10303: We will see if this file is needed during documentation creation process, if he will be completed by a lot of global terms. In a few weeks, If it contains only a very few terms it will be better to include these defintion in other files. I create it to be able, during documentation creation proces, to have a easy place to put a definition when it's not sur where to place it. > Add a global glossary > - > > Key: OFBIZ-10303 > URL: https://issues.apache.org/jira/browse/OFBIZ-10303 > Project: OFBiz > Issue Type: Sub-task >Reporter: Olivier Heintz >Priority: Minor > Attachments: ofbiz-glossary.adoc, user-manual.adoc.patch > > > Create a ofbiz-glossary.adoc in _include directory at the top level (near > user-manual.adoc and developer-manual.adoc) > This file will be used for all terms which are global to ofbiz (not link to a > component). > -- This message was sent by Atlassian JIRA (v7.6.3#76005)
