doc:howto:gettingstarted

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
doc:howto:gettingstarted [2011/07/10 22:52] – linked to communication section philipdoc:howto:gettingstarted [2013/04/28 10:31] – Display '--' properly. leszek
Line 18: Line 18:
  
 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! 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 == == 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 what whitespace! :) +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 == == Gain commit access ==
Line 48: Line 50:
 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 https://svn.php.net/repository/phpdoc/modules/doc-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+  * ''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. 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): 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 https://svn.php.net/repository/phpdoc/modules/doc-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+  * ''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.  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. 
Line 82: Line 86:
 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' future of your text editor.+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