#21970 [Asn]: Creating a new Tutorial section

ID: 21970 Updated by: derek@php.net Reported By: philip at cornado dot com Status: Assigned Bug Type: Documentation problem Operating System: all PHP Version: Irrelevant Assigned To: aidan New Comment: Certainly techniques.patterns should be techniques.design.patterns? Previous Comments: ------------------------------------------------------------------------ [2005-09-09 08:28:49] aidan@php.net Summarising the feedback, * I think we've agreed "techniques" is the way to go in terms of naming the new section. * I think getting-started will stay where it is. * The new techniques section will be placed after the security section. * All the material in the features section will be incorporated into the techniques section. And the following new sections will be created, - techniques.include-path See philip's original post. Also, I notice a lot of questions regarding include_paths in included files, where the include path is relative to, getcwd, etc. This would make a nice addition to the include-path section. - techniques.patterns PHP 4 / 5 singleton + factory patterns - techniques.magic-quotes Info moved and aggregated from the security / faq - techniques.register-globals Info moved and aggregated from the security / faq - techniques.command-line All the information about running PHP from the CLI ?- techniques.databasing general good database practices (also moved from security section) So far I think everyone has agreed on these. The ones we're not too sure about being the tutorial-type sections. Perhaps these could be placed in a subsection of techniques called "design". - techniques.design.black-box Detailing the foo.php?page=contact design ------------------------------------------------------------------------ [2005-01-25 07:44:08] philip@php.net Somewhere down the line this bug report got renamed so be sure it's not closed until include_path is properly (extensively) documented. Not everything belongs in a tutorial...I agree with Goba on all points. ------------------------------------------------------------------------ [2005-01-24 16:44:24] sean@php.net I agree with both Anatoly & Goba, here. - Getting started needs to be easily found by new developers. - And ~"Techniques" is a good name for the section we envisioned as "Tutorials" they're programming (usually php-specific or web-specific) techniques. - Perhaps a note should be dropped into the intro to "features/techniques" section that links to Getting Started. S ------------------------------------------------------------------------ [2005-01-23 15:09:06] goba@php.net I think 'getting started' should be left alone, it is quite good for a beginner to start. If you look a bit closely at 'features' though, it is the exact place where tutorials are located already. We agreed on it before AFAIR that extension specific tutorials should go into their reference part, while broader scope tutorials or core tutorials should go into 'features'. Now we can rename it to 'PHP Programming Techniques' or something more flashy, but I think it is the right place to push tutorials into (except the getting started tutorial). Derek: 'reference' should be very far from being confused with 'tutorial' IMHO! ------------------------------------------------------------------------ [2005-01-23 14:50:02] techtonik@php.net No, getting started is for beginners and they should be able to get to this page as fast as possible by just clicking "next" link or by looking at Table of Contents. Being good attractor for newbies "Getting Started" should be located at the top of ToC and visible by default. "Language Reference" is too dull to reflect how clear and easy PHP is. ------------------------------------------------------------------------ The remainder of the comments for this report are too long. To view the rest of the comments, please view the bug report online at http://bugs.php.net/21970 -- Edit this bug report at http://bugs.php.net/?id=21970&edit=1