doc:howto:gettingstarted
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:howto:gettingstarted [2013/04/28 10:31] – Display '--' properly. leszek | doc:howto:gettingstarted [2017/09/22 13:28] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== What is needed ===== | + | This page has been removed, in favor of [[http:// |
- | + | ||
- | ==== 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/ | + | |
- | + | ||
- | == 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:// | + | |
- | + | ||
- | == 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, | + | |
- | + | ||
- | ==== Subversion (SVN) ==== | + | |
- | + | ||
- | Since the documentation is stored in SVN, you'll need a SVN client. SVN is a common form of version control and every operating system has clients for this. A client does not mean a GUI although some people prefer GUI interfaces. The following list is not exhaustive put should provide an idea for what we're talking about. | + | |
- | + | ||
- | == Windows == | + | |
- | + | ||
- | The most common is TortoiseSVN. Here are the steps to checkout the sources of the PHP manual using it: | + | |
- | * Download and install TortoiseSVN: | + | |
- | * Open a new explorer window and go to the folder you wish to do the checkout into | + | |
- | * 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 | + | |
- | * Enter the following URL: " | + | |
- | + | ||
- | == Mac == | + | |
- | + | ||
- | The command-line works fine, download/ | + | |
- | + | ||
- | == Linux == | + | |
- | + | ||
- | The command-line works fine, download/ | + | |
- | ==== The source files ==== | + | |
- | + | ||
- | //Note:// There are two ways. Everyone should have a local checkout, but the [[https:// | + | |
- | + | ||
- | 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: | + | |
- | + | ||
- | * '' | + | |
- | + | ||
- | That will use svn: | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | + | ||
- | In other words, this will create a directory named ' | + | |
- | + | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | + | ||
- | Note: The above can all be done anonymously, | + | |
- | + | ||
- | ==== PHP ==== | + | |
- | + | ||
- | You'll need a recent version of PHP. Since the build system requires PHP 5.3, you should probably install it. However, building the manual is optional as validation (ensuring XML changes are valid) is a separate process and will work with any version of PHP 5. | + | |
- | + | ||
- | ==== PhD ==== | + | |
- | + | ||
- | 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/ | + | |
- | + | ||
- | ==== A text editor ==== | + | |
- | + | ||
- | Any will do, as XML is simply text. Most text editors provide syntax highlighting for XML files. | + | |
- | + | ||
- | Note: Please disable the ' | + |
doc/howto/gettingstarted.1367145118.txt.gz · Last modified: 2017/09/22 13:28 (external edit)