Re: [Phpwebsite-developers] 1.x Documentation

[Greg M. <drk...@co...>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Gregory Meiste wrote:
> A few quick thoughts:
> 
> I thought "Fallout" was our code name for phpWebSite code still in
> development and that it was not specific to the 1.x code.  For
> example, phpWebSite 2.0 would be called Fallout when it is in
> development. (when can we expect this Matt?  ;-)
> 
> If that's true, should the wiki page really be called:
> http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=Fallout

This page will always be a quick and dirty how to install fallout page
regardless of the version.  It can be updated to 2.x whenever that
happens.  Perhaps the idea will be clear when you look at the bottom of
the install page
http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=Installation_Guide#Other_Installations
.  The installation type is called Beta Version Installations i.e.
[[fallout | Beta Version Installations]].  It will always be the fallout
page.

Here's the sample seed page for the 1.x version
http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=En_database.
 Note mediawiki initcaps the title but you can still reference the page
as en_database or "en database" without the quotes.  Note that the
existing 0.9.x to 0.10.x will still be available here as
http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=Database_Configuration
.  I will borrow heavily from Database Configuration to add to the 1.x
en database page.

Note that the French page would be fr database.  That way the
application code won't have to worry about the using fr le database, etc.

> 
> Also, before we start putting links to the wiki in 1.x code, should we
> decide if we were sticking with Mediawiki or if we were finally going
> to change to the wiki module for phpwebsite?  The more places we put
> links to the wiki now, the more we will have to change if we ever
> convert the wiki in the future.

I recommended that the phpWebSite code use a constant of
http://phpwebsite-comm.sourceforge.net/wiki/index.php?title= in one
place.  Hopefully the en_database name would be unchanged regardless of
the wiki engine used.  If the wiki changes to, say,
"http://phpwebsite.sf.net/wiki/index.php?title=" then just one location
in the code has to change.  The URL constant and the desired page are
concatenated to form the wiki link.

Guys I am fired up and ready to go for the 1.x release.  After I made
the fallout page last Sunday, I realized how close it was to consider
release issues.  I don't plan to update the existing pages for 0.10.x.
I really want to have documentation ready for the users by the time the
final 1.x release candidate hits the streets.  I believe I can have a
working en_* system by the end of this weekend.  Blindman, I don't see
those people who want all of the dog food to be eaten contributing to
the dog food documentation while you are coding.  I seeded the page here
http://phpwebsite-comm.sourceforge.net/wiki/index.php?title=Wiki but no
one else is contributing.  Just as bitkeeper was used to fill a need
before git could self host the kernel or CVS was used until subversion
was ready, I want to use something now to get going on 1.x.  Again, the
fallout wiki page changed my course of action.  I don't plan on
answering many 0.10.x forum posts or create/edit any more 0.10.x wiki
pages.  Someone else needs to figure out the way of doing business with
the wiki engine, fatcat, and photoalbums.
> 
> Other than that, I like the idea of using the wiki as the
> documentation.  Much easier to keep up-to-date.
> 
Yep! Kind-of like giving users access to RoboHelp so that they can
change the F1 help key help documentation.

Greg
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org

iD8DBQFDawQpxyxe5L6mr7IRAqCnAJ0Z0SdYAmxPnAdUgMwbKmCNIp4nDQCfReya
001JSZjduYk3+LDyiPm11C4=
=PDeX
-----END PGP SIGNATURE-----