documentation volunteer (English and German)

[heretic]

Since I hate developing and building Id like to contribute in documentation.

languages: English (4/5 - if I reread what I wrote ) and German (5/5)

level: consider myself intermediate in Blender and newbie in lux

why: I learn for myself by writing, so basically to learn somethign I write a manual for myself, which in the end usually could be refined with a few steps to something official. Sicne I do it anyway, I could also do it for the lux wiki.


What I need:
- knowing how you do it aka add documentation for lux
- someone to have a look at what I write when done (QA) or who helps when am stuck (hey it happens that someone starts soemthign which turns out to be more complex than anticipated)
- a place to start entering text for a subjext (preferably the stuff am learnign atm )

What I did so far:
- lux basic materials
- lux basics rendering
- lux tricks on fake SSS and glass2
- new absorption feature
- some more stuff...

What I saw is slacking:
- didnt see any comprehensive documentation for 0.7 yet (maybe since its not marked as new, maybe because its not posted yet)
- IBL tutorial for lux (would be small but there are some nuts and bolts and the wiki and forum only offer like 5 sentences total)
- in depth material tutorial - we got a starter but for .7 it imho makes sense to really create 3-5 materials in each category in a tutorial and show major differences
- workflow tutorial (am the wrogn one for that for a few more weeks or even months - lack lux experience for that)


PM me in here if interested

[SATtva]

Well, if you have any questions, just drop them here (if you're interested in a better phrasing something) or in a relevant sections of forum -- this is usually the best way to get answers in a promptly manner. And your efforts are welcomed of course: actualizing documentation for 0.7 is in fact already a task in the bugtracker, and we'll be only glad if somebody can help with that.

[heretic]

So basically you are telling me: create a wiki account and start it? On any questions or QA when done just post em here? Ok, done

[dougal2]

Your forum account will let you create and edit pages on the wiki

[Abel]

Excellent! The wiki could indeed do with some additions and maintenance.

You're right that the documentation is mostly about 0.6, but now that 0.7 got into the release candidate stage, it might be the right moment to start updating information. However, for the time being it would be good to somehow indicate any 0.7-only functionality as long as 0.7 is not yet released.

What I saw is slacking:
- didnt see any comprehensive documentation for 0.7 yet (maybe since its not marked as new, maybe because its not posted yet)
- IBL tutorial for lux (would be small but there are some nuts and bolts and the wiki and forum only offer like 5 sentences total)
- in depth material tutorial - we got a starter but for .7 it imho makes sense to really create 3-5 materials in each category in a tutorial and show major differences
- workflow tutorial (am the wrogn one for that for a few more weeks or even months - lack lux experience for that)

Those would all be useful additions. Regarding the tutorials, I'd suggest to have a look at the existing one and then decide if updating/improving or adding a new one is best.

For more topics that are in need of attention, please have a look at http://www.luxrender.net/wiki/index.php ... ation_todo. Also please have a look at the pages under the Documentation Writers section of the main wiki page.

- someone to have a look at what I write when done (QA) or who helps when am stuck (hey it happens that someone starts soemthign which turns out to be more complex than anticipated)

I'm regularly monitoring the wiki and will make sure to check your additions.

Good luck!

[heretic]

http://www.luxrender.net/wiki/index.php?title=Environment_map

Yours to judge - my first shot.

[heretic]

http://www.luxrender.net/wiki/index.php?title=Environment_map

Yours to judge - my first shot.

Please, I need some feedback on my first shot - if too harsh a critic that you dont want to write it down here, then please by IRC or by PM on boards. Of course I dare not to continue when I dont know if my style is suitable for LuxRender.

(Please this is no fishing for.. or so - I really dont know and cant know without feedback - even though above wiki was imho a simple topic).

[dougal2]

Hi Heretic.

Just a few small points here - overall the page quality is very good. What I've suggested below is just a few tweaks to make the English language sound more natural; I hope you agree

------------

"The HDR should have a resolution, which fits to the demands of the scene."
->
"The HDR should have a resolution suitable for the needs of the scene"

"Reflection maps are usually mirrored on small surfaces, like eg a shiny spoon,"
->
"Reflection maps are usually mirrored on shiny surfaces, like eg a shiny metal spoon,"

"esspecially" -> "especially"

"A typical size for a latlong reflection map is 3200x1600 pixel and already shows a lot of distinct details of the surroundings."
->
"A typical size for a latlong reflection map is 3200x1600 pixels and at this size a lot of distinct details of the surroundings will become visible."

"1c. Background"
-> Confusing to start talking about post-processes in the context of HDRI. This subject would probably deserve its own section or wiki page ?

"On anything else the correct gain (multiplier) value is entered"
-> Doesn't really make much sense. I guess you mean to say that you should use the value supplied in the (s)IBL file if available ?

"6. Rename the lightgroup...."
-> ... beware that adding lightgroups to a scene increases memory usage and can increase render times

[heretic]

Hi Heretic.

Just a few small points here - overall the page quality is very good. What I've suggested below is just a few tweaks to make the English language sound more natural; I hope you agree

All in now...

[Abel]

Good to see you got started, thanks!

I've made some minor changes to the page regarding formatting and spelling and have a couple of remarks:

1. division between general and exporter specific information

The wiki consists of pages that describe LuxRender's functionality and features, and of pages that describe how to access this functionality through exporters. This way, one can get an overview of LuxRender's functionality without having to go through information that is not relevant for the modeling program that is being used. In your page, you make a similar distinction, but in its current form the page doesn't fit in the existing wiki structure. Sections 1 and 2 should be integrated in http://www.luxrender.net/wiki/index.php ... r_Lighting or form a separate page, section 3 should be integrated in http://www.luxrender.net/wiki/index.php ... nvironment.

2. introduction text

When starting to read the page, it first looks like there are two separate ways a hdr file can be used (for example when writing "both maps"). Only afterwards it turns out there is no distinction between the two.

I think the notes about fitting in background images should form a page of their own; a tutorial might be the most suitable format. By moving this section, the topic will not derive too much in the LuxRender lighting page.

Regarding the notes: I have never heard of a win-mapped image. Also I have some doubts that a spherically mapped background would work in combination with LuxRender's hdr lighting.

3. background/preconsiderations

The text "LuxRender offers to compensate such issues, but this can be tricky" leaves me with more questions than with answers, could you specify how this works?

4. image
The projection image is nice! If you made it, great! Otherwise, are you sure we can use it under the GNU Free Documentation License?