Blender 2.8 Manual Sprint #65710

New Issue

Brecht Van Lommel · 2019-06-11T11:25:07+02:00

Brecht Van Lommel commented

2019-06-11 11:25:07 +02:00

Blender developers will each update part of the Blender manual for the 2.80 release. The goal is to at least document the new features to a basic level, and fix outdated or wrong information.

Tasks

Chapter	Assigned To	Outdated Information Fixed	Screenshots Updated	New Features Documented

Since texture nodes and Freestyle are likely to be replaced relatively soon, it's not worth spending a lot of time on them. Leaving screenshots outdated is ok. For texture nodes we can mention that they are legacy and will be replaced.

Finished

Chapter	Assigned To	Outdated Information Fixed	Screenshots Updated	New Features Documented
Front Page	@brecht	Done	Done	N/A
Getting Started	@ideasman42	Done	Done	Done
User Interface - Toolbar	@ideasman42	N/A	N/A	DONE
User Interface	@JacquesLucke	Done	Done	Done
Editors - 3D Viewport	@Jeroen-Bakker	Done	Done	Done
Editors - Movie Clip Editor	@Sergey	Done	Done	Done
Editors - Compositor	(part of Compositing)	N/A	N/A	N/A
Editors - Shader Editor	@JacquesLucke	Done	Done	Done
Editors - Video Sequencer	(part of Video Editing)	N/A	N/A	N/A
Editors - Movie Clip Editor	@Sergey	Done	Done	Done
Editors - Drivers	(part of Animation)	Done	Done	Done
Editors - Dope Sheet	@WilliamReynish	Done	Done	Done
Editors - Timeline	@WilliamReynish	Done	Done	Done
Editors - Graph Editor	@WilliamReynish	Done	Done	Done
Editors - Nonlinear Animation	@Jeroen-Bakker	Done	Done	Done
Editors - Text Editor	@JacquesLucke	Done	Done	Done
Editors - Python Console	@JacquesLucke	Done	Done	Done
Editors - Info Editor	@JacquesLucke	Done	Done	Done
Editors - Outliner	@dfelinto	Done	Done	Done
Editors - Properties Editor	@mont29	Done	Done	Done
Editors - File Browser	@mont29	Done	Done	Done
Editors - Preferences	@ideasman42	Done	Done	Done
Editors - Image Editor	@JacquesLucke	Done	Done	Done
Editors - UV Editor	@JacquesLucke	Done	Done	Done
Editors - Texture Nodes - [x]	@Jeroen-Bakker		N/A	N/A
Scene Layout - Overview	@Jeroen-Bakker	N/A	N/A	N/A
Scene Layout - Scene	@JacquesLucke	Done	Done	Done
Scene Layout - Objects	@Jeroen-Bakker	Done	Done	Done
Scene Layout - Collections	@dfelinto	Done	Done	Done
Scene Layout - View Layer	@dfelinto	Done	Done	Done
Scene Layout - Objects - Intro-Selecting	@JacquesLucke	Done	Done	Done
Modeling - Meshes	@ideasman42	Done	N/A	Done
Modeling - Curves	@Blendify	Done	Done	Done
Modeling - Surfaces	@Blendify	Done	Done	Done
Modeling - Empties	@ideasman42	Done	Done	Done
Modeling - Modifiers	@mont29	Done	Done	Done
Modeling - Metaballs	@mont29	Done	Done	Done
Modeling - Text	@mont29	Done	Done	Done
Sculpting & Painting	@Jeroen-Bakker	Done	Done	Done
Grease Pencil	@mendio	N/A	N/A	Done
Animation	@angavrilov	Done	Done	Done
Animation - Drivers Workflow	@brita	Done	Done	Done
Physics - Introduction	@JacquesLucke	Done	Done	Done
Physics - Rigid Body	@JacquesLucke	Done	Done	Done
Physics - Cloth	@JacquesLucke	Done	Done	Done
Physics - Particle System	@JacquesLucke	Done	Done	Done
Physics - Baking	@JacquesLucke	Done	Done	Done
Physics - Soft Body	@JacquesLucke	Done	Done	Done
Physics - Fluid/Smoke/Paint	@JacquesLucke	Done	Done	Done
Physics - Collision	@mano-wii	Done	Done	Done
Physics - Forces	@JacquesLucke	Done	Done	Done
Compositing	@JacquesLucke	Done	Done	Done
Render - Cycles	@brecht	Done	Done	Done
Render - Eevee	@fclem	Done	Done	Done
Render - Workbench	@Jeroen-Bakker	Done	Done	Done
Render - Color Management	@brecht	Done	Done	Done
Render - Shader Nodes	@brecht	Done	Done	Done
Render - Layers & Passes	@Jeroen-Bakker	Done	Done	Done
Render - Lights	@brecht	Done	Done	Done
Render - Materials	@brecht	Done	Done	Done
Render - Output	@Sergey	Done	Done	Done
Render - Output - Multiview	@Jeroen-Bakker	Done	Done	Done
Render - Freestyle - [x]	@Blendify	Done	Done	N/A
Video Editing	@iss	Done	Done	Done
Files & Data System	@mont29	Done	Done	Done
Tracking & Masking	@Sergey	Done	Done	Done
Troubleshooting	@Sergey	Done	Done	Done
Advanced	@ideasman42	Done	Done	Done
Advanced - Scripting	@JacquesLucke	Done	Done	Done
Glossary	@brecht	Done	N/A	N/A

Guidelines

#55018 (Documentation for 2.8 (WIP)) has a list of things that are missing or outdated, but it's not complete so make sure to go over all the pages in the chapter you are responsible for.

Changes can be committed directly without review

Text

For specific settings. Can be copied from the release notes and tooltips (in the API docs ) to get an initial version.
If a lot of text is copied from release notes, the release notes can be shortened and link to the manual instead.
Try to give the chapters give at least a short explanation of the overall intended purpose of a feature, beyond just enumerating features.
This is a reference manual, so tutorial style explanations are not needed.

Images

Non-essential screenshots (for example of a single panel or node) can be commented out with TODO2.8.
For important screenshots, update them and use --factory-startup to ensure everything is set to defaults.
If anything must be marked in images, use yellow lines like this. Avoid adding text in images since it can't be translated, use captions instead.

Brecht Van Lommel commented

2019-06-11 11:25:07 +02:00

Added subscriber: @brecht

Brecht Van Lommel commented

2019-06-11 11:31:00 +02:00

Added subscribers: @fclem, @JacquesLucke, @Sergey

Brecht Van Lommel commented

2019-06-11 11:32:00 +02:00

Added subscriber: @Jeroen-Bakker

Bastien Montagne commented

2019-06-11 13:50:45 +02:00

Added subscriber: @mont29

Emir Sinan Gürlek commented

2019-06-11 19:02:31 +02:00

Added subscriber: @filibis

Campbell Barton commented

2019-06-12 13:39:38 +02:00

Added subscriber: @ideasman42

Brecht Van Lommel commented

2019-06-12 15:27:14 +02:00

Added subscribers: @iss, @mendio

Dalai Felinto commented

2019-06-13 14:03:58 +02:00

Added subscriber: @dfelinto

Germano Cavalcante commented

2019-06-13 15:16:47 +02:00

Added subscriber: @mano-wii

Jacques Lucke commented

2019-06-14 16:45:22 +02:00

Added subscriber: @jacques-3

Brecht Van Lommel commented

2019-06-14 17:11:51 +02:00

Removed subscriber: @jacques-3

William Reynish commented

2019-06-15 21:30:06 +02:00

Added subscriber: @WilliamReynish

Brecht Van Lommel commented

2019-06-17 10:04:48 +02:00

Added subscriber: @angavrilov

Brecht Van Lommel commented

2019-06-18 12:04:13 +02:00

There's still some unfinished things in the 3D viewport, so I've moved that back:
https://docs.blender.org/manual/en/dev/editors/3dview/tools.html
https://docs.blender.org/manual/en/dev/editors/3dview/properties/shading.html

There's still some unfinished things in the 3D viewport, so I've moved that back: https://docs.blender.org/manual/en/dev/editors/3dview/tools.html https://docs.blender.org/manual/en/dev/editors/3dview/properties/shading.html

William Reynish commented

2019-06-21 13:55:24 +02:00

@mont29 I think we are missing a chapter under Properties about decorators. I can add it.

Brecht Van Lommel commented

2019-06-21 15:44:38 +02:00

Marking the animation chapter as mostly done, there are some screenshot TODO's but it's the same for other chapters we consider done.

For the frontpage, https://www.blender.org/features/ is being updated for 2.8 and once that is done we can steal images from there.

Marking the animation chapter as mostly done, there are some screenshot TODO's but it's the same for other chapters we consider done. For the frontpage, https://www.blender.org/features/ is being updated for 2.8 and once that is done we can steal images from there.

Inês Almeida commented

2019-06-25 00:00:53 +02:00

Added subscriber: @brita

Hoang Duy Tran commented

2019-06-25 16:11:07 +02:00

Added subscriber: @hoanguk

Hoang Duy Tran commented

2019-06-25 16:11:07 +02:00

Will the locale languages be able to capture their own set of screen images if GUI texts are translated and how this could be done and store?

Brecht Van Lommel commented

2019-06-26 03:20:59 +02:00

There is no mechanism to do screenshots for each language separately, and there will be none for the 2.80 manual.

Bastien Montagne commented

2019-06-26 11:08:54 +02:00

@WilliamReynish I have no idea of what you are talking about. What are 'decorators' in properties editor???

Hoang Duy Tran commented

2019-06-26 13:38:14 +02:00

In #65710#707048, @brecht wrote:
There is no mechanism to do screenshots for each language separately, and there will be none for the 2.80 manual.

Hi Brencht,
I think Blender documentation should allow this option. As far as I know, many people in my country (Vietnam) have a need to use Blender and yet their English capability is not yet up to par. That's why I learned from the Russian's documentation team to leave the English references on titles and section titles, allowing readers to reference the original document if needed. There are situations where translation needs clarifications from the original texts. I think Blender needs to close the loop on this front. It's only the '_images' needed to add, and of course the amount of space needed to be allocated, and then

http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-figure_language_filename

> In #65710#707048, @brecht wrote: > There is no mechanism to do screenshots for each language separately, and there will be none for the 2.80 manual. Hi Brencht, I think Blender documentation should allow this option. As far as I know, many people in my country (Vietnam) have a need to use Blender and yet their English capability is not yet up to par. That's why I learned from the Russian's documentation team to leave the English references on titles and section titles, allowing readers to reference the original document if needed. There are situations where translation needs clarifications from the original texts. I think Blender needs to close the loop on this front. It's only the '_images' needed to add, and of course the amount of space needed to be allocated, and then http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-figure_language_filename

Aaron Carlisle commented

2019-06-26 21:46:24 +02:00

Added subscriber: @Blendify

Aaron Carlisle commented

2019-06-26 21:46:24 +02:00

In #65710#707048, @brecht wrote:
There is no mechanism to do screenshots for each language separately, and there will be none for the 2.80 manual.

@hoanguk is right here, there is a mechanism to do this however the only problem with this is the amount of work required to implement this. Having to make a dozen screenshots in different languages is very tedious. So unless there is an automated way for us to make UI screenshots and correctly link this to the manual. I would rather us not spend our time on this. If we are going to continue this discussion lets please open a separate task.

> In #65710#707048, @brecht wrote: > There is no mechanism to do screenshots for each language separately, and there will be none for the 2.80 manual. @hoanguk is right here, there is a mechanism to do this however the only problem with this is the amount of work required to implement this. Having to make a dozen screenshots in different languages is very tedious. So unless there is an automated way for us to make UI screenshots and correctly link this to the manual. I would rather us not spend our time on this. If we are going to continue this discussion lets please open a separate task.

Alessio Monti di Sopra commented

2019-06-27 11:50:43 +02:00

Added subscriber: @a.monti

Alessio Monti di Sopra commented

2019-06-27 11:50:43 +02:00

Hi, I noticed an error in the markers page, for theBind Camera to Marker operator.

It still says that you need to select both the camera and the marker to bind it to, while in fact now the operator adds a new marker at the current frame, named after the selected camera.

Hi, I noticed an error in the markers page, for the*Bind Camera to Marker* operator. It still says that you need to select both the camera and the marker to bind it to, while in fact now the operator adds a new marker at the current frame, named after the selected camera.

Aaron Carlisle commented

2019-06-27 22:36:19 +02:00

@a.monti fixed in rBM5246

Robert Guetzkow commented

2019-07-20 14:08:49 +02:00

Added subscriber: @rjg

Robert Guetzkow commented

2019-07-20 14:08:49 +02:00

This comment was removed by @rjg

*This comment was removed by @rjg*

Robert Guetzkow commented

2019-07-20 14:23:40 +02:00

Removed subscriber: @rjg

Robert Guetzkow commented

2019-07-20 14:24:41 +02:00

This comment was removed by @rjg

*This comment was removed by @rjg*

Evan Wilson commented

2019-07-24 16:45:04 +02:00

Added subscriber: @EAW

Evan Wilson commented

2019-07-24 16:45:04 +02:00

In RC2, Online Manual links within the Video Sequence Editor direct users to 404 pages. For example: right clicking and choosing "Online Manual" or pressing F1 while hovering over "Sequencer" directs users to https:*docs.blender.org/manual/en/2.80/sequencer/index.html#bpy-types-spacesequenceeditor instead of https:*docs.blender.org/manual/en/2.80/video_editing/sequencer/index.html#bpy-types-spacesequenceeditor

/video_editing/

is missing in the urls.

In RC2, Online Manual links within the Video Sequence Editor direct users to 404 pages. For example: right clicking and choosing "Online Manual" or pressing F1 while hovering over "Sequencer" directs users to https:*docs.blender.org/manual/en/2.80/sequencer/index.html#bpy-types-spacesequenceeditor instead of https:*docs.blender.org/manual/en/2.80/video_editing/sequencer/index.html#bpy-types-spacesequenceeditor ``` /video_editing/ ``` is missing in the urls.

Aaron Carlisle commented

2019-07-25 01:47:19 +02:00

@EAW fixed in blender/blender-addons@cc1f86f6cd

I will make sure this gets included in 2.80 release.

I wanted to make more of these for new tools work but ran out of time for 2.80 release and they will be included in the 2.80a

@EAW fixed in blender/blender-addons@cc1f86f6cd I will make sure this gets included in 2.80 release. I wanted to make more of these for new tools work but ran out of time for 2.80 release and they will be included in the 2.80a

Aaron Carlisle commented

2019-07-30 05:44:53 +02:00

Changed status from 'Open' to: 'Resolved'

Aaron Carlisle closed this issue

2019-07-30 05:44:53 +02:00

Aaron Carlisle self-assigned this 2019-07-30 05:44:53 +02:00

Aaron Carlisle commented

2019-07-30 05:44:53 +02:00

A big thanks to everyone who has helped with updating the manual to 2.80.
There are many remaining todos, things that were likely forgotten, and always general improvements that are still possible.
Anyone is welcome to contribute anytime, look for updated plans for 2.81 docs.

A big thanks to everyone who has helped with updating the manual to 2.80. There are many remaining todos, things that were likely forgotten, and always general improvements that are still possible. Anyone is welcome to contribute anytime, look for updated plans for 2.81 docs.

Sign in to join this conversation.

14 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#65710

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Blender 2.8 Manual Sprint #65710

Tasks

Finished

Guidelines

Text

Images