(old)Puppy Linux Discussion Forum

Posted: **Sat 19 Nov 2005, 06:15**

Welcome!

So happy to meet everyone here

We'll be discussing everything about puppy docs

Some general info:

Please add your docs to http://puppylinux.org/docs/pre
Just click the Login link (see left column) to start editing. Password: pldp
You can use this sandbox page to practice your editing skills.

When the documentation is almost finished the whole site will be moved to http://puppylinux.org/docs and continue to be maintained by the documentation committee.

To create a new page, just edit any existing page and add the name of your new page at the end. Then, highlight that newly added line and click the H1 button (for sub-menu click H2 or H3). Finally click the 'save' button (the floppy icon) and the link to your new page will appear in the left pane. Multiple pages can be created at one time using this method. To delete a page, edit it and delete everything in it, then click 'save'. Must read:
User's Manual
Creating your pages
How to do common task
Writing your first pages

And here's the tree structure.

Btw please use this template to write your page

http://puppylinux.org/docs/pre/?TEMPLATE

Posted: **Sun 20 Nov 2005, 23:50**

Great work, Puppian! As soon as the CMS decision is taken, we can also begin testing the installation.

(Note: "we" is a way of speaking - it means "you with some help from us"

)

Posted: **Mon 28 Nov 2005, 04:11**

Well, it looks like now we're contributing to http://puppylinux.org/docs/ instead of using the preview site.

Posted: **Mon 28 Nov 2005, 15:22**

Below is the understanding so far. Hope it helps

As to the link to /docs, it seems that the way cmsimple manage docs is more flexible and easy to navigate. Everything is in one large file which can be downloaded for offline viewing and can be converted to pdf file easily. So we can have it there for people to who want to view html online, and when the docs are almost finished, we can also convert it to pdf, and put a link in the 'Downloads' section for people to download it (just like what the php-fusion website did themselves), and could have version updates too (e.g. docsPuppy105.pdf, docsPuppy109.pdf, etc). This way different people who prefer different formats would be happy

The 'Articles' section at /docs/pup can be kept simple, mainly for stuff like handbook, mini-howto and quick guides So cmsimple would be for official stable docs only, while php-fusion will have everything else (btw will try to make the cmsimple theme looks more like the php-fusion one)

In fact some other linux distros are using standards like docbook xml to manage their docs (which are more complex and takes much more time to manage), but as our docs project is just a start (still an infant ), I guess it's best to keep it simple now.

So just continue your initial writings for pldp at http://puppylinux.org/docs/pre , and when the docs are almost finished they will be moved to http://puppylinux.org/docs/

PS. raffy has done some really great editing to /docs/pup, take a look!

Posted: **Tue 29 Nov 2005, 17:51**

Ok, so can someone provide a diffinative answer.

Are we using /docs or /docs/pre?

I personally think it makes sense to use /docs and just work there in the main area. That way it is more incentive to be quick, efficient and accurate. But I will take my ques from you folks who are by far the more senior puppies.

Me, I'm just a baby puppy.

Posted: **Tue 29 Nov 2005, 18:08**

Maybe I should have written it this way

So just continue your initial writings for pldp at http://puppylinux.org/docs/pre, and finished pages will be moved to http://puppylinux.org/docs/

docs/pre is used for initial writings, for example, sometimes I can't finish a whole page, but just half of it, and it's better to leave it at docs/pre, so our new puppy user won't see a halfly finished page (which may also contain incorrect information since proofreading hasn't been done yet)

Also, docs/pre is accessible by everyone and so we can have contributions from different people, which can be then proofread by the docs committee

Posted: **Tue 29 Nov 2005, 18:40**

Thanks Puppian;

That makes it very clear to me, it makes sense too.

(old)Puppy Linux Discussion Forum

Welcome

Welcome

Great!