diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2012-04-11 23:57:36 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2012-04-11 23:59:11 -0400 |
| commit | 8382e449423fd1dfecb416389613e847b02f63c6 (patch) | |
| tree | aa99843bf178d5b12e39d68c00ab342314479052 /phpBB/docs/README.html | |
| parent | 7fa2be51ce1a9c3f196c85a450da8f200b95bf84 (diff) | |
| download | forums-8382e449423fd1dfecb416389613e847b02f63c6.tar forums-8382e449423fd1dfecb416389613e847b02f63c6.tar.gz forums-8382e449423fd1dfecb416389613e847b02f63c6.tar.bz2 forums-8382e449423fd1dfecb416389613e847b02f63c6.tar.xz forums-8382e449423fd1dfecb416389613e847b02f63c6.zip | |
[ticket/10688] Update readme for 3.1 and current practices.
PHPBB3-10688
Diffstat (limited to 'phpBB/docs/README.html')
| -rw-r--r-- | phpBB/docs/README.html | 55 |
1 files changed, 31 insertions, 24 deletions
diff --git a/phpBB/docs/README.html b/phpBB/docs/README.html index 7cd727c60e..6adc1ee7cb 100644 --- a/phpBB/docs/README.html +++ b/phpBB/docs/README.html @@ -84,23 +84,26 @@ <div class="content"> - <p>Installation, update and conversion instructions can be found in the <a href="INSTALL.html">INSTALL</a> document contained in this distribution. If you are intending to convert from a previous phpBB 2.0.x installation we highly recommend you backup any existing data before proceeding!</p> + <p>Installation, update and conversion instructions can be found in the <a href="INSTALL.html">INSTALL</a> document contained in this distribution. If you are intending to convert from a previous phpBB 2.0.x or 3.0.x installation we highly recommend you backup any existing data before proceeding!</p> - <p>Users of phpBB3 Beta versions cannot directly update.</p> + <p>Users of phpBB 3.0 and 3.1 Beta versions cannot directly update.</p> <p>Please note that we won't support the following installation types:</p> <ul> - <li>Updates from phpBB3 Beta versions to phpBB3 RC1 and higher</li> - <li>Conversions from phpBB 2.0.x to phpBB3 Beta versions</li> - <li>phpBB3 Beta installations</li> + <li>Updates from phpBB 3.0 Beta versions to phpBB 3.0 RC1 and higher</li> + <li>Updates from phpBB 3.1 Beta versions to phpBB 3.1 RC1 and higher</li> + <li>Conversions from phpBB 2.0.x to phpBB 3.0 or 3.1 Beta versions</li> + <li>phpBB 3.0 or 3.1 Beta installations</li> </ul> <p>We give support for the following installation types:</p> <ul> - <li>Updates from phpBB3 RC1 to the latest version</li> + <li>Updates from phpBB 3.0 RC1 and 3.1 RC1 to the latest version</li> + <li>Note: if using the <em>Automatic Update Package</em>, updates are supported from phpBB 3.0.2 onward. To update a pre-3.0.2 installation, first update to 3.0.2 and then update to the current version.</li> <li>Conversions from phpBB 2.0.x to the latest version</li> - <li>New installations of phpBB3 - always only the latest released version</li> + <li>New installations of phpBB 3.0.x - always only the latest released version</li> + <li>New installations of phpBB 3.1.x - always only the latest released version</li> </ul> </div> @@ -129,13 +132,13 @@ <p>This is the <em>official</em> location for all supported language sets. If you download a package from a 3rd party site you do so with the understanding that we cannot offer support. So please, do not ask for help in these cases!</p> - <p>Installation of these packages is straightforward, simply download the required language pack and unarchive it into the <samp>languages/</samp> folder. Please ensure you retain the directory structure when doing this! Once uploaded go to the <code>Admin->System->Language Packs</code> and install the now appeared new language pack. To install the style imageset you should download the imageset for your language and unarchive the file/s into the relevant imageset directory (styles/prosilver/imageset or styles/subsilver2/imageset), again you must retain the directory structure. Once installed the imageset will become immediately available.</p> + <p>Installation of these packages is straightforward, simply download the required language pack and unarchive it into the <samp>languages/</samp> folder. Please ensure you retain the directory structure when doing this! Once uploaded go to the <code>Admin->System->Language Packs</code> and install the now appearing new language pack. To install the style imageset you should download the imageset for your language and unarchive the file/s into the relevant imageset directory (styles/prosilver/imageset or styles/subsilver2/imageset), again you must retain the directory structure. Once installed the imageset will become immediately available.</p> <p>If your language is not available please visit our forums where you will find a topic listing translations currently available or in preparation. This topic also gives you information should you wish to volunteer to translate a language not currently listed.</p> <a name="styles"></a><h3>2.ii. Styles</h3> - <p>Although phpBB Group are rather proud of the included styles we realise that it may not be to everyones tastes. Therefore phpBB3 allows styles to be switched with relative ease. Firstly you need to locate and download a style you like. We maintain such a site at</p> + <p>Although phpBB Group are rather proud of the included styles we realise that they may not be to everyone's tastes. Therefore phpBB3 allows styles to be switched with relative ease. Firstly you need to locate and download a style you like. We maintain such a site at</p> <p><a href="http://www.phpbb.com/styles/">http://www.phpbb.com/styles/</a></p> @@ -185,7 +188,7 @@ <p>phpBB Group maintains a thriving community where a number of people have generously decided to donate their time to help support users. This site can be found at:</p> - <p><a href="http://www.phpbb.com/">http://www.phpbb.com/</a></p> + <p><a href="http://www.phpbb.com/community/">http://www.phpbb.com/community/</a></p> <p>If you do seek help via our forums please be sure to do a Search before posting. This may well save both you and us time and allow the developer, moderator and support groups to spend more time responding to people with unknown issues and problems. Please also remember that phpBB is an entirely volunteer effort, no one receives any compensation for the time they give, this includes moderators as well as developers. So please be respectful and mindful when awaiting responses.</p> @@ -193,6 +196,8 @@ <p>Another place you may find help is our IRC channel. This operates on the Freenode IRC network, <em>irc.freenode.net</em> and the channel is <em>#phpbb</em> and can be accessed by any good IRC client such as mIRC, XChat, etc. Again, please do not abuse this service and be respectful of other users.</p> + <p>There are other IRC channels available, please see <a href="http://www.phpbb.com/support/irc/">http://www.phpbb.com/support/irc/</a> for the complete list.</p> + </div> <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> @@ -209,13 +214,13 @@ <div class="content"> - <p>This is the third stable release of phpBB. The 3.0.x line is essentially feature frozen, with only point releases seeing fixes for bugs and security issues, though feature alterations and minor feature additions may be done if deemed absolutely required. Our next major release will be phpBB 3.2 and the planning phase has begun (the unstable development version is 3.1). Please do not post questions asking when 3.2 will be available, no release date has been set.</p> + <p>This is a stable release of phpBB. The 3.1.x line is feature frozen, with point releases principally including fixes for bugs and security issues. Feature alterations and minor feature additions may be done if deemed absolutely required. The next major release will be phpBB 3.2 which is currently under development. Please do not post questions asking when 3.2 will be available, no release date has been set.</p> - <p>For those interested in the development of phpBB should keep an eye on the community forums to see how things are progressing:</p> + <p>Those interested in the development of phpBB should keep an eye on the development forums to see how things are progressing:</p> <p><a href="http://area51.phpbb.com/phpBB/">http://area51.phpbb.com/phpBB/</a></p> - <p>Please note that this forum should <strong>NOT</strong> be used to obtain support for or ask questions about phpBB 2.0.x or phpBB 3.1.x, the main community forums are the place for this. Any such posts will be locked and go unanswered.</p> + <p>Please note that this forum should <strong>NOT</strong> be used to obtain support for phpBB, the main community forums are the place for this.</p> </div> @@ -233,31 +238,33 @@ <div class="content"> - <p>The phpBB Group uses a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please <strong>DO NOT</strong> post bug reports to our forums, they will be locked. In addition please <strong>DO NOT</strong> use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).</p> + <p>The phpBB Group uses a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please <strong>DO NOT</strong> post bug reports to our forums. In addition please <strong>DO NOT</strong> use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).</p> - <p><a href="http://tracker.phpbb.com/">http://tracker.phpbb.com/</a></p> + <p><a href="http://tracker.phpbb.com/browse/PHPBB3">http://tracker.phpbb.com/browse/PHPBB3</a></p> <p>While we very much appreciate receiving bug reports (the more reports the more stable phpBB will be) we ask you carry out a few steps before adding new entries:</p> <ul> - <li>Firstly determine if your bug is reproduceable, how to determine this depends on the bug in question. Only if the bug is reproduceable it is likely to be a problem with phpBB3 (or in some way connected). If something cannot be reproduced it may turn out to have been your hosting provider working on something, a user doing something silly, etc. Bug reports for non-reproduceable events can slow down our attempts to fix real, reproduceable issues<br /><br /></li> + <li>Firstly determine if your bug is reproduceable, how to determine this depends on the bug in question. Only if the bug is reproduceable it is likely to be a problem with phpBB3 (or in some way connected). If something cannot be reproduced it may turn out to have been your hosting provider working on something, a user doing something silly, etc. Bug reports for non-reproduceable events can slow down our attempts to fix real, reproduceable issues.<br /><br /></li> <li>Next please read or search through the existing bug reports to see if <em>your</em> bug (or one very similar to it) is already listed. If it is please add to that existing bug rather than creating a new duplicate entry (all this does is slow us down).<br /><br /></li> - <li>Check the forums (use search!) to see if people have discussed anything that sounds similar to what you are seeing. However, as noted above please <strong>DO NOT</strong> post your particular bug to the forum unless it's non-reproduceable or you are sure it's related to something you have done rather phpBB3<br /><br /></li> - <li>If no existing bug exists then please feel free to add it</li> + <li>Check the forums (use search!) to see if people have discussed anything that sounds similar to what you are seeing. However, as noted above please <strong>DO NOT</strong> post your particular bug to the forum unless it's non-reproduceable or you are sure it's related to something you have done rather phpBB3.<br /><br /></li> + <li>If no existing bug exists then please feel free to add it.</li> </ul> <p>If you do post a new bug (i.e. one that isn't already listed in the bug tracker) firstly make sure you have logged in (your username and password are the same as for the community forums) then please include the following details:</p> <ul> - <li>Your server type/version, e.g. Apache 1.3.28, IIS 4, Sambar, etc.</li> - <li>PHP version and mode of operation, e.g. PHP 5.1.1 as a module, PHP 4.4.4 running as CGI, etc.</li> - <li>DB type/version, e.g. MySQL 4.0.1, PostgreSQL 7.3.2, MSSQL Server 2000 SP1, etc.</li> + <li>Your server type/version, e.g. Apache 2.2.3, IIS 7, Sambar, etc.</li> + <li>PHP version and mode of operation, e.g. PHP 5.3.2 as a module, PHP 5.4.0 running as CGI, etc.</li> + <li>DB type/version, e.g. MySQL 5.0.77, PostgreSQL 9.0.6, MSSQL Server 2000 SP1, etc.</li> </ul> - <p>The relevant database type/version is listed within the administration control panel</p> + <p>The relevant database type/version is listed within the administration control panel.</p> <p>Please also be as detailed as you can in your report, if possible list the steps required to duplicate the problem. If you have a patch that fixes the issue, please attach it to the ticket or submit a pull request <a href="https://github.com/phpbb/phpbb3">on GitHub</a>.</p> + <p>If you create a patch, it is very much appreciated (but not required) if you follow the phpBB coding guidelines. Please note that the coding guidelines are somewhat different between different versions of phpBB. For phpBB 3.1.x the coding guidelines may be found here: <a href="http://area51.phpbb.com/docs/31x/coding-guidelines.html">http://area51.phpbb.com/docs/31x/coding-guidelines.html</a></p> + <p>Once a bug has been submitted you will be emailed any follow up comments added to it. <strong>Please</strong> if you are requested to supply additional information, do so! It is frustrating for us to receive bug reports, ask for additional information but get nothing. In these cases we have a policy of closing the bug, which may leave a very real problem in place. Obviously we would rather not have this situation arise.</p> <a name="securitybugs"></a><h3>5.i. Security related bugs</h3> @@ -306,11 +313,11 @@ <div class="content"> - <p>phpBB is no longer supported on PHP4 due to several compatibility issues and we recommend that you upgrade to the latest stable release of PHP5 to run phpBB. The minimum version required is PHP 5.2.0.</p> + <p>phpBB 3.1.x takes advantage of new features added in PHP 5.3. We recommend that you upgrade to the latest stable release of PHP5 to run phpBB. The minimum version required is PHP 5.3.2.</p> <p>Please remember that running any application on a developmental version of PHP can lead to strange/unexpected results which may appear to be bugs in the application (which may not be true). Therefore we recommend you upgrade to the newest stable version of PHP before running phpBB3. If you are running a developmental version of PHP please check any bugs you find on a system running a stable release before submitting.</p> - <p>This board has been developed and tested under Linux and Windows (amongst others) running Apache using MySQL 3.23, 4.x, 5.x, MSSQL Server 2000, PostgreSQL 7.x, Oracle 8, SQLite and Firebird. Versions of PHP used range from 5.2.0 to 5.3.x without problem.</p> + <p>This board has been developed and tested under Linux and Windows (amongst others) running Apache using MySQL 3.23, 4.x, 5.x, MSSQL Server 2000, PostgreSQL 8.x, Oracle 8, SQLite and Firebird. Versions of PHP used range from 5.3.x to 5.4.x without problem.</p> <a name="phpsec"></a><h3>7.i. Notice on PHP security issues</h3> |