Bug 234077

Summary:	webapp-config man page does not explain how to set up a web project
Product:	Documentation	Reporter:	Raphael Mankin <raph>
Component:	Other	Assignee:	Gentoo Web Application Packages Maintainers <web-apps>
Status:	CONFIRMED ---
Severity:	enhancement	CC:	binki, n-roeser, web-apps
Priority:	Normal
Version:	unspecified
Hardware:	All
OS:	Linux
Whiteboard:
Package list:		Runtime testing required:	---

Description Raphael Mankin 2008-08-06 11:47:35 UTC

I was looking to use webapp-config to manage my web apps, but could not work out how to do it. The man page explains how to use webapp-config iteself, but it does not explain how to set up a project in a form suitable for webapp-config to manage. I have looked in Sourceforge, but that does not appear to contain anything useful, either.

Specifically:
1. The man page speaks of different permissions for various classes of files but does not explain how those classes are identified,  where they are to be put in the master copy, nor where they will be installed, e.g. config files, cgi scripts

2.What is the structure of a master copy? Explain the use of the conf, hooks, hostroot, htdocs and sqlscripts directories and sub-directories, which I see in projects under /usr/share/webapps.

Reproducible: Always

Comment 1 Peter Volkov (RETIRED) gentoo-dev

2009-02-04 17:32:24 UTC

Man page for program should document program usage and that is what webapp-config manual page does. How to prepare files to be used by webapp-config is covered by webapp.eclass documentation:

http://www.gentoo.org/proj/en/webapps/webapp-eclass.xml

Some general ideas could be found here:
http://www.gentoo.org/proj/en/glep/glep-0011.html

If you need deeper explanation I think we don't have anything beside sources. Probably this is good place for improvement but... currently there are too many other areas where webapp-config needs some love. We really need somebody to maintain this package...

Comment 2 Anthony Basile gentoo-dev

2011-12-30 17:03:27 UTC

(In reply to comment #1)
> currently there are too many
> other areas where webapp-config needs some love. We really need somebody to
> maintain this package...

I'm going to try.  I would appreciate any help its in bad shape.

Comment 3 Anthony Basile gentoo-dev

2013-08-03 14:58:19 UTC

do you want to think about adding some documentation to 

   http://www.gentoo.org/proj/en/webapps/webapp-eclass.xml

to address comment 0