Page 1 of 2

Puppy Linux Documentation Project (PLDP)

Posted: Sat 05 Nov 2005, 14:58
by puppian
After much discussion,
http://www.murga.org/~puppy/viewtopic.php?t=3210&
http://www.murga.org/~puppy/viewtopic.php?t=3120&
http://www.murga.org/~puppy/viewtopic.php?t=2669&
http://www.murga.org/~puppy/viewtopic.php?t=2912&
http://www.goosee.com/puppy/wikka/PuppyDocumentation

I think it's time for us to get going with our Puppy Linux Documentation Project (PLDP) :)

Here is the proposed tree (probably incomplete :oops:):
http://puppylinux.org/docs/pre/?&sitemap

Volunteers please choose which section(s) you would like to oversee. To join the committee please add your name to this page.

I think PLDP should be installed in its own directory (like the ./doc folder above) apart from the main site (test site here) as CMSimple stores all pages in one file and it's not preferable if that file is too big (may get slow). Seperate installations will avoid the risk of messing up the settings, etc, of the main site when editing the docs too.

I suggest setting up the main site at puppylinux.org first. With the documentation committee adding docs to the documentation test site gradually and when it's almost finished, articles can be moved to a directory of puppylinux.org (moving should be easy as everything is in one file which can be downloaded from the setting page). And a link to it can then be put on the main site.

The main site could be overseen by Barry, raffy, Lobster, and maybe other foundation members. More advance topics on the doc site (e.g, Compiling Applications, Kernel and Drivers, etc) would probably need Barry's overseeing as well.

To try editing with CMSimple you can go to this sandbox page (password: pldp)
http://puppylinux.org/docs/pre/?SANDBOX
Click "Normal Mode" and "Edit Mode" to toggle between viewing and editing. Click the buttom "HTML" to toggle between layout mode and html mode. Click the top left floppy button to save a page. Please see the attached pic.
You can also do your editing in editors like Mozilla Composer and NVU and then copy and paste things back to CMSimple (don't use Abiword).

To try other CMS:
http://www.murga.org/~puppy/viewtopic.php?t=3339

Btw I think each foundation members/committee may have a small website with its own layout using the method raffy suggests here (perhaps with large files upload disable to conserve bandwidth).

yes

Posted: Sat 05 Nov 2005, 19:19
by klhrevolutionist
Very good puppian.
I have already taken a step to doing something similar.
Creating How To dotpups. I have only made three so far.
But they are ver detailed. While I told you about this on the other forum,
I have been looking at the how to section of the forum.
The How To needs to be for end-user's, developer's should really
in my opinion have their own section locked, and only avail to developer's to post.

The how to's that I have posted as dotpup's are straight forward,
only lazy people would not understand them.

Docs at Puppylinux.org ready

Posted: Sun 06 Nov 2005, 06:04
by raffy
Great work there, Puppian! FYI, i have moved the docs folder to puppylinux.org.

http://puppylinux.org/docs

The docs is driven by CMSimple and maintained by Puppian. Take note of the practice pages that he pointed out:

http://stet-vip.net/puppian/cmsimple

Members who would like to contribute and also keep pages that they developed can begin writing there (in the practice site), or request/use their own (member's) folder at puppylinux.org (or using another, owned site), then just paste the finished HTML page in CMSimple (Puppian will have more to say about the useful procedure here). Another way to draft documents is through the Wiki.

Don't worry about redundancy (identical page in two or more sites), that is part of enhancing reliability. What is important is we keep the docs as updated as possible, with links to related pages (wherever those pages may be).

If you want to check out the feel of member's webpages, it's here.

Posted: Sun 06 Nov 2005, 10:32
by puppian
raffy wrote:Great work there, Puppian! FYI, i have moved the docs folder to puppylinux.org.

http://puppylinux.org/docs
Thanks for moving the files from stet-vip.net/puppian/doc to puppylinux.org/docs, raffy.
But no, I think an installation shouldn't be moved like that as things will be broken. When I login now, this is what I see
WARNING

* Could not write to log ./cmsimple/log.txt
* Not writeable log /mounted-storage/home7/sub003/sc14300-FRIH/puppylinux/docs/cmsimple/log.txt
* Not writeable configuration /mounted-storage/home7/sub003/sc14300-FRIH/puppylinux/docs/cmsimple/config.php
* Not writeable language /mounted-storage/home7/sub003/sc14300-FRIH/puppylinux/docs/cmsimple/languages/en.php
* Not writeable stylesheet /mounted-storage/home7/sub003/sc14300-FRIH/puppylinux/docs/templates/default/stylesheet.css
........
......etc.

That's probably a file/folder permission problem, but some other paths/settings may have been broken as well. I prefer a fresh installation of CMSimple at puppylinux.org/docs and set it up from scratch. I can't fix the problem above as I don't have true ftp access at puppylinux.org
Raffy wrote in his pm:
. . .
The ftp tool you may use for now at puppylinux.org is XXXX.php

puppylinux.org/docs/XXXX.php
. . .
The 'ftp tool' raffy mentioned is actually a webpage for uploading one file each time from the browser. And one can't change file permission (e.g, chmod 755, etc) from there. It would be extremely inconvenient and not enough for someone who's maintaining a website. I don't want to upload one file each time (CMSimple is small in size, but it has LOTS of files, even installing just one template/addon/plugin will need to upload MANY files) and has to send someone a pm just to change the permission of one file/folder.

. . . . .
raffy wrote:Members who would like to contribute and also keep pages that they developed can begin writing there (in the practice site), or request/use their own (member's) folder at puppylinux.org (or using another, owned site), then just paste the finished HTML page in CMSimple (Puppian will have more to say about the useful procedure here). Another way to draft documents is through the Wiki.
I think we can have around seven to ten documentation committee members each overseeing different section of PLDP, with other contributors submitting content to them (e.g by email, pm, etc) if needed. The documentation committee will have the CMSimple password needed to edit the pages at puppylinux.org/docs. There's no need for them to write the docs in other places first. As they are the experts about the topics they oversee, we can trust them publishing at puppylinux.org/docs. And they won't be able to mess up with the main site at http://puppylinux.org as there will be a seperate CMSimple installation there.

IMO the 'member's webpages' you suggested can be used for the foundation member's own homepage (not for documentation purpose), so that people will know them more. It's not a good idea to host websites for all puppy users as that'll make puppy a 'free hosting service provider'.
Btw, I think wiki is for most update info. with broad interests & various user's input while PLDP is more reliable (as raffy said), organized and finalized.

Permissions

Posted: Sun 06 Nov 2005, 12:52
by raffy
Looks like a permissions problem, as anticipated. No hurry, though, as we're just preparing the puppylinux.org site. You still have unimpeded access to stet-vip.net, so testing and initial writing can go on, as you suggested.
I suggest setting up the main site at puppylinux.org first. With the documentation committee adding docs to the documentation test site gradually and when it's almost finished, articles can be moved to a directory of puppylinux.org (moving should be easy as everything is in one file which can be downloaded from the setting page). And a link to it can then be put at the main site.

The main site could be overseen by Barry, raffy, Lobster and other foundation members. More advance topics on the doc site (e.g, Compiling Applications, Kernel and Drivers, etc) would probably need Barry's overseeing as well.

To try editing with CMSimple you can go to this test page (password: fans)
http://stet-vip.net/puppian/cmsimple/?Test_Page_One
As to "difficult for both of us", I now have root access. If I give you the same access and then make a mistake, you will be taking the blame, too. So be patient for now, we will have an access plan in due time.

As to being webmaster, you are already one - and a prolific one at that :) We've already gone through CMS identification and are now getting into colors - the details, really. I guess the redirection to puppylinux.org/docs seemed to have jumped the process a bit, but you can remove that easily. :oops:

Let's stick to your suggestion of starting to write pages and work out the transfer to the site next.

PS - As to your opinions about CMS and members' website - they are all CMS's, ranging from simple to complex, but you are entitled to your own opinion, of course. Just let me clarify that when I use the term "member", I mean "active contributor", not every user.

Re: Permissions

Posted: Mon 07 Nov 2005, 09:30
by puppian
raffy wrote:As to "difficult for both of us", I now have root access. If I give you the same access and then make a mistake, you will be taking the blame, too.
Thanks for the explanation. Now I understand your concern.

I don't think that's very important however.
We have more than one admininstrator and more than one moderator in this forum. Obviously we're going to have more than one person in our documentation committee too.

When things go wrong, usually people will complain, and the person who has made a mistake will come out and admit it (I think this happened before in this forum too). Sharing of rights/access/responsibilies are needed as long as we want the benefits of team-work.

FTP access

Posted: Mon 07 Nov 2005, 22:58
by raffy
You just got your FTP account from Barry - congrats! (Or, rather, "best wishes for the challenging work ahead" :wink: )

Posted: Tue 08 Nov 2005, 02:29
by Flash
You guys sure you wouldn't like to have a PLDP Usergroup in the forum? Anyone could read but only the group members could post to it.

Re: FTP access

Posted: Tue 08 Nov 2005, 10:19
by puppian
raffy wrote:You just got your FTP account from Barry
Yes, I received you pm with the ftp login information.
Thank you for your pm to Barry requesting that new FTP user account which allows access to the /docs folder.

Posted: Sat 12 Nov 2005, 12:44
by puppian
Flash wrote:You guys sure you wouldn't like to have a PLDP Usergroup in the forum? Anyone could read but only the group members could post to it.
Yes please :) I have asked the opinion of the other documentation committee members and they would like to have a discussion place for PLDP (Documentation forum section) so that off topic stuff can be sorted out and we can be focused on the project. Some of them also think we'd better start it now while the structure is being set up as we don't want to start something and have to scrap the time and effort for something else :)

For people who want to know more here is a link:
http://www.phpbb.com/kb/article.php?article_id=16

Posted: Sat 12 Nov 2005, 12:55
by puppian
Contributors and documentation committee members can now start writing at the preparation site here:

http://puppylinux.org/docs/pre

Anyone can contribute. Just click the Login link (see left pan) to start. Password: pldp

When the documentation is almost finished the whole site will be moved to http://puppylinux.org/docs and be maintained by the documentation committee. To join the committee please add your name to this page.

The whole documentation can be downloaded for offline viewing. Link

Posted: Mon 14 Nov 2005, 17:07
by puppian
Some updates:

J_Rey and Seth have proposed some great modifications to the tree structure and puppylinux.org/docs/pre has been ammended accordingly.

Brad_chuck would be overseeing the "troubleshooting" and "create a custom puppy" sections, J_Rey would be overseeing the "installation" sections and I would be overseeing part of the "getting started" section :)

Posted: Fri 18 Nov 2005, 16:05
by puppian
Brad_chuck has written some very nice stuff here 8)
http://puppylinux.org/docs/pre/?Trouble ... l_Problems

The ability to convert the pages to pdf has been added to http://puppylinux.org/docs/pre. Just click the 'PDF' link on the left (somewhere near the login link) to try it.
Some pages won't convert in Puppy however (but ok in Windows; using Puppy103, probably something to do with puppy's pdf viewer). I can't get the whole docs to convert too...hope it can be solved soon.

efforts are very much appreciated

Posted: Tue 22 Nov 2005, 10:01
by Lobster
8) Great work from the whole team. I am not sure who is doing all the work? It seems Raffy, Jrey and Puppian? The new blog is great. Communication is a key issue. I really am trying to understand what is being done and where . . .

:)

This will be clearer after the weekend Doc party.
People can now focus on their areas of interest. Please include the flash vids in your documentation

Just really came to encourage those involved. We are moving towards a more egalitarian and sharing Puppy. Please know that everyones times and efforts are very much appreciated. That does not get said enough. I know egos are fragile and text does not communicate sufficient goodwill. Goodwill and Buddhist prayers to you all.

OM YA HA HUM
(translation: Woof! woof!)

Posted: Mon 05 Dec 2005, 19:55
by puppian

Posted: Sun 18 Dec 2005, 00:23
by Ian
I am doing something wrong, I cannot paste anything into any of the pages.
When I right click on the page there is no paste option in the dropdown menu and clicking on the paste icon does nothing.

I would rather compose the data first then paste it than have to be on line while entering data.

Posted: Sun 18 Dec 2005, 00:33
by MU
Ian, do you know the "X"-way of pasting?

Select some text with the mouse.
Then click with the middle mousebutton, where it shall be pasted.

This is supported by most applications for the X-Window-System,even if they have no "paste"-icons.

Mark

Posted: Sun 18 Dec 2005, 01:40
by J_Rey
Don't forget that you might need to have Xclipboard open in the background for Cut, Copy & Paste to work between some applications.

The standard Linux (i.e. non-Windows) keyboard shortcut for Cut is Shift-Delete and for Paste is Shift-Insert. I'm not sure what Copy is but one can Cut then immediately Paste after to have the same effect. BTW Rarsa told me about Shift-Insert in the IRC channel and I figured out the Cut shortcut after.

On the topic of keyboard shortcuts, Shift-Page Up scrolls up/back in console mode/CLI and AFAIK Scroll Lock pauses the text in console mode. Which is helpful for reading boot messages or the like.

Posted: Sun 18 Dec 2005, 01:58
by Ian
Thanks men,
Mark the middle button trick works, I forgot the scroll wheel was the middle button am used to three buttons.

J thanks for the tips.

I can now spend time putting stuff together for the PLDP pre pages and just paste them in.

Posted: Sat 04 Mar 2006, 16:28
by puppian
Just a quick note. A few pages have been updated :D
Take a look.