https://bugs.freedesktop.org/show_bug.cgi?id=53904

             Bug #: 53904
           Summary: Readme file -- remove mention of LibreOffice 3.3 and
                    review all platform requirements.
    Classification: Unclassified
           Product: LibreOffice
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: UNCONFIRMED
          Severity: normal
          Priority: medium
         Component: Libreoffice
        AssignedTo: libreoffice-bugs@lists.freedesktop.org
        ReportedBy: m...@marcpare.com


The readme file has not been reviewed in a while and still makes mention of the
older version of LibreOffice 3.3. (* The following suggestions mention line
numbers from the file at
[http://cgit.freedesktop.org/libreoffice/core/tree/readlicense_oo/docs/readme/readme.xrm])

====================
Problems/Suggestions
====================
====================
Line 160: "The desktop-integration directory also contains a package named
libreoffice3.3-freedesktop-menus-3.3.1.noarch.rpm (or similar)..." 

Suggest to change to "The desktop-integration directory also contains a package
named libreoffice3.X-freedesktop-menus-3.X.X.noarch.rpm (or similar)..."

Reason: this will remove mention of the older LibreOffice v.3.3 which no longer
applies. A generic naming scheme is probably better.
====================

Line 20 "For latest updates to this readme file, see
http://www.libreoffice.org/welcome/readme.html";. 

Problem: The website file was a shorter version of the installer package readme
and was not being updated. Line 20 is erroneous as there were no updated text
to read at the website file. NOTE: I (Marc) have since deleted the website
"Readme" page -- I can put it back up on the website if there is a reason to
put it back there.

Suggestion: Delete this line and not reference to the website (the page no
longer exists anyways). There does not seem to be any reason to have the readme
(installer package) being updated and then the website version having to be
updated or vice versa. Let me know if you think otherwise and I will put the
website page back up. The only reason I could see of having the readme on the
website is perhaps for archival purposes, but I still do not see this as a good
reason. It would mean having to monitor changes in the installer readme's and
updating the website version.
====================

Line 27: "If you appreciate their efforts, and would like to ensure that
LibreOffice continues to be available far into the future, please consider
contributing to the project - see
http://www.documentfoundation.org/contribution/ for details. Everyone can make
a contribution of some kind."

Problem: this line points to
"http://http://www.documentfoundation.org/contribution/. Not sure why it would
point to a "The Document Foundation" webpage when we are talking about the
LibreOffice project. It should point to a LibreOffice webpage.

Suggest: make this point to "http://www.libreoffice.org/get-involved/"; This
page has a more attractive look and has a better breakdown of where a user can
apply her/his talents. There is also a link to donate $$$ on this page as well.
====================

Line 234: "Our system for reporting, tracking and solving bugs is currently
BugZilla, kindly hosted at https://bugs.freedesktop.org/. We encourage all
users to feel entitled and welcome to report bugs that may arise on your
particular platform. Energetic reporting of bugs is one of the most important
contributions that the user community can make to the ongoing development and
improvement of LibreOffice."

Problem: There is no mention of our "Bug Submission Assistant" (BSA) which, for
a user, may prove easier to manage than the bugzilla submission page.

Suggest add sentence: "LibreOffice also hosts a very friendly "Bug Submission
Assistant (BSA)" which some of you may find more friendly to use than our
regular bug submission page. The BSA page may be found at
https://www.libreoffice.org/get-help/bug/.";
====================

Lines 227-230: "The main support page http://www.libreoffice.org/support/
offers various possibilities for help with LibreOffice. Your question may have
already been answered - check the Community Forum at
http://www.documentfoundation.org/nabble/ or search the archives of the
'us...@libreoffice.org' mailing list at
http://www.libreoffice.org/lists/users/. Alternatively, you can send in your
questions to us...@libreoffice.org. If you like to subscribe to the list (to
get email responses), send an empty mail to:
users+subscr...@libreoffice.org..."

Problem: There is no mention of the Ask LibreOffice website.

Suggestion We should modify to: "... Your question may have already been
answered - check the Community Forum at
http://www.documentfoundation.org/nabble/, search the answers to questions on
the Ask LibreOffice website at http://ask.libreoffice.org/ or search the
archives of the 'us...@libreoffice.org' mailing list at
http://www.libreoffice.org/lists/users/...";

====================

Lines 240 and 244 mention the link to the webpage:
http://www.libreoffice.org/contribution/

Suggest In the context of a user "contributing", I would suggest that using the
real webpage link name "http://www.libreoffice.org/get-involved/"; is more
appropriate as it portrays a more powerful image of a user getting involved in
the project. The word "contribution" just seems too passive of a word.
====================

Line 273: "Portions Copyright 1998, 1999 James Clark. Portions Copyright 1996,
1998 Netscape Communications Corporation."

Question: Is this necessary? Why are these here? What do these copyright
mentions have to do with the readme?
====================

Suggest: While we are fixing problems with the readme, we should also review
and update (if needed) the "System requirements" for Mac, Window, Linux. This
may require that some devs take a quick look at the readme file sections to
make sure that nothing has changed from the point of view of system
requirements.
====================

Cheers,

Marc

-- 
Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
_______________________________________________
Libreoffice-bugs mailing list
Libreoffice-bugs@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice-bugs

Reply via email to