Porteus Documentation--Development and Process

[Ahau]

At the suggestion of francois, I'm opening a thread here, primarily for members of the Doc Team, to coordinate our efforts in creating and updating documentation for Porteus.

Presently, the members of the Doc team are:

Ahau
captain_picard
82issa
francois

We can discuss our goals and objectives here, how we go about creating and updating documents, split up jobs, etc.

I feel that we should be responsive to the documentation requests of the community (anyone can post requests for documentation to this thread), proofread and edit, as well as update, all documentation on the main website, proactively search for things that should be documented (or have better documentation), and post community entries to the "HOWTO" section of the forum to the main website.

Our biggest project coming up will be updating and proofreading all documentation on the main site, one week in advance of the release of V1.0 final. I would like a week's notice from fanthom and brokenman (if possible -- development drives documentation, not the other way around!), prior to final release. At this point, we will need to review all docs and video tutorials on the main site, to make sure they are compliant with the latest release canditate for V1.0, and make any changes/updates necessary.

Thanks for all of your help! Please post your thoughts and ideas!

[82issa]

Thanks for taking the reigns on this one, it will be nice to have some structure. Love you well defined goals, for the doc team.

[Hamza]

There is a similar thread : "The Porteus Teams"

@ Ahau
This thread is not in the right place , please , move it in General Chat.

Regards,

[fanthom]

@The Doc Team
very good initiative - i'm not native eng speaking person and i really appreciate the help with creating/maintaining docs by you

we are very close to 1.0 - will try to give you a notice as soon as we know the release date.

@Hamza
i would leave it here as documentation is also a part (very important) of development process.

Cheers

[Hamza]

@fanthom,

I understand , sorry.

@ The DOC Team,

Sorry about my warn.

[Ahau]

No Problem, Hamza!

[francois]

@Ahau:

Thanks for starting this thread. I am about to increase significantly (by more than 5% ) the text on wikipedia about Porteus (operating system). I will use this thread to ask for proof reading and additional suggestions, though anyone can modify the text directly. The next modifications should be out by tomorrow. If any one as any ideas to get Porteus as hyperlinked on wikipedia as possible this would be great.

[brokenman]

You are welcome to use any info from this porteus wiki page.

It has the ability to divide the wiki into categories. Here is the installation category.
http://code.google.com/p/porteus/wiki/Installation

[fanthom]

i have a proposition for adding one short txt file to the ISO in the main / (root) folder. it would be like: /boot, /porteus and USB-INSTALLATION.txt.

Reasons:
- some fresh members may think that Porteus is a CD version only (citation from Distrowatch: "Porteus, a logical continuation of the Slax project, is a Slackware-based live CD...")
- we dont provide tar.gz version for USB, just ISO's
- Ahau's /boot/docs/installation.txt guide is great but may be a long lecture for experienced users

This is what i would like to see in the USB-INSTALLATION.txt:
"To install Porteus on USB stick just unpack /boot and /porteus folders from the ISO to it then launch /boot/win_start_here.hta (Windows) or lin_start_here.sh (Linux) and follow instructions
more detailed info can be found in /boot/docs/installation.txt file"

(text above needs some polishing)

Do we need it?

[Hamza]

@fanthom,

That's a good idea. And, may be , we can includ Porteus in UNetBootin.

[Ahau]

I like it.

Code: Select all

To install Porteus on a USB drive just copy the /boot and /porteus folders from the ISO to your USB drive, then launch /boot/win_start_here.hta (Windows) or /boot/lin_start_here.sh (Linux) and follow the instructions.  More detailed info can be found at /boot/docs/install.txt

How's that?

[brokenman]

Very good.

Since we only offer an ISO it may be good to offer advice on how to extract or mount the ISO to access the files inside. For windows 7zip can extract and cdEmu can mount the ISO.

http://code.google.com/p/porteus/wiki/Installation

[Hamza]

Wow!

That is a good idea for extract , is it possible to extract where the user want ?

[Ahau]

Code: Select all

To install Porteus on a USB drive just extract or mount the porteus ISO (Windows users can use 7-zip or cdEmu for this), copy the /boot and /porteus folders from the ISO to your USB drive, then launch /boot/win_start_here.hta (Windows) or /boot/lin_start_here.sh (Linux) and follow the instructions.  More detailed info can be found at /boot/docs/install.txt

How dat?

EDIT:

Per fanthom's request, here's another version:

Code: Select all

To install Porteus on a USB drive just extract or mount the porteus ISO (Windows users can use 7-zip or cdEmu for this), copy the /boot and /porteus folders from the ISO to your USB drive, then launch /boot/win_start_here.hta (Windows) or /boot/lin_start_here.sh (Linux) and follow the instructions. 
Porteus can also be installed to your hard drive -- see the Installation Methods section on our forum, at https://porteus.org/forum/viewforum.php?f=62

More detailed info can be found at /boot/docs/install.txt

[Hamza]

@Ahau,

I like this last text. Great Job.