Page MenuHome

Blender 2.8 Manual Sprint
Closed, ResolvedPublic

Description

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

ChapterAssigned ToOutdated Information FixedScreenshots UpdatedNew Features Documented

[1] 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

ChapterAssigned ToOutdated Information FixedScreenshots UpdatedNew Features Documented
Front Page@Brecht Van Lommel (brecht)DoneDoneN/A
Getting Started@Campbell Barton (campbellbarton)DoneDoneDone
User Interface - Toolbar@Campbell Barton (campbellbarton)N/AN/ADONE
User Interface@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - 3D Viewport@Jeroen Bakker (jbakker)DoneDoneDone
Editors - Movie Clip Editor@Sergey Sharybin (sergey)DoneDoneDone
Editors - Compositor(part of Compositing)N/AN/AN/A
Editors - Shader Editor@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - Video Sequencer(part of Video Editing)N/AN/AN/A
Editors - Movie Clip Editor@Sergey Sharybin (sergey)DoneDoneDone
Editors - Drivers(part of Animation)DoneDoneDone
Editors - Dope Sheet@William Reynish (billreynish)DoneDoneDone
Editors - Timeline@William Reynish (billreynish)DoneDoneDone
Editors - Graph Editor@William Reynish (billreynish)DoneDoneDone
Editors - Nonlinear Animation@Jeroen Bakker (jbakker)DoneDoneDone
Editors - Text Editor@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - Python Console@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - Info Editor@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - Outliner@Dalai Felinto (dfelinto)DoneDoneDone
Editors - Properties Editor@Bastien Montagne (mont29)DoneDoneDone
Editors - File Browser@Bastien Montagne (mont29)DoneDoneDone
Editors - Preferences@Campbell Barton (campbellbarton)DoneDoneDone
Editors - Image Editor@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - UV Editor@Jacques Lucke (JacquesLucke)DoneDoneDone
Editors - Texture Nodes [1]@Jeroen Bakker (jbakker)N/AN/A
Scene Layout - Overview@Jeroen Bakker (jbakker)N/AN/AN/A
Scene Layout - Scene@Jacques Lucke (JacquesLucke)DoneDoneDone
Scene Layout - Objects@Jeroen Bakker (jbakker)DoneDoneDone
Scene Layout - Collections@Dalai Felinto (dfelinto)DoneDoneDone
Scene Layout - View Layer@Dalai Felinto (dfelinto)DoneDoneDone
Scene Layout - Objects - Intro-Selecting@Jacques Lucke (JacquesLucke)DoneDoneDone
Modeling - Meshes@Campbell Barton (campbellbarton)DoneN/ADone
Modeling - Curves@Aaron Carlisle (Blendify)DoneDoneDone
Modeling - Surfaces@Aaron Carlisle (Blendify)DoneDoneDone
Modeling - Empties@Campbell Barton (campbellbarton)DoneDoneDone
Modeling - Modifiers@Bastien Montagne (mont29)DoneDoneDone
Modeling - Metaballs@Bastien Montagne (mont29)DoneDoneDone
Modeling - Text@Bastien Montagne (mont29)DoneDoneDone
Sculpting & Painting@Jeroen Bakker (jbakker)DoneDoneDone
Grease Pencil@Matias Mendiola (mendio)N/AN/ADone
Animation@Alexander Gavrilov (angavrilov)DoneDoneDone
Animation - Drivers Workflow@Inês Almeida (brita_)DoneDoneDone
Physics - Introduction@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Rigid Body@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Cloth@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Particle System@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Baking@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Soft Body@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Fluid/Smoke/Paint@Jacques Lucke (JacquesLucke)DoneDoneDone
Physics - Collision@Germano Cavalcante (mano-wii)DoneDoneDone
Physics - Forces@Jacques Lucke (JacquesLucke)DoneDoneDone
Compositing@Jacques Lucke (JacquesLucke)DoneDoneDone
Render - Cycles@Brecht Van Lommel (brecht)DoneDoneDone
Render - Eevee@Clément Foucault (fclem)DoneDoneDone
Render - Workbench@Jeroen Bakker (jbakker)DoneDoneDone
Render - Color Management@Brecht Van Lommel (brecht)DoneDoneDone
Render - Shader Nodes@Brecht Van Lommel (brecht)DoneDoneDone
Render - Layers & Passes@Jeroen Bakker (jbakker)DoneDoneDone
Render - Lights@Brecht Van Lommel (brecht)DoneDoneDone
Render - Materials@Brecht Van Lommel (brecht)DoneDoneDone
Render - Output@Sergey Sharybin (sergey)DoneDoneDone
Render - Output - Multiview@Jeroen Bakker (jbakker)DoneDoneDone
Render - Freestyle [1]@Aaron Carlisle (Blendify)DoneDoneN/A
Video Editing@Richard Antalik (ISS)DoneDoneDone
Files & Data System@Bastien Montagne (mont29)DoneDoneDone
Tracking & Masking@Sergey Sharybin (sergey)DoneDoneDone
Troubleshooting@Sergey Sharybin (sergey)DoneDoneDone
Advanced@Campbell Barton (campbellbarton)DoneDoneDone
Advanced - Scripting@Jacques Lucke (JacquesLucke)DoneDoneDone
Glossary@Brecht Van Lommel (brecht)DoneN/AN/A

Guidelines

T55018: 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.

Details

Type
To Do

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

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

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.

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?

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

@William Reynish (billreynish) I have no idea of what you are talking about. What are 'decorators' in properties editor???

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

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

@Hoang Duy Tran (hoangduytran) 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.

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.

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.

@Evan Wilson (EAW) fixed in rBAcc1f86f6cd9b427af08bbfaf8ad53076466a8fcb

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 (Blendify) closed this task as Resolved.Tue, Jul 30, 5:44 AM
Aaron Carlisle (Blendify) claimed this task.

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.