com web/doc: New readme: INSTALL.txt README.md README.txt TODO.txt

Commit: f230667c76eb7ed1fd49938330226d8e59a6bb3d Author: Sobak <msobaczewski@gmail.com> Sun, 23 Mar 2014 08:14:44 +0100 Parents: e0f010beb1a549789b47c3172a09f48ead6927ea Branches: master Link: http://git.php.net/?p=web/doc.git;a=commitdiff;h=f230667c76eb7ed1fd49938330226d8e59a6bb3d Log: New readme Changed paths: D INSTALL.txt A README.md D README.txt D TODO.txt Diff: diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 7fcae8b..0000000 --- a/INSTALL.txt +++ /dev/null @@ -1,42 +0,0 @@ -Initial Installation ---------------------- - -Requirements: PHP 5 with GD (both for the bundled JpGraph to work) - -0 Install a copy of the jpgraph 2.x series - - Download from here: http://www.aditus.nu/jpgraph/jpdownload.php - - Unpack it like so: docweb/include/jpgraph/ -1. Run ./configure [--help] -2. You need to run the scripts/populatedocs.sh to fetch all the required - documentation for the site. -3. Generate the initial SQLite databases by running the following scripts: - scripts/setup_users_database.php - scripts/setup_rfc_database.php - scripts/setup_tests_database.php -4. chown the created files (see 3.) to the user and - group who apache runs under. (see scripts/set_ownership.sh) -5. The PEAR packages for the RFC System can be found at include/rfc/PACKAGES -6. A cronjob should be setup to run include/rfc/rfc-cron.php at 4am -7. You may want to create a www/robots.txt to allow or disallow bots crawling - your local docweb development site. -8. Configure the virtual host under apache. Current 'suggested settings' are: -<VirtualHost 127.0.0.1:80> - - ServerName doc.php.net - ServerAdmin doc-web@lists.php.net - - DocumentRoot /path/to/docweb/www - - ErrorDocument 404 /error.php - php_flag register_globals Off - php_flag magic_quotes_gpc Off - php_flag magic_quotes_runtime Off - - <Directory /path/to/docweb/www> - Allowoverride FileInfo Options Limit - Options -Indexes - </Directory> - -</VirtualHost> -9. If you limit the amount of memory which PHP scripts can use - increase the limit to 32M from 8M in your php..ini file. diff --git a/README.md b/README.md new file mode 100644 index 0000000..df48f99 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# doc.php.net +This repository contains files of doc.php.net, site created to help documentation contributors doing their job by +providing them usefull tools, statistics etc. Site has been partly rewritten in March 2014. If you have suggestions +please contact us on php.doc.web mailing list or contribute by i.e. sending pull request to this repo. + +## Installation +Requirments: +- PHP 5 +- GD extension (for generating charts) +- ext/sqlite (hopefully dissapear soon) + +1. Unpack a copy of JpGraph 2.x into /include/jpgraph/ +2. You need to run the scripts/populatedocs.sh to fetch all the required documentation for the site. +3. Increase memory limit for PHP scripts to at least 32MB +4. Fill in two configuration files + - build-ops.sample.php (rename it to build-ops.php) + - @SVNDIR@ - absolute path to dir where scripts will clone SVN repos to and use them for generating data + - build-ops-sample (rename it to build-ops [no ext]) + - @PHP@ - path to the PHP executable file + - @SVNDIR@ - absolute path to dir where scripts will clone SVN repos to and use them for generating data + - @DOCDIR@ - path to the directory with documentation in SVN repo + - @DOCWEB@ - absolute path to directory with this website + - @SCRIPTSDIR@- absolute path to /scripts/ directory + - @SRCDIR@ - path to the directory with PHP source code in SVN repo +5. Configure the virtual host under Apache. Current suggested settings are: +``` +<VirtualHost 127..0.0.1:80> + ServerName doc.php.net + ServerAdmin doc-web@lists.php.net + + DocumentRoot /path/to/docweb/www + + ErrorDocument 404 /error.php + php_flag register_globals Off + php_flag magic_quotes_gpc Off + php_flag magic_quotes_runtime Off + + <Directory /path/to/docweb/www> + Allowoverride FileInfo Options Limit + Options -Indexes + </Directory> +</VirtualHost> +``` + +## TODO +- replace ext/sqlite with PDO +- deal with jpgraph licensing problems +- add more cowbell \ No newline at end of file diff --git a/README.txt b/README.txt deleted file mode 100644 index fff56a9..0000000 --- a/README.txt +++ /dev/null @@ -1,3 +0,0 @@ -Subscribe to the doc-web (at) lists.php.net mailing list to get involved. - -Also, feel free to push changes. diff --git a/TODO.txt b/TODO.txt deleted file mode 100644 index fc8bf6c..0000000 --- a/TODO.txt +++ /dev/null @@ -1,11 +0,0 @@ - -TODO for the PHP docweb project: - -Remove autoconf/build_ops magic. - -Overhaul the entity check: - It utilizes the livedocs database yet we no longer use livedocs. - Files affected: - - include/lib_url_entities.inc.php - - scripts/grab_livedocs_db.php - Add more cowbell \ No newline at end of file