doc:howto:gettingstarted

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
Next revisionBoth sides next revision
doc:howto:gettingstarted [2009/09/09 00:08] – initial commit, needs improvement philipdoc:howto:gettingstarted [2013/04/28 10:31] – Display '--' properly. leszek
Line 1: Line 1:
 ===== What is needed ===== ===== What is needed =====
 +
 +==== Joining the PHP Documentation team ====
 +
 +Joining the PHP Documentation team is a simple process, but a process nonetheless. It can be summarized as:
 +
 +== Write the mailing list ==
 +
 +Because official communication is done there, you should [[doc/howto/communication|write the list]]. Say "Hi" and what you're interested in doing. You may feel more comfortable lurking for awhile, or reading the archives, or hanging out in IRC (#php.doc on Efnet) for awhile, but ultimately let the list know who you are.
 +
 +== Create a doc patch or three ==
 +
 +This shows a few things:
 +
 +  * That you really do intend to do some work
 +  * That you're a real human
 +  * That you know, for the most part, what you're doing
 +
 +This HOWTO covers how to do this (checkout from SVN, edit, svn diff foo > doc.patch) but ultimately you must do it. We're all in the same boat here, so please jump on board!
 +
 +Or, another (and simpler) way to get started is by using the [[https://edit.php.net/|Online Documentation Editor]] which allows you to login via facebook/twitter/google connect and write patches.
 +
 +== Talk about the patch ==
 +
 +So now that you've showed initiative enough to actually setup the documentation toolchain, make edits, and create a nice looking patch (or three), it's time to let people know about it. Post it to the mailing list. People will offer feedback and advice, and do remember that we all make mistakes so don't be afraid. The most common mistakes involve whitespace issues so watch that whitespace! :) 
 +
 +== Gain commit access ==
 +
 +After talking about the patch, you'll be asked to request a SVN account and soon thereafter it'll be approved with PHP documentation karma granted. In other words, commit your own patches! PHP peer review happens after commits are made, and most committers receive emails regarding each commit and have a look. Essentially, we all trust each other and enjoy seeing each other work.
  
 ==== Subversion (SVN) ==== ==== Subversion (SVN) ====
Line 12: Line 40:
   * Right click anywhere in the blank area to spawn the context menu, select "SVN Checkout..."   * Right click anywhere in the blank area to spawn the context menu, select "SVN Checkout..."
   * A new window will popup asking for details about the checkout, these values will be remembered, so you will not need to enter them again   * A new window will popup asking for details about the checkout, these values will be remembered, so you will not need to enter them again
-  * Enter the following URL: "http://svn.php.net/repository/phpdoc", then OK to begin the checkout. If you're prompted to enter a password while checking out, then type in "phpfi" and OK +  * Enter the following URL: "https://svn.php.net/repository/phpdoc/modules/doc-en/", then OK to begin the checkout
-  * When the checkout is complete, then it should have created a directory called "phpdoc" where the php documentation source tree will be+
  
 == Mac == == Mac ==
Line 22: Line 49:
  
 The command-line works fine, download/install the sources (or binaries) from [[http://subversion.tigris.org/]] The command-line works fine, download/install the sources (or binaries) from [[http://subversion.tigris.org/]]
- 
 ==== The source files ==== ==== The source files ====
 +
 +//Note:// There are two ways. Everyone should have a local checkout, but the [[https://edit.php.net/|Online Editor]] also works. 
  
 Using SVN, checkout the source files of the PHP manual. These are the files you will edit and commit, and anyone (no account is required) may checkout these files. For example, using the command-line: Using SVN, checkout the source files of the PHP manual. These are the files you will edit and commit, and anyone (no account is required) may checkout these files. For example, using the command-line:
  
-  * svn checkout http://svn.php.net/repository/phpdoc/modules/phpdoc-en phpdoc+  * ''svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en phpdoc''
  
 That will use svn:externals to checkout both the doc-base and en/ modules, into a local directory named phpdoc. Then, after the above you might: That will use svn:externals to checkout both the doc-base and en/ modules, into a local directory named phpdoc. Then, after the above you might:
  
-  * cd phpdoc +  * ''cd phpdoc'' 
-  * vim en/preface.xml+  * ''vim en/preface.xml'' 
 +  * ''php doc-base/configure.php''
  
-In other words, this will create a directory named 'phpdoc' with a subdirectory 'en' that contains all of the English files. Now, a translator will instead do something like the following (to checkout German):+In other words, this will create a directory named 'phpdoc' with a subdirectory 'en' that contains all of the English files. And a 'doc-base' directory with files used to validate/build/help the process. Now, a translator will instead do something like the following (to checkout German):
  
-  * svn checkout http://svn.php.net/repository/phpdoc/modules/phpdoc-de phpdoc-de +  * ''svn checkout https://svn.php.net/repository/phpdoc/modules/doc-de phpdoc-de'' 
-  * cd phpdoc-de +  * ''cd phpdoc-de'' 
-  * vim de/preface.xml en/preface.xml+  * ''vim de/preface.xml en/preface.xml'' 
 +  * ''php doc-base/configure.php %%--%%with-lang=de'' 
 + 
 +Note: The above can all be done anonymously, therefore does not require a SVN account. Going through the above process is required before gaining SVN access, as is submitting a few patches to the [[communication|phpdoc mailing list]]. After doing so, people realize your're both sane and serious, [[http://php.net/svn-php|apply for SVN access]] and it will granted so you may commit changes to the PHP documentation yourself. 
  
 ==== PHP ==== ==== PHP ====
Line 47: Line 79:
  
 The build system that builds both the downloadable and online versions of the PHP manual. It also builds the PEAR manual, and several other DocBook 5 based documents. Installing PhD is optional, however it's recommended so you may see what your changes will look like. The build system that builds both the downloadable and online versions of the PHP manual. It also builds the PEAR manual, and several other DocBook 5 based documents. Installing PhD is optional, however it's recommended so you may see what your changes will look like.
 +
 +Note: doc-base/configure.php is not part of phd. configure.php is what turns all the XML files into one monolithic XML files that phd then processes, therefore, running configure.php before each use of phd is required.
  
 ==== A text editor ==== ==== A text editor ====
  
 Any will do, as XML is simply text. Most text editors provide syntax highlighting for XML files.  Any will do, as XML is simply text. Most text editors provide syntax highlighting for XML files. 
 +
 +Note: Please disable the 'remove ending whitespace' feature of your text editor.
doc/howto/gettingstarted.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools