Getting started wiki page - Linux/OSX help needed

Discussion related to the development of project wide documentation and tutorials.
Coordinator: 'Abel'

Moderator: coordinators

Getting started wiki page - Linux/OSX help needed

Postby Poncho » Tue Mar 10, 2009 1:09 pm

Hi, after a request by Radiance, I updated the Getting Started page: http://www.luxrender.net/wiki/index.php/Getting_Started

I think it's looking decent, but it needs stuff about the Linux/OSX of getting (weekly) development releases working. Could jens or other linux/osx guy look at it?

If you have crits/comments about the getting started page, post them here.

Thanks,
Poncho.
Cheers!
User avatar
Poncho
Developer
 
Posts: 1127
Joined: Sun Nov 30, 2008 11:47 am
Location: Northwood

Re: Getting started wiki page - Linux/OSX help needed

Postby Abel » Tue Mar 10, 2009 2:12 pm

Good to see you improving that page, I must admit it was a bit minimalistic. :)

Some comments:

-this page will probably overlap with the installation page (http://www.luxrender.net/wiki/index.php ... tion_guide), which is outdated, overly detailed and incomplete. I'm not even sure we need two separate pages, but if you think we do, please try to find a logical way to separate the content.

-the page seems to be specific to Blender users; it would be good to acknowledge this somewhere and/or link to another page for people using other modelers

-when using the numbers so clearly in the layout, it looks like one is supposed to go through all of them, but this is not the case. Also it is hard to get an overview of the steps involved without reading everything. Is there a reason why you don't want to use wiki headers?

-all pages have their title displayed in the browser title bar and at the top of the page already, for the sake of simplicity I'd prefer it if you don't repeat it on the page itself

-rather than asking new users to chose between a development and a stable version, I propose to point them to the most suitable one. At the moment, that is the weekly build; after the release, it will be 0.6 and probably only a few months later it will become a weekly build again

-OSX users can just copy the luxrender.app, update their luxblend scripts and get going

-weekly builds for Linux users are rare, while compiling on Linux is easy. You could refer Linux users to the "building on Linux" page

I think the first point is the most important, please let me know your thoughts about this.
User avatar
Abel
Developer
 
Posts: 1414
Joined: Sat Oct 20, 2007 8:13 am
Location: Helsinki, Finland

Re: Getting started wiki page - Linux/OSX help needed

Postby Poncho » Tue Mar 10, 2009 2:33 pm

good points, thanks, I will see if I can change them, but first I will wait on reply from Radiance on your points, because he wanted the getting started page updated.

ok?
Cheers!
User avatar
Poncho
Developer
 
Posts: 1127
Joined: Sun Nov 30, 2008 11:47 am
Location: Northwood

Re: Getting started wiki page - Linux/OSX help needed

Postby Poncho » Wed Mar 11, 2009 11:49 am

well, I changed it. not sure what to do with the other page. we could make separated pages for different os. but that might be over-doing?

http://www.luxrender.net/wiki/index.php/Getting_Started

-edit, I have put 0.6 info in it at start. might be confusing... uh.. yeah. so that you know about it.

i'm not sure how to make the 'intro' text. feel free to change the page to your liking.
Cheers!
User avatar
Poncho
Developer
 
Posts: 1127
Joined: Sun Nov 30, 2008 11:47 am
Location: Northwood

Re: Getting started wiki page - Linux/OSX help needed

Postby Radiance » Wed Mar 11, 2009 4:52 pm

Hi,

Nice :)

I think it's good, but maybe 1 page for all 3 os'es is best since much information can be shared.
also maybe include some 'what to do if i have a problem' at the end,
instruct them to post in the support forum, and include some information like screenshots, version used (where they got it) and platform/versions.

Radiance
User avatar
Radiance
 
Posts: 3968
Joined: Wed Sep 19, 2007 2:13 am

Re: Getting started wiki page - Linux/OSX help needed

Postby Poncho » Wed Mar 11, 2009 5:08 pm

done.

feel free to crit/comment, abel and radiance.
Cheers!
User avatar
Poncho
Developer
 
Posts: 1127
Joined: Sun Nov 30, 2008 11:47 am
Location: Northwood


Return to Documentation & Tutorials

Who is online

Users browsing this forum: No registered users and 1 guest