https://github.com/php/web-doc-editor

The PHP Documentation Editor
https://github.com/php/web-doc-editor

Last synced: about 1 month ago
JSON representation

The PHP Documentation Editor

• Host: GitHub
• URL: https://github.com/php/web-doc-editor
• Owner: php
• License: other
• Created: 2012-01-25T22:14:24.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2021-10-15T11:04:31.000Z (about 3 years ago)
• Last Synced: 2024-04-14T04:23:35.169Z (7 months ago)
• Language: JavaScript
• Homepage: http://edit.php.net
• Size: 14.2 MB
• Stars: 43
• Watchers: 22
• Forks: 37
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Installation instructions

## Requirements

* PHP 5.2.1+

* The MySQLi extension

* The cURL extension

* Shell exec privileges

* native vcs-client (e.g. using Subversion should have native svn-client)

* Php mail function must be activate

* Apache mod-rewrite module

## Configuration

* Configuration is set in php/conf/

## File structure

* Clone of the GIT repository copy named doc-editor.git

  - git clone https://github.com/php/web-doc-editor.git doc-editor (Use web URL)

  - git clone [email protected]:php/web-doc-editor.git doc-editor (Use a password-protected SSH key)

* Make sure the data directory has read/write permissions for the web server user

  - Default data directory location: doc-editor/data

## The Database

* Create a MySQL database as per php/conf/conf.ini

* Import install/doc-editor.sql into this new database

* Setup configuration options for each project inside php/conf/project.XXX.ini (php/conf/project.php.ini for the php project, php/conf/project.pear.ini for the pear project, etc.)

## Initial (first) run

* Execute install/firstRun.php either in the browser or via CLI

  It will take a long time to execute, as it performs the following duties, for each project:

  - Applies tools such as revcheck, doc_check, and error_check

  - Checks out the phpdoc-all VCS module into the data directory

## Other notes

* Anonymous authentication : anonymous with blank password

* Or use your own SVN credentials

* After modifying any .js, run scripts/utils/compress.sh, you need yui-compressor-2.4.2+

  The script will look for scripts/utils/yuicompressor.jar