Difference between revisions of "Talk:PC-BSD® Users Handbook"

Revision as of 23:11, 16 December 2010 (view source) Bebuxe (Talk | contribs) (reply to tigersharke) ← Older edit		Revision as of 06:09, 23 August 2012 (view source) Drulavigne (Talk | contribs) m (moved Talk:PC-BSD Users Handbook to Talk:PC-BSD® Users Handbook) Newer edit →
(22 intermediate revisions by 3 users not shown)
Line 1:		Line 1:
−	hi, any idea to break this page into smaller parts? like sub page?
−	I think that would be a good idea. Just haven't gotten to it yet. I did finish adding all the images today (4-17-09)	+	== Revised handbook structure ==
		+	Some of this has yet to be finalized, including shuffling of micro topics and sub-micro topics that do not get listed in the table of contents. Micro and sub-micro topics to be added. Key: {{highlight|Highlighted}} title changes, questions, and new topics. <s>Removed</s> or revised topics or titles.
−	>> great, I will test later (2009-04-18)	+	:Preface
−	>> *oops* I don't have any permission to create new page (2009-04-18)	+	:1. Introduction  {{highlight|<-- Example of Macro topic}}
−	please take a look @ http://wiki.pcbsd.org/index.php/PC-BSD_Users_Handbook#Supporting_PC-BSD	+	::1.1 PC-BSD's Goals and Features {{highlight|<-- Example of Topic}}
−	I've split it, if it's good enough, I will process the other page otherwise, I'll revert back	+	::1.2 What's New in 9.1
−	--------------	+
−	I have to say I don't care for the use of Wikis, especially for documentation. Can you tell who's writing what here for example?  It's all well and good to have users adding to documentation but it needs to be controlled and run through the same kind of approval process as code.  Not sure what sort of workflow/approval processes are available in Joomla, but in Drupal it's easy.  I'd recommend ditching the wiki concept and implementing documentation as a normal revision process within the CMS.  While I'm at it, I never understood the reason why mailing lists as a method of team communication still exist when forums are far superior.  Most of the PCBSD community doesn't participate in the mailing lists, and that's where a lot of great information is.  If they did participate, it would soon get completely out of hand and in-boxes would fill up with junk in short order.	+
−	As for this documentation wiki page, I didn't see anything get broken up.  It's still a very long page that takes forever to load if you don't have bandwidth.  You need to create separate URLs for each section.  Blogs invariably suffer from this same problem, but this is not a blog.  It's important to break into separate pages for other reasons as well: people need to make comments and ask questions (better done in a comment style, not a wiki) that are topic specific.	+	::1.3 PC-BSD Releases
−	...Jeff (May 18, 2009)	+	::1.4 PC-BSD for Linux Users
−	SUBJECT: RE: Handbook CMS	+	:2. Pre-Installation Tasks
−	TO: Jeff	+	::2.1 Hardware Requirements
−	FROM: [bebuxe | http://wiki.pcbsd.org/index.php/User:Bebuxe]	+	::2.2 Laptops
−	MESSAGE START:	+	::2.3 Partitioning the Hard Drive
−	Well, when we talked about doing the handbook and the pcbsd advocacy group, we decided to let the users have the ability to edit pages and write on them. And if anything looked too horrible we would email the user for clarification. Supposedly Dru Lavigne is in charged of the wiki, and what to manage and not. Josh holds the technical aspects of the wiki (the server's admin). And we did converse about using a cathedral model for adding content to the handbook, and other things, but we choose to use a bazaar method for this in particular, because we knew there would be new subjects and contexts of stuff users may come up that we have no creativity about, we decide to allow them the ability to publish it and make it known here. So we felt wiki was the best suited for this kind of mega upload of multiple content into multiple streams. Plus, knowing most of our users do not know much about programming or markup languages, we choose wiki, since its basic enough like a text editor (esp. for those that don't use markup at all). I was the primary promoter of using drupal, even pbwiki or phpbb. But after much debate on the user's knowledge base, resources, and motivation level, it looked like mediawiki was the best solution. But don't worry if some day you find all the pages gone wrong by a cracker, and many edits to do, Dru and others are making backups of articles submitted and edited (plus mediawiki keeps history and backups of all its edits). Plus, let's say all the current wiki writers die tomorrow, new users can still have the ability to edit and make things as the new version comes along. And if the user would like to learn the media wiki markup, they can do it for the betterment of themselves and everyone else here. That's why we have admins here to make sure if the user write garbage, they can edit it to sound coherent and valuable. You can join the Mod group if you like as well, just email Dru, Josh, or whomever is in charged of documentation (forgot his name, unless he left).	+	::2.4 Obtaining PC-BSD
−	PS	+	::2.5 Burning the Installation Media
−	If you didn't noticed, I just used the email format to reply to your questions. We can use this standard if you like, and make an en masse declaration to use this standard when talking about different subjects in the same discussion page with multiple subjects.	+
−	MESSAGE END:	+	::2.6 PC-BSD Live Mode
−	---------------	+	::2.7 Using VirtualBox
−	Can you explain the Runports concept a little better?  For example, if I install a port/package, do I have to run it using Runports(user) or not?  What's the diff?  If I have to, or it's advisable to, run a program using Runports, then shouldn't the menu command reflect that?  Maybe I'm not understanding the concept, but it seems to me it would have been preferable to make it so changing the PCBSD ports tree required Runports, rather than having to invoke it as a normal FreeBSD user.	+
−	....Jeff	+	:3. Installing PC-BSD
−	SUBJECT: RE: Runports	+	::3.1 Starting the PC-BSD Installation
−	TO: Jeff	+	::3.2 Language Selection Screen
−	FROM: [bebuxe | http://wiki.pcbsd.org/index.php/User:Bebuxe]	+	::3.3 Desktop Selection Screen
−	MESSAGE START:	+	::3.4 Disk Selection Screen
−	Well, that info is old and messy, and no longer partakes most of the actions done in 8.0. I am sure someone else can answer that you with detail and its purpose at the time. But for right now, I best advice you to read the freebsd handbook and the theoretics (sp) of [ports | http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html].	+	::3.5 Installation Progress Screen
−	What I got when I first read it that article, is that you also had the ability to run ports from the kmenu. And that if you wanted users to be able to run ports from the kmenu (kliker, whatever its called in kde), you can do so, but don't have to. An example would be if you want your guest users to be able to run the firefox port, so they would type in in the kmenu "firefox", and they would have it. But let's say you also have gnumeric from ports, and you want that only linked to your user account in kmenu, then you would set it up as such, and ensure that other users wouldn't be able use it in their settings for their access to kmenu. However, let's say you wanted to install an awesome daemon that fetches videos from youtube into your /usr/home/jeff/video/dump directory, renders it to a .mp4 file, emails you of the update, and starts making a backup of the mp4 to your portable player. Well for a daemon like that you really don't want run it the kmenu, but in the background as soon as it boots, but something like md5checksum you might want to run under Runports for your mp4. So I guess its a desktop configuration setting you decide.	+
−	MESSAGE END:	+	::3.6 Installation Finished Screen
−	----------------	+	:4. Post Installation Configuration <s>and Installation Troubleshooting</s>
−	-------------------	+
−	== Suggested addition ==	+	::4.1 Booting Into PC-BSD
−	I would suggest adding a humble moderation to this statement: Hardware such as video, sound, network and other devices are auto-detected and available at the first system startup.	+	::4.2 Language Screen
−	add: If recognised and a driver is available which in many instances isn't. Without a driver your device will not work.	+	::4.3 Time Zone Selection Screen
−	----	+	::4.4 Set Root Password Screen
−	Many of us have modified (possibly rather heavily) the appearance of application windows and/or desktop. It would be very helpful to know the values for the various specific appearance-affecting settings so that whatever we might update for screen shots stays consistent.	+
−	--[[User:Tigersharke|Tigersharke]] 02:02, 7 December 2010 (UTC)	+	::4.5 Create a User Screen
		+	::4.6 Connect to a Wireless Network
−	SUBJECT: RE: Default Desktop	+	::4.7 Post Install Finished Screen
−	TO: Tigersharke	+	::4.8 Logging In
−	FROM: [bebuxe | http://wiki.pcbsd.org/index.php/User:Bebuxe]	+	::<s>4.9 Installation Troubleshooting</s>
−	MESSAGE START:	+	:5. Advanced Installation Topics
−	Oh, like having set a standard for screen printouts for the average user to be able to cross reference on their desktop baceuse it has the same appereance. That sound like a good idea to implement. I think in KDE we have set up a default theme, and when you want to make a a toturial, you can change it as such. But to actually implement the standard of all the features and write them down to the smallest detail so that other users can replicate it if something went wrong with "default theme" .... mmmm.... quite a task.... I am not going to do it now, but any else is welcome. even replying to you or everyone here. but sounds good.	+	::5.1 Install PC-BSD Server Edition (TrueOS)
−	Hehehe, I knew there were going to be a lot of standards to implement for the wiki and the handbook, but its going to be lots of fun. I already said in the translation page we should also start implementing a stadard on keynotes or ques for the users (like mods) to review and the like. For example, when a the rest of a topic in an areticle is not finished, but its not obvious to the user at the first glance, the text, "[WIP]," can be placed, which note its is a "Work In Progress." Another one I thought(sp) up recently was [R], which stands for review, implying for someone else to read or test what is described and confirm it. It can be confirmed in the discussion page of the article, and stamped by the user with comments if needed. Then the user or the reviewer can do the edit with his summar. I know there will be more conventions to come, but for know we should first consider the making a of manual in here that deliniates all the schemes and conventions we will be using. Even a writing guide with lots of example (there may be one already in the making as i typed this, it s just i haven't checked).	+	::5.2 Dual Booting
−	But great suggestion. Someone here may answer that. (we may need a way to synchronize must of this info and updates in some sort of wiki page or rss sheet. I also don't mind the mailing list. Which reminds me... am I on the mailing list for documentation?	+	::5.3 Multiple Boot Environments
−	MESSAGE START:	+	::5.4 Upgrading PC-BSD
		+
		+	::5.5 Creating an Automated Installation with pc-sysinstall
		+
		+	:6. Desktops
		+
		+	::6.1 GNOME2
		+
		+	::6.2 KDE4
		+
		+	::6.3 LXDE
		+
		+	::6.4 XFCE4
		+
		+	::6.5 Awesome
		+
		+	::6.6 EvilWM
		+
		+	::6.7 Fluxbox
		+
		+	::6.8 FVWM
		+
		+	::6.9 i3
		+
		+	::6.10 IceWM
		+
		+	::6.11 Openbox
		+
		+	::6.12 Spectrwm
		+
		+	::6.13 WindowLab
		+
		+	::6.14 Window Maker
		+
		+	:<s>7. Installing Applications and Keeping PC-BSD Updated</s>
		+
		+	::<s>7.1 Using AppCafe® </s>
		+
		+	::<s>7.2 PBI Manager</s>
		+
		+	::<s>7.3 Update Manager</s>
		+
		+	::<s>7.4 Meta Package Manager</s>
		+
		+	:8. Control Panel
		+
		+	::... {{highlight|AppCafe{{r}}}}
		+
		+	::8.1 EasyPBI
		+
		+	::8.2 About
		+
		+	::8.3 AD & LDAP Configuration
		+
		+	::8.4 Hardware Compatibility
		+
		+	::8.5 GDM Configuration
		+
		+	::8.6 Service Manager
		+
		+	::8.7 System Manager
		+
		+	::8.8 User Manager
		+
		+	::8.9 Mount Tray
		+
		+	::8.10 Sound Configuration
		+
		+	::8.11 Display
		+
		+	::8.12 Printing
		+
		+	::8.13 Network Configuration
		+
		+	::8.14 Firewall Manager
		+
		+	::8.15 Life Preserver
		+
		+	::8.16 Warden®
		+
		+	::8.17 Thin Client  {{highlight|How is this control panel item enabled?}}
		+
		+	:9. Common Tasks
		+
		+	::9.1 Java, Flash, and Fonts
		+
		+	::9.2 Multimedia
		+
		+	::9.3 Files and File Sharing
		+
		+	::9.4 MythTV
		+
		+	::9.5 XBMC
		+
		+	::9.6 Windows Emulation
		+
		+	::9.7 Bluetooth Manager {{highlight|Is this a control panel or only a tray item? If there is a control panel entity then..}}
		+
		+	::9.7 Remote Desktop
		+
		+	::9.8 Security
		+
		+	:... {{highlight|Troubleshooting}}
		+
		+	::.. {{highlight|Installation}}
		+
		+	:... {{highlight|TrueOS}}
		+
		+	::.. {{highlight|Working from the commandline}}
		+
		+	:::. {{highlight|PBI Manager}}
		+
		+	:::. {{highlight|Update Manager}}
		+
		+	:::. {{highlight|Meta Package Manager}}
		+
		+	:::. {{highlight|(other pc-* commands)}}
		+
		+	:10. Finding Help
		+
		+	::10.1 PC-BSD Forums
		+
		+	::10.2 IRC Channel
		+
		+	::10.3 Mailing Lists
		+
		+	::10.4 FreeBSD {{highlight|documentation}} <s>Handbook and FAQ</s>
		+	:::{{highlight|FAQ}}
		+	:::{{highlight|Handbook}}
		+	:::{{highlight|Manpages}}  {{highlight|<-- Example of Micro topic}}
		+	:::{{highlight|Wiki}}
		+
		+	::10.5 Social Media
		+
		+	::10.6 Search and Portals
		+
		+	::10.7 Other Resources
		+
		+	:11. Supporting PC-BSD  <!-- this seems to need some organization, perhaps from easiest to more difficult -->
		+
		+	::11.1 Become a Beta Tester
		+
		+	::11.2 Become a Translator
		+
		+	::11.3 Become a Developer
		+
		+	::11.4 Report Bugs
		+
		+	::11.5 {{highlight|Request PBIs}} <s>Submit PBI Requests</s>
		+
		+	::11.6 Test PBIs
		+
		+	::11.7 Create PBIs
		+
		+	::11.8 Purchase PC-BSD Swag
		+
		+	::11.9 Host a Mirror
		+
		+	::11.10 Seed a Torrent
		+
		+	::11.11 Become an Advocate
		+
		+	== appliance of [[:template:citelink]]?  ==
		+
		+	Salvete!
		+
		+	Should we use [[:template:citelink]] on this cover page too?
		+
		+	--[[User:Vater|Rg]] 14:26, 20 August 2012 (PDT)
		+
		+	Yes, I think its fair game here as well.
		+
		+	--[[User:Tigersharke|Tigersharke]] 20:19, 21 August 2012 (PDT)

---

Revision as of 06:09, 23 August 2012

Revised handbook structure

Some of this has yet to be finalized, including shuffling of micro topics and sub-micro topics that do not get listed in the table of contents. Micro and sub-micro topics to be added. Key: Highlighted title changes, questions, and new topics. Removed or revised topics or titles.

Preface

1. Introduction <-- Example of Macro topic

1.1 PC-BSD's Goals and Features <-- Example of Topic

1.2 What's New in 9.1

1.3 PC-BSD Releases

1.4 PC-BSD for Linux Users

2. Pre-Installation Tasks

2.1 Hardware Requirements

2.2 Laptops

2.3 Partitioning the Hard Drive

2.4 Obtaining PC-BSD

2.5 Burning the Installation Media

2.6 PC-BSD Live Mode

2.7 Using VirtualBox

3. Installing PC-BSD

3.1 Starting the PC-BSD Installation

3.2 Language Selection Screen

3.3 Desktop Selection Screen

3.4 Disk Selection Screen

3.5 Installation Progress Screen

3.6 Installation Finished Screen

4. Post Installation Configuration and Installation Troubleshooting

4.1 Booting Into PC-BSD

4.2 Language Screen

4.3 Time Zone Selection Screen

4.4 Set Root Password Screen

4.5 Create a User Screen

4.6 Connect to a Wireless Network

4.7 Post Install Finished Screen

4.8 Logging In

4.9 Installation Troubleshooting

5. Advanced Installation Topics

5.1 Install PC-BSD Server Edition (TrueOS)

5.2 Dual Booting

5.3 Multiple Boot Environments

5.4 Upgrading PC-BSD

5.5 Creating an Automated Installation with pc-sysinstall

6. Desktops

6.1 GNOME2

6.2 KDE4

6.3 LXDE

6.4 XFCE4

6.5 Awesome

6.6 EvilWM

6.7 Fluxbox

6.8 FVWM

6.9 i3

6.10 IceWM

6.11 Openbox

6.12 Spectrwm

6.13 WindowLab

6.14 Window Maker

7. Installing Applications and Keeping PC-BSD Updated

7.1 Using AppCafe®

7.2 PBI Manager

7.3 Update Manager

7.4 Meta Package Manager

8. Control Panel

... AppCafe®

8.1 EasyPBI

8.2 About

8.3 AD & LDAP Configuration

8.4 Hardware Compatibility

8.5 GDM Configuration

8.6 Service Manager

8.7 System Manager

8.8 User Manager

8.9 Mount Tray

8.10 Sound Configuration

8.11 Display

8.12 Printing

8.13 Network Configuration

8.14 Firewall Manager

8.15 Life Preserver

8.16 Warden®

8.17 Thin Client How is this control panel item enabled?

9. Common Tasks

9.1 Java, Flash, and Fonts

9.2 Multimedia

9.3 Files and File Sharing

9.4 MythTV

9.5 XBMC

9.6 Windows Emulation

9.7 Bluetooth Manager Is this a control panel or only a tray item? If there is a control panel entity then..

9.7 Remote Desktop

9.8 Security

... Troubleshooting

.. Installation

... TrueOS

.. Working from the commandline

. PBI Manager

. Update Manager

. Meta Package Manager

. (other pc-* commands)

10. Finding Help

10.1 PC-BSD Forums

10.2 IRC Channel

10.3 Mailing Lists

10.4 FreeBSD documentation Handbook and FAQ

FAQ

Handbook

Manpages <-- Example of Micro topic

Wiki

10.5 Social Media

10.6 Search and Portals

10.7 Other Resources

11. Supporting PC-BSD

11.1 Become a Beta Tester

11.2 Become a Translator

11.3 Become a Developer

11.4 Report Bugs

11.5 Request PBIs Submit PBI Requests

11.6 Test PBIs

11.7 Create PBIs

11.8 Purchase PC-BSD Swag

11.9 Host a Mirror

11.10 Seed a Torrent

11.11 Become an Advocate

appliance of template:citelink?

Salvete!

Should we use template:citelink on this cover page too?

--Rg 14:26, 20 August 2012 (PDT)

Yes, I think its fair game here as well.

--Tigersharke 20:19, 21 August 2012 (PDT)