Hi Ron, On Jun 16, 2014, at 5:15 PM, Ron Wheeler <rwhee...@artifact-software.com> wrote:
> -1 > > Given the errors in the wiki documentation and the lack of on-line help, it > is hard to see how this could be considered "tested" (try to install it using > the docs for a "recommended" production database and you can see it is not > possible that it passed "manual tests" unless the test suite is too trivial > to be taken seriously) or "complete" (on-line help just opens a page of > sections headings that does not do anything when you click on it). > > I don't see any Release notes in the distribution. > Unfortunately our releases do not include documentation: the reason is that the amount and quality of documentation available is not good enough for being part of a release. > Are the new features at least documented? No, even if in this specific case we are delivering a bug fix release with no new features. > Did the use cases for the new features and bug fixes get into the > documentation? > No, even if you can find some sparse information here: https://cwiki.apache.org/confluence/display/OFBIZ/Main+New+Features and in Jira. > If the PMC group continues to allow new releases to be made without any > attention to documentation, OfBiz will never get the documentation that it > needs. At least make documentation of items that are worked on in a release, > mandatory. I disagree that we should implement this strategy to improve the documentation: the OFBiz project doesn't release very often and in the past this was a problem for the ASF; now the situation is improved and we should go on with what we are doing; of course we should always try to improve our product (code and documentation). But I completely agree with you that the community should focus on the creation and maintenance of good documentation; when this will happen we could bundle it with the releases or publish as a separate product ("The Apache OFBiz Manual" or similar). > > Is it possible for the PMC to set some targets for a target level of > documentation so that there is a baseline set of JIRA issues on which the PMC > agrees? We should really start this conversation in the dev list (rather than Jira or the PMC private list); some topics to discuss: how can we improve the existing documentation? (Confluence vs ASF CMS vs OFBiz website vs etc..) Who should maintain it? (Public wiki with moderators vs committers specialized in writing docs vs etc...) What kind of documentation is essential and what is mandatory? Who is the target audience of the documents (Tech teams interested in the customization of OFBiz vs End users vs ...) How to use Jira to automatically generate release notes? Jacopo > > > Ron > > > On 16/06/2014 9:25 AM, Jacopo Cappellato wrote: >> +1 >> >> Jacopo >> >> On Jun 9, 2014, at 4:09 PM, Jacopo Cappellato >> <jacopo.cappell...@hotwaxmedia.com> wrote: >> >>> This is the vote thread to release a new (bug fix) release for the 12.04 >>> branch. This new release, "Apache OFBiz 12.04.03" (major release number: >>> "12.04"; minor release number: "03"), will supersede the release "Apache >>> OFBiz 12.04.02". >>> >>> The release files can be downloaded from here: >>> >>> https://dist.apache.org/repos/dist/dev/ofbiz/ >>> >>> (committers only) or from here: >>> >>> http://people.apache.org/~jacopoc/dist/ >>> >>> (everyone else) >>> >>> and are: >>> >>> * apache-ofbiz-12.04.03.zip: the release package, based on the 12.04 branch >>> at revision 1601320 (latest as of now) >>> * KEYS: text file with keys >>> * apache-ofbiz-12.04.03.zip.asc: the detached signature file >>> * apache-ofbiz-12.04.03.zip.md5, apache-ofbiz-12.04.03.zip.sha: hashes >>> >>> Please download and test the zip file and its signatures (for instructions >>> on testing the signatures see http://www.apache.org/info/verification.html). >>> >>> Vote: >>> >>> [ +1] release as Apache OFBiz 12.04.03 >>> [ -1] do not release >>> >>> This vote will be closed in 5 days. >>> For more details about this process please read >>> http://www.apache.org/foundation/voting.html >>> >>> The following text is quoted from the above url: >>> "Votes on whether a package is ready to be released use majority approval >>> -- i.e. at least three PMC members must vote affirmatively for release, and >>> there must be more positive than negative votes. Releases may not be >>> vetoed. Generally the community will cancel the release vote if anyone >>> identifies serious problems, but in most cases the ultimate decision, lies >>> with the individual serving as release manager." >>> >>> Kind Regards, >>> >>> Jacopo >> > > > -- > Ron Wheeler > President > Artifact Software Inc > email: rwhee...@artifact-software.com > skype: ronaldmwheeler > phone: 866-970-2435, ext 102 >
