RE: [Plog-general] User Documentation

[Warren L. <wa...@is...>]

I have cygwin installed on windows.. Can use cmdline cvs, also all my
hosting servers are linux. I'll figure out what's easiest for me..

It would be easier to manage the layout of the document if we use
templates, but I don't see the need to include a templates folder in the
docs directory unless it is your intend that the docs can be moved
elsewhere without it being nested within a plog installation. I can
foresee some situations like that. What I will do is create a new CSS
for the documents, move it into plog_docs so that I can separate the top
menu from the content files and I need to make a side menu as well,
since I don't think we'll have space up top later on.

BTW once of my quirks is whenever I start something, although I don't
intend on being overtly ambitious, I try to ensure that the foundation
setup originally will allow me to scale ambitiously when the time comes,
so I take into consideration what potential problems might be
encountered when the time for growth comes and try to incorporate
measures into the foundation that will smooth those problems out as much
as possible even if the problems don't exist yet. That was what I am
trying to communicate across when referring to creating the definitive
document.

I have uploaded the latest copy of the docs to my site. Will be making
the changes once I get off work. 1 more meeting and I'm home free. Hate
it when clients are late..

Cheers
Warren

> -----Original Message-----
> From: plo...@li...
> [mailto:plo...@li...] On Behalf
> Of Oscar Renalias
> Sent: Tuesday, August 12, 2003 4:59 PM
> To: plo...@li...
> Subject: Re: [Plog-general] User Documentation
>
>
> Hi
>
> Regarding CVS...
>
> > Either that we can use CVS. No actual experience working
> with CVS with
> > write access though since pLog is the first open source
> effort that I
> > am actually contributing something to instead of just being a user.
> > Eventually it has to be moved to CVS anyway, I don't mind at all
> > learning to work with CVS at all.
>
> CVS is quite easy :) I've added you to the group of
> developers of the project
> so that you can have write access to the CVS tree. But be
> careful not to
> break the main tree! :D
>
> I have created a module for you, called "plog_docs". I can
> only explain you
> how to work with Linux... If you're working with a Windows machine,
> SourceForge recommends these two graphical CVS clients:
> http://tortoisecvs.sourceforge.net/ and
> http://cvsgui.sourceforge.net/index.html.
>
> First of all, from Linux, check out the module by doing this:
>
> $ export CVS_RSH=ssh1
> $ cvs -d:ext:you...@cv...:/cvsroot/plog checkout
> plog_docs
>
> Sourceforge needs SSH version 1, so "ssh1" should be a script located
> somewhere in the path with the following contents:
>
> #!/bin/sh
> ssh -1 $*
>
> (haven't found an easier way to do that...) It is also
> recommended to add the
> "export CVS_RSH=..." line to one of your shell initialization
> files in order
> to have it always available.
>
> Once you've done this, you should have a folder called
> "plog_docs" with a
> subfolder called "templates/" and a file inside, created by
> me. Feel free to
> remove those if you don't need them ;) After that, copy all
> your files to
> this newly created folder and run
>
> $ cvs add file1 file2 file3 ... (or even *)
> $ cvs commit
> ...
>
> The "add" command will add the files to the repository and
> the "commit"
> command will actually move them to the repository. Every time
> you make a
> change to a file and want to reflect that to the repository,
> you have to use
> the "commit" command.
>
> If you have files inside folders, you must first add the
> folder and then the
> files. You don't need to "commit" the folder but you need to
> "commit" the
> files:
>
> $ cvs add my_folder/
> $ cd my_folder/
> my_folder/$ cvs add my_file1 my_file2
> my_folder/$ cvs commit my_file1 my_file2
>
> Some time ago I wrote a very brief tutorial on CVS which I
> posted in the
> "Docs" section of the project page:
>
> http://sourceforge.net/docman/display_doc.php?docid=17713&grou
> p_id=83964
>
> SourceForge also has its own documents:
>
> http://sourceforge.net/docman/display_doc.php?docid=14033&grou
> p_id=1#top
>
> (I learnt from this one)
>
> Let me know if you're having problems with this.
>
> > On another note, my perception of this document is that it will
> > eventually develop to encompass both the user manual, developer
> > documentation, FAQ, changelog, etc... Might as well go all out and
> > create a definitive doc was my initial thought, since the
> layout and
> > templating is all there already, its only fill in the blanks mostly.
>
> Sounds like a good idea. But as with everything, let's try to
> start small and
> have something usable soon. Then, we can use that as the base
> to make an even
> better document.
>
> For the FAQ... I actually thought about using pLog to do it
> ;) Think about it,
> only by changing the templates a little bit we can have it
> display only the
> headline of the post (each post would represent a Q and A)
> Users could be
> able to leave their comments as well... But n the other hand,
> it's always
> good to have a static copy of the FAQ, so we might as well
> end up using both.
> In the meantime, go ahead and add a FAQ to the document if
> you feel like it,
> since developing that set of templates for a FAQ could take some time.
>
> > If you would like to get me on IM, I'm on yahoo, msn, icq,
> will email
> > the info if you want it.
>
> Yes please go ahead and send it. I'm not in msn that often,
> but it's good to
> have :)
>
> Regards,
>
> Oscar.
>
>
> -------------------------------------------------------
> This SF.Net email sponsored by: Free pre-built ASP.NET sites
> including Data Reports, E-commerce, Portals, and Forums are
> available now. Download today and enter to win an XBOX or
> Visual Studio .NET.
> http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet
_072303_01/01
_______________________________________________
Plog-general mailing list
Plo...@li...
https://lists.sourceforge.net/lists/listinfo/plog-general