Re: [Perfparse-devel-int] Re: PP Docs

[Yves M. <yme...@li...>]

> I note parts of the same document in the wiki system.  This worries me
> because the xml version in the package is editable, and I presume the
> wiki version as well.  One only must be master...
>
> In the same way there is other documentation on the sf.net project page=
.
>   So we have four sources of documentation:
>    -  http://sourceforge.net/projects/perfparse

That one should be removed (the contents moved to somewhere else)

>    -  http://perfparse.sf.net  (=3D=3D http://www.perfparse.org)

That one is a mirror of /doc in distribution. This is not the master.

>    -  http://wiki.perfparse.org
>    -  /doc in distribution.

The 2 last ones are masters and have to be for a little while.
Here is my idea :
1/ have the wiki with some documentation growing and growing
2/ take the doc from the wiki and put it in docbook format, for homogenei=
ty. Remove that
doc from the wiki to avoid duplicates and redundancy.
3/ docbook files should generate at least html files that you can see on =
the web site.
4/ Have a special section "comments about the official doc"; Keep an eye =
on it to
improve the doc. Maybe that section is the FAQ ?



> (http://wiki.perfparse.org/ is now working and looking very good, thank=
s
> Flo.)

yes, very good job, Flo :)

> We need something better which includes the tiki sections and fixed
> documentation.  Can I suggest a new menu for the main site which
> reflects all the document sources.

Yes for the menu, with minor changes ...

> (This is descriptive only.  Actual URI may differ.)
>
> Menu Option			URI
> ----------------------------------------------------------
> Install Guide		http://perfparse.sf.net/install_guilde.html
> Source: doc/install_guide.docbook.html

Source is xml :)

> Readme			Not on site.
> Source: doc/introduction.docbook.html

No, this should be http://perfparse.sourceforge.net/about.php

> Introduction (new)	http://perfparse.sf.net/introduction.html
> Source: doc/README

Keep it in the wiki for a while as the source. Then make that document in=
 docbook format.

> FAQ			http://wiki.perfparse.org/faq
> Copied from: http://perfparse.sf.net/faq.html

(and remove faq.html)

> Specifications		http://wiki.perfparse.org/??

Say "Specs and drafts (developers only)" instead of "Specifications" :)

> Any other ideas?
>
> As a final point, we have five locations of html:
>
> perfparse.cgi
> perfparse.php
> http://perfparse.sf.net  (=3D=3D http://www.perfparse.org)
> http://wiki.perfparse.org
> http://sourceforge.net/projects/perfparse
>
> This product overlaps local CGI and true Internet.  Such applications
> and documentation should have consistent html, therefore it all looks
> like the same project.
>
> Some time we will have to look into a consistent look to all of these,
> where possible.  A single style sheet for instance might be an excellen=
t
> start?

CSS ? :)


--=20
- Homepage    - http://ymettier.free.fr - http://www.logicacmg.com -
- GPG key     - http://ymettier.free.fr/gpg.txt                    -
- Maitretarot - http://www.nongnu.org/maitretarot/                 -
- Perfparse   - http://perfparse.sf.net/                           -