2 Replies Latest reply on Sep 2, 2005 10:38 AM by Manik Surtani

    Packaging of docs - JBCACHE-156

    Manik Surtani Master

      Looking at http://jira.jboss.com/jira/browse/JBCACHE-156 at the moment.

      Ben, I take it item 1 is complete (package the JBossCache distro with the docbook generated html and pdf)?

      Regarding item 2, isn't it currently already split up into a Tutorial, Reference Manual, Aop Reference Manual and a FAQ already? Are you proposing merging the reference manuals for TreeCache and TreeCacheAop, and writing an additional User Guide?

      Regarding item 3, wouldn't things like Changelog.txt, Readme.txt, Todo.txt be best in the root of docs/ ? This would typically be the first things to look for, and I'm not sure if hiding them under a misc or release dir is a good thing.

      What are your thoughts?

      Cheers,
      Manik



      [/url]

        • 1. Re: Packaging of docs - JBCACHE-156
          Ben Wang Master

          Yes, docbook part is complete.

          But I was referring we should split the current TreeCache and TreeCacheAop doc into a separate user guide and reference manual (can still keep TreeCache and TreeCacheAop separate though).

          This can server for future purposes as well.

          Of course, we need to update faq section in this release as well.

          • 2. Re: Packaging of docs - JBCACHE-156
            Manik Surtani Master

             

            "ben.wang@jboss.com" wrote:
            Yes, docbook part is complete.

            But I was referring we should split the current TreeCache and TreeCacheAop doc into a separate user guide and reference manual (can still keep TreeCache and TreeCacheAop separate though).

            This can server for future purposes as well.

            Of course, we need to update faq section in this release as well.


            Where do you foresee this separation (between stuff that shld be in the user guide vs stuff that shld be in the reference guide) in the TreeCache and TreeCacheAop docs?

            Personally, I've always preferred a single doc containing all I need, rather than having to flip between two docs, but I do see how a quick reference guide could be useful provided it doesn't contain any more information than the more complete user guide - just a summary of salient points.

            Is this how you see the split?