perl-docs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Thomas Klausner <d...@zsi.at>
Subject New Structure - Suggestion
Date Sun, 28 Apr 2002 00:49:20 GMT
Hi!

Here is a suggestion for the new structure of the content:
(as your MUAs will probably break the long lines and tab-spacing, I've
additionally attached it..)

# Current Structure:
####################

(If there is OK in the line after an item, I think all the subitems should stay there and
thus I haven't listed them here...)

Technologie Extraordinaire
	Sites Running mod_perl
	Success Stories
	Statistics
Download
	Source mod_perl distributions
	Binary mod_perl disributions
	Software Bundles
	Documentation
Documentation
	* 1.x
	mod_perl guide
		* I Getting Started
			Feet Wet
			Intro, Credits
			Overview
			Installation
			Configuration
		* II Coding
			Perl Reference
			cgi to mod_perl porting
			HTTP Headers
			Relational DBs
			dbm files
			Code Snippets
			Apache::* modules
		* III Maintainance
			Controlling & Monitoring
			ISPs & Virt Hosts
			OS & Hardware
			Protecting the Site
		* IV Advanced Setup and Performance
			Choosing the Right Strategy
			Real World Scenarios
			Performance Tuning
		* V Troubleshooting
			Frequent problems
			Warnings and Errors index
			Debugging
			Browser-workarounds
			Getting Help & Further Learing
		* VI Miscellaneous
			Advocacy
			Appendix A: Downloading SW
		
	Win32 Platforms
		(OK)
	mod_perl FAQs
		mod_perl - Embed a Perl interpreter in the Apache HTTP server
		Frequent Asked Questions
		First steps
		Runnig CGIs under mod_perl
		traps
		Apache API
		performance tuning
		Perl Myths
		MethodHandlers
		access to CVS dev tree
	API
		(OK)
	* 2.x
	User Guide
		(OK)
	API
		(OK)
	Dev Guide
		(OK)
	related tutorials
		Choosing a Templating System
	* Offsite resources
		Books
		Articles in print and Online Media
Getting Help
	mod_perl training
	Commercial Support
	ISPs Supporting mod_perl
	Site Help
Mailing Lists
	Mailing List Guidlines
	A bunch of lists
Products
	The Apache/Perl Module List
	Application Servers & Toolkits
	mod_perl Related SW
Contribute
	.. Mailing List
	.. Documentation
	.. Sharing Code


Now, lets move around some docs:
(Nota Bene: I'm not sure if all of the stuff I move out of 1.x is correct for 2.x ... Maybe
stating somewhere that all of the docs here assume mod_perl 1.x unless otherwise stated would
be a good idea)
(There's a new structure diagram following, so you don't have to keep track
of all the moves :-)

- Split download::source into stable_source and cvs, replace the cvs-section of download::source
with faq::mod_perl_cvs

- Rearrange the Docs main sections to:
  * General documentation
  * Tutorials (or maybe "Tips & Tricks" would be a better name..)
  * mod_perl 1.x Documentation
  * mod_perl 2.x Documentation
  * Other Documentation Resources

- Move to "General docs":
  * 1.x::guide::Perl_Reference
  * 1.x::guide::ISPs
  * 1.x::guide::Controlling_Monitoring
  * 1.x::guide::OS_Hardware
  * 1.x::guide::Advocacy
  * 1.x::guide::cgi_to_mod_perl_porting (?? not sure with this)
  * 1.x::faq::perl_myths
  * 1.x::faq::faq

- Move to "Tutorials":
  * 1.x::guide::HTTP_Headers
  * 1.x::guide::RDBMs
  * 1.x::guide::dbm_files
  * 1.x::guide::code_snippets (should maybe stay in mod_perl 1.x ?)
  * 1.x::guide::security (although it should be renamed to "Using Authentification to protect
your site" or something ..)
  * 1.x::guide::performance_tuning
  * 1.x::faq::performance_tuning
  * 1.x::guide::browers_bugs
  * 2.x::guide::tutorial::templating


- Delete:
  * 1.x::guide::Frequent_problems (contains only to links to problems answered somewhere else)
  * 1.x::guide::overview (or rewrite it to fit new structure)
  * 1.x::guide::introduction (but credits and some content (mod_cgi,..) somewher else (maybe
make a new page, "contributors", or "people behind mod_perl"..))
  * 1.x::faq::mod_perl (this is just a very condensed version of the site)
  * 1.x::faq::cgi_to_mod_perl (redundant)
  * 1.x::faq::mod_perl_cgi (redundant)
  * 1.x::faq::traps (redundant)
  * 1.x::faq::API (redundant)

- Move 1.x::guide::AppendixA to a new section in download "Download additional, usefull SW"
or something

- Split up guide::getting_help_further_reading to "mailing lists", "offsite resources" and
"getting help"

# Future Structure: 
###################
Technologie Extraordinaire
	Sites Running mod_perl
	Success Stories
	Statistics
Download
	Stable source mod_perl distributions
	Binary mod_perl disributions
	Software Bundles
	Access to CVS
	Documentation
	Download additional, usefull SW
Documentation
	General documentation
		mod_perl FAQ
		Perl Reference
		ISPs & Virt Hosts
		OS & Hardware
		Controlling & Monitoring
		Advocacy
		cgi to mod_perl porting
		Perl Myths
	Tutorials
		HTTP Headers		
		Relational DBs
		dbm files
		Code Snippets
		Protecting the Site [new name?]
		Performance Tuning (guide)
		Performance Tuning (faq)
		Browser-workarounds
		MethodHandlers
		Choosing a Templating System
	mod_perl 1.x
		Getting Feet Wet
		Installation
		Configuration
		Advanced Config: Choosing the Right Strategy
		Advanced Conifg: Real World Scenarios [new name? Implementation]
		Warnings and Errors index
		Debugging
		Apache::* modules
	mod_perl 2.x
		User Guide
		API
		Dev Guide
	Win32 Platforms
	Offsite resources
		Books
		Articles in print and Online Media
Getting Help
	How to report Problems 
	mod_perl training
	Commercial Support
	ISPs Supporting mod_perl
	Site Help
Mailing Lists
	Mailing List Guidlines
	A bunch of lists
	Some more lists
Products
	The Apache/Perl Module List
	Application Servers & Toolkits
	mod_perl Related SW
Contribute
	.. Mailing List
	.. Documentation
	.. Sharing Code


So, what do you think? I'll just drop into my bed now, it's waaay to late.. 

-- 
 D_OMM      +---->  http://domm.zsi.at <-----+
 O_xyderkes |       neu:  Arbeitsplatz       |   
 M_echanen  | http://domm.zsi.at/d/d162.html |
 M_asteuei  +--------------------------------+



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Mime
View raw message