Apache OpenOffice (AOO) Bugzilla – Issue 122300
Update the README file
Last modified: 2017-05-20 11:27:51 UTC
The README file needs to be updated in several aspects. Some examples: "For latest updates to this readme file, see http://www.openoffice.org/welcome/readme.html" This page has "OpenOffice.org 3.0 ReadMe" "The Apache OpenOffice Community, responsible for the development of this product, would like to invite you to participate as a community member. As a new user, you can check out the OpenOffice site with helpful user information at http://www.openoffice.org/about_us/introduction.html" This page is outdated, from 2007, even if it redirects, it should be removed from the README or updated to reflect new content Remove the "System Requirements" from the "Notes on Installation" completely, or simply point to the version on the user portal (Note: in this case, create a general page that redirects to the actual one, for example http://www.openoffice.org/sysreqs/lates.html ---> http://www.openoffice.org/sysreqs/400.html) "Extension Database Incompatibility", if I understood clearly, talks about a change in the Berkeley db on 3.2, this is also outdated even for 3.4, where this db was completely replaced. Check if SESSION_MANAGER tip in "Problems During Program Startup" is still valid on Gnome. Check if "File Locking" is still valid. In "User Support", update link to user forums, and check other links In "How to Start", the linl is obsolete. "Subscribe" has still old incubator mail addresses.
Adding Jürgen on CC @jsc: this will trigger a translation update.
Are you already working on this? If yes, when can we expect it to trigger the translation? Besides the proposed changes that make sense, we should think about a release check list in the wiki. A list of release relevant items that have to be checked and done for every future release.
(In reply to comment #2) > Are you already working on this? No, I'm not; I just saw this while playing with the AboutDialog. We need someone skilled in documentation and in English language. > If yes, when can we expect it to trigger the translation? I'd suggest to post a mail on dev@ asking for feedback, though this may end up in endless and pointless discussion; so may be simple a post to doc@ > Besides the proposed changes that make sense, we should think about a > release check list in the wiki. A list of release relevant items that have > to be checked and done for every future release. Good idea, but this one should be checked *before*, not the same week we have a release candidate ;) Side note: the Readme is accessible through the About dialog since revision 1388877 - something is not working in the QA side if this gets discovered 7 months, 2 weeks ago later...
The README at http://svn.apache.org/viewvc/openoffice/trunk/main/readlicense_oo/docs/readme/readme.xrm?view=markup (from revision 1484303) still needs proofreading by a native speaker, but is reasonably up-to-date.
Andrea: Is this issue solved for AOO 4.0?
The current README has already received some basic updates last month to make it less obsolete. I don't know if this has been integrated in Pootle or not. In theory, it would still need: - A review from a native speaker - Dropping the system requirements if we agree to do so but what is in SVN now is already better than what we shipped with 3.4.x.
Pootle updated and new po files available as well http://people.apache.org/~jsc/translation/aoo40_ui_pt_po-files.zip http://people.apache.org/~jsc/translation/aoo40_help_pt_po-files.zip good progress ;-) cool
forget my last comment, wrong issue -> was intended to be for 121816
I can help with this. Are system requirements basically the same as 3.4? http://www.openoffice.org/dev_docs/source/sys_reqs_aoo34.html I strongly suggest to change java requirements to *at least* java 1.6, patch level 45, or openJdk, patch level = ???? (need some help with this one). I can mock up a new 4.0 web readme page, along with a 4.0 requirements web page, and if we like that, we can port to actual README file. End of this coming Sunday, June 23rd, PDT. Reassigned to kschenk.
New web version of (generic) readme is available on staging: http://ooo-site.staging.apache.org/welcome/readme.html and new sys-req for 4.0 at: http://ooo-site.staging.apache.org/dev_docs/source/sys_reqs_aoo40.html I can add in the system requirements for 4.0 to: http://www.openoffice.org/dev_docs/source/sys_reqs.html when we go live. I also suggest changing this one line -- <p class="note" id="javaneeded" xml:lang="en-US">${PRODUCTNAME} requires a recent version of JAVA for full functionality; JAVA can be downloaded from <a href="http://java.com">http://java.com</a>.</p> in /trunk/main/readlicense_oo/docs/readme/readme.xrm to -- <p class="note" id="javaneeded" xml:lang="en-US">${PRODUCTNAME} requires a recent version of JAVA for full functionality; JAVA can be downloaded from <a href="http://java.com">http://java.com</a>, or, alternately for Linux, <a href="http://openjdk.java.net/">OpenJDK</a>.</p> Not a big deal but maybe something we should do. The rest of the README looks pretty good to me.
Are the updates I made sufficient to close this out?
I believe it's OK. The issue can't be closed yet since now the HTML file at http://ooo-site.staging.apache.org/welcome/readme.html needs to be ported back to http://svn.apache.org/viewvc/openoffice/trunk/main/readlicense_oo/docs/readme/readme.xrm (remembering to remove system requirements, that Kay already removed in the HTML file). But the text is there. Note that OpenOffice (Help - About - License) does not render the file as HTML, but as plain text. This will require some attention while converting the file.
I don't think that we can do that for AOO 4.0, it would trigger again a translation round and I am don't have the time for a further update round and our volunteers are probably not happy with further updates. I remove the showstopper flag and this further update should we do directly after 4.0 for 4.1
The README version we are distributing now (see https://issues.apache.org/ooo/show_bug.cgi?id=122300#c4 ) is already the updated version (from last month). So the issue is mostly fixed anyway: the README that was available at the latest Pootle update was already up-to-date content-wise. Keeping this open and reassigning to me for the part concerning porting Kay's corrections to the xrm file (to be done after release).
Well I basically took what I saw in the product README file and reproduced it on the Web /welcome/readme.html page thinking no ports back to the svn would be necessary. (Well the page was WAY out of date, so good this was caught!) The product README says to look at the webpage for current information so I did add a few things, thinking that would still follow the logic. I didn't commit it to svn due to the translation warnings.
Reset assigne to the default "issues@openoffice.apache.org".