Re: Hello, all. I want to add documentation for the Aerospike extension

From: Date: Sat, 07 Feb 2015 15:13:03 +0000
Subject: Re: Hello, all. I want to add documentation for the Aerospike extension
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969385345@lists.php.net to get a copy of this message
Hi Ronen, We have a tutorial on the doc wiki (http://doc.php.net/tutorial/), which should provide enough details to get you started. Checking out the sources from SVN would be your best choice for documenting an extension from scratch. The key take-home points from the tutorial, for yourself, would be: For writing the documentation: - use the docgen.php script to generate the "skeleton" documentation files based on reflection information - look at existing documentation structure and files for guidance - make sure everything builds by running configure.php (you'll do this a lot) For previewing your changes: - you will use our PHP DocBook Rendering System (PhD, for short) - http://doc.php.net/phd.php - along with a local copy of the php website code (git clone https://git.php.net/repository/web/php.git) (Note: the website can be run with PHP's built-in cli web server) Do ask, if you have any questions. Cheers, Peter On 3 February 2015 at 22:18, Ronen Botzer <rbotzer@aerospike.com> wrote: > Hello authors, translators, and associated folk. > > I'm the maintainer and one of the developers of the PHP client for > Aerospike. Currently, the documentation is on the GitHub repository, as a > set of markdown files. > > > > https://github.com/aerospike/aerospike-client-php/blob/master/doc/aerospike.md > > What is the preferable way to approach documenting an extension - should I > use the online editor, or would it be better to work on an svn checkout? > > Thanks, > Ronen > > https://github.com/rbotzer?tab=activity > > > >

« previous php.doc (#969385345) next »