Documentation by Release / Version
Locked
Documentation by Release / Version
 
|
Hi all,
I am planning to add some new documentation in Confluence but will have them placed/linked under the affected OFBiz release / version. For a user navigating the documentation, the user can click on a particular OFBiz release on the menu tree to display the list of topic for that OFBiz version. What do you think of this approach? Are there better ways to structure the menu items? Cheers, James Yong |
Re: Documentation by Release / Version
Administrator
|
Hi James,
I'm all for it. Note that I already used another strategy by referring to the history of few major pages[1] while documenting the Gradle from Ant. It though was a more an expedient than a structured way as you are proposing. But it could still be used when referring to old pages... [1] These pages contain the sentence "the pre-Gradle documentation is here", eg https://cwiki.apache.org/confluence/display/OFBIZ/Demo+and+Test+Setup+Guide Jacques Le 08/03/2017 à 18:05, james yong a écrit : > Hi all, > > I am planning to add some new documentation in Confluence but will have them > placed/linked under the affected OFBiz release / version. For a user > navigating the documentation, the user can click on a particular OFBiz > release on the menu tree to display the list of topic for that OFBiz > version. > > What do you think of this approach? Are there better ways to structure the > menu items? > > Cheers, > James Yong > > > > -- > View this message in context: http://ofbiz.135035.n4.nabble.com/Documentation-by-Release-Version-tp4703069.html > Sent from the OFBiz - Dev mailing list archive at Nabble.com. > |
Re: Documentation by Release / Version
|
|
Hi Jacques,
I like your approach too. I propose creating a Tour page in Confluence. This tour page will have a direct child page for the recent OFBiz releases, like the following menu structure: Tour -> Release 13.7 -> Release 16.11 Each of the Release xx.x page is a Table of Content that links to other existing pages. The tour is meant for beginner and they are expected to go through the topics from top to bottom. With this approach, there will not be direct child page under each Release xx.x page. Existing documentation isn’t affected. Regards, James
|
Re: Documentation by Release / Version
|
|
Hi all,
Will create the placeholder for the following pages in Confluence soon if there is no objection. Tour -> Release 13.7 -> Release 16.11 This is also very much a work-in-progress, and group work will be better. Thanks. Regards, James
|
Re: Documentation by Release / Version
|
Administrator
|
In reply to this post by james yong
+1
Jacques Le 10/03/2017 à 02:45, james yong a écrit : > Hi Jacques, > > I like your approach too. I propose creating a Tour page in Confluence. > This tour page will have a direct child page for the recent OFBiz releases, > like the following menu structure: > > Tour > -> Release 13.7 > -> Release 16.11 > > Each of the Release xx.x page is a Table of Content that links to other > existing pages. > The tour is meant for beginner and they are expected to go through the > topics from top to bottom. > > With this approach, there will not be direct child page under each Release > xx.x page. Existing documentation isn’t affected. > > Regards, > James > > > > Jacques Le Roux wrote >> Hi James, >> >> I'm all for it. >> >> Note that I already used another strategy by referring to the history of >> few major pages[1] while documenting the Gradle from Ant. It though was a >> more an expedient than a structured way as you are proposing. But it could >> still be used when referring to old pages... >> >> [1] These pages contain the sentence "the pre-Gradle documentation is >> here", eg >> https://cwiki.apache.org/confluence/display/OFBIZ/Demo+and+Test+Setup+Guide >> >> Jacques >> >> >> Le 08/03/2017 à 18:05, james yong a écrit : >>> Hi all, >>> >>> I am planning to add some new documentation in Confluence but will have >>> them >>> placed/linked under the affected OFBiz release / version. For a user >>> navigating the documentation, the user can click on a particular OFBiz >>> release on the menu tree to display the list of topic for that OFBiz >>> version. >>> >>> What do you think of this approach? Are there better ways to structure >>> the >>> menu items? >>> >>> Cheers, >>> James Yong >>> >>> >>> >>> -- >>> View this message in context: >>> http://ofbiz.135035.n4.nabble.com/Documentation-by-Release-Version-tp4703069.html >>> Sent from the OFBiz - Dev mailing list archive at Nabble.com. >>> > > > > > -- > View this message in context: http://ofbiz.135035.n4.nabble.com/Documentation-by-Release-Version-tp4703069p4703111.html > Sent from the OFBiz - Dev mailing list archive at Nabble.com. > > |
Re: Documentation by Release / Version
|
|
See if this effort can be part of -
https://cwiki.apache.org/confluence/display/OFBIZ/Business+Process+Stories+and+Use+Cases+Library For more details please refer the email thread - ofbiz.markmail.org/search/?q=User+Acceptance+Test+Cases+For+Ecommerce+14.12 Or you would like to do it as completely separate effort and document will target completely different audiance/purpose? Thanks! Regards, -- Rishi Solanki Sr. Manager, Enterprise Software Development HotWax Systems Pvt. Ltd. Direct: +91-9893287847 http://www.hotwaxsystems.com On Fri, Mar 10, 2017 at 4:05 PM, Jacques Le Roux < [hidden email]> wrote: > +1 > > Jacques > > > Le 10/03/2017 à 02:45, james yong a écrit : > >> Hi Jacques, >> >> I like your approach too. I propose creating a Tour page in Confluence. >> This tour page will have a direct child page for the recent OFBiz >> releases, >> like the following menu structure: >> >> Tour >> -> Release 13.7 >> -> Release 16.11 >> >> Each of the Release xx.x page is a Table of Content that links to other >> existing pages. >> The tour is meant for beginner and they are expected to go through the >> topics from top to bottom. >> With this approach, there will not be direct child page under each >> Release >> xx.x page. Existing documentation isn’t affected. >> >> Regards, >> James >> >> >> >> Jacques Le Roux wrote >> >> Hi James, >>> >>> I'm all for it. >>> >>> Note that I already used another strategy by referring to the history of >>> few major pages[1] while documenting the Gradle from Ant. It though was a >>> more an expedient than a structured way as you are proposing. But it >>> could >>> still be used when referring to old pages... >>> >>> [1] These pages contain the sentence "the pre-Gradle documentation is >>> here", eg >>> https://cwiki.apache.org/confluence/display/OFBIZ/Demo+and+ >>> Test+Setup+Guide >>> >>> Jacques >>> >>> >>> Le 08/03/2017 à 18:05, james yong a écrit : >>> >>>> Hi all, >>>> >>>> I am planning to add some new documentation in Confluence but will have >>>> them >>>> placed/linked under the affected OFBiz release / version. For a user >>>> navigating the documentation, the user can click on a particular OFBiz >>>> release on the menu tree to display the list of topic for that OFBiz >>>> version. >>>> >>>> What do you think of this approach? Are there better ways to structure >>>> the >>>> menu items? >>>> >>>> Cheers, >>>> James Yong >>>> >>>> >>>> >>>> -- >>>> View this message in context: >>>> http://ofbiz.135035.n4.nabble.com/Documentation-by-Release-V >>>> ersion-tp4703069.html >>>> Sent from the OFBiz - Dev mailing list archive at Nabble.com. >>>> >>>> >> >> >> >> -- >> View this message in context: http://ofbiz.135035.n4.nabble. >> com/Documentation-by-Release-Version-tp4703069p4703111.html >> Sent from the OFBiz - Dev mailing list archive at Nabble.com. >> >> >> > |
Re: Documentation by Release / Version
|
|
Hi Rishi,
Sorry for the late reply. The Tour section contains links to other topics for guiding the beginners. I think "Business Process Stories and Use Cases Library" is good and important to be included in Tour as it helps beginners to evaluate their business needs. Cheers, James Yong
|
«
Return to OFBiz - Dev
|
1 view|%1 views
| Free forum by Nabble | Edit this page |