Split up "getting started" section #46017

New Issue

gandalf3 · 2015-09-04T21:40:40+02:00

gandalf3 commented

2015-09-04 21:40:40 +02:00

The [getting started ]] section seems to contain all sorts of not-necessarily-related info (such as http:*blender.org/manual/getting_started/about_blender/about_this_manual.html and [ http://blender.org/manual/getting_started/basics/quick_render.html | documentation on openGL rendering ).
This seems a little inconsistent with the rest of the manual, which is split into sections based on how blender is organized, rather than difficulty or "what should be learned first".

Since this manual is intended as more of a reference manual (rather than a tutorial or teaching course), I propose a re-organization of this section as follows:

From	To	Notes
`basics/startup_file.rst`	`preferences/startup_file.rst`	While not part of the user preference editor, it is a large part of configuring and customizing blender.
`basics/help.rst`	`troubleshooting/general_help.rst`
`basics/undo_and_redo.rst`	`troubleshooting/recovering.rst`
`basics/quick_render.rst`	`render/opengl.rst`	This page contains a lot of general render info not directly relevant to opengl rendering. Perhaps this should be moved to other rendering pages (or just removed).
`basics/interface`	`/interface`	Perhaps this could be moved to it's own root-level chapter, or combined with the `editors` chapter. (e.g. move `editors` into `interface`)
`basics/screencasts.rst`	`/interface/screencast.rst`	This could go inside of the `interface` directory, wherever it ends up (see above). If there are more "UI tool" pages like this one, perhaps a `tools` subdirectory could work (`/interface/tools/screencasts.rst`).
`basics/screenshots.rst`	`/interface/screenshot.rst`	Same as above.
`basics/navigating`	`/editors/3dview/navigate`	This section mainly deals with the 3D view. More generic navigation docs will go here instead, see #43668
`basics/transformations`	`/editors/3dview/transform`	Most of this section appears to deal the the 3D view specifically. Perhaps generic parts could be split into `/interface/transform`, but probably simpler to just ensure that it's mentioned where transforms work in other editors too.
`about_blender/about_this_manual.rst`	`/glossary/conventions.rst`	Since this page describes conventions used in the manual more from a user perspective (not a contributer perspective), maybe it could be integrated into the glossary or something?

Perhaps /getting_started/index.rst can be turned into a sort of "how to use this manual" introduction page, and include a few potential "where to go first" links (e.g. installing_blender)

The [getting started ]] section seems to contain all sorts of not-necessarily-related info (such as [[ http:*blender.org/manual/getting_started/about_blender/about_this_manual.html | conventions used in the manual ]] and [[ http://blender.org/manual/getting_started/basics/quick_render.html | documentation on openGL rendering ](http:*blender.org/manual/getting_started/index.html)). This seems a little inconsistent with the rest of the manual, which is split into sections based on how blender is organized, rather than difficulty or "what should be learned first". [Since this manual is intended as more of a reference manual ](http://lists.blender.org/pipermail/bf-docboard/2015-January/004781.html) (rather than a tutorial or teaching course), I propose a re-organization of this section as follows: | From | To | Notes | ---------------------- | --------------------------------------- | -- | `basics/startup_file.rst` | `preferences/startup_file.rst` | While not part of the user preference editor, it is a large part of configuring and customizing blender. | `basics/help.rst` | `troubleshooting/general_help.rst` | `basics/undo_and_redo.rst` | `troubleshooting/recovering.rst` | `basics/quick_render.rst` | `render/opengl.rst` | This page contains a lot of general render info not directly relevant to opengl rendering. Perhaps this should be moved to other rendering pages (or just removed). | `basics/interface` | `/interface` | Perhaps this could be moved to it's own root-level chapter, or combined with the `editors` chapter. (e.g. move `editors` into `interface`) | `basics/screencasts.rst` | `/interface/screencast.rst` | This could go inside of the `interface` directory, wherever it ends up (see above). If there are more "UI tool" pages like this one, perhaps a `tools` subdirectory could work (`/interface/tools/screencasts.rst`). | `basics/screenshots.rst` | `/interface/screenshot.rst` | Same as above. | `basics/navigating` | `/editors/3dview/navigate` | This section mainly deals with the 3D view. More generic navigation docs will go here instead, see #43668 | `basics/transformations` | `/editors/3dview/transform` | Most of this section appears to deal the the 3D view specifically. Perhaps generic parts could be split into `/interface/transform`, but probably simpler to just ensure that it's mentioned where transforms work in other editors too. | `about_blender/about_this_manual.rst` | `/glossary/conventions.rst` | Since this page describes conventions used in the manual more from a user perspective (not a contributer perspective), maybe it could be integrated into the glossary or something? Perhaps `/getting_started/index.rst` can be turned into a sort of "how to use this manual" introduction page, and include a few potential "where to go first" links (e.g. `installing_blender`)

gandalf3 commented

2015-09-04 21:40:40 +02:00

Changed status to: 'Open'

gandalf3 commented

2015-09-04 21:40:40 +02:00

Added subscriber: @gandalf3

Campbell Barton commented

2015-09-05 18:54:26 +02:00

Added subscriber: @ideasman42

Campbell Barton commented

2015-09-05 18:54:26 +02:00

Agree that basics/ is overloaded and needs reorganization.

Generally your proposel looks good.

Would leave about_blender and installing_blender where they are now, think its not necessarily in the best place currently... but rather not add too many root-level sections.
Disagree with moving basics/navigating to /interface/navigating, this is currently docs for the 3d-viewport. So it could be moved into /editors/3dview/navigation ?

All other changes seem fine.

Note, we have a tool to move paths around, see: tools/rst_remap.py, this avoids having to do a lot of manual edits.

Agree that `basics/` is overloaded and needs reorganization. Generally your proposel looks good. - Would leave `about_blender` and `installing_blender` where they are now, think its not necessarily in the best place currently... but rather not add too many root-level sections. - Disagree with moving `basics/navigating` to `/interface/navigating`, this is currently docs for the 3d-viewport. So it could be moved into `/editors/3dview/navigation` ? All other changes seem fine. ---- Note, we have a tool to move paths around, see: `tools/rst_remap.py`, this avoids having to do a lot of manual edits.

gandalf3 commented

2015-09-05 21:17:17 +02:00

@ideasman42 Sounds good!

Re basics/navigating, not exactly sure what the idea with this section is yet (see #43668#332493).

@ideasman42 Sounds good! Re `basics/navigating`, not exactly sure what the idea with this section is yet (see #43668#332493).

Campbell Barton commented

2015-09-07 09:20:57 +02:00

@gandalf3, AFAICS the existing content belongs in /editors/3dview/navigation, and dont see any issues with moving it there.

We could add some navigation basics doc later.

@gandalf3, AFAICS the existing content belongs in `/editors/3dview/navigation`, and dont see any issues with moving it there. We could add some navigation basics doc later.

Aaron Carlisle commented

2015-09-08 14:18:42 +02:00

Added subscriber: @Blendify

gandalf3 self-assigned this 2015-09-10 08:33:50 +02:00

blender-admin commented

2015-09-10 23:55:40 +02:00

This issue was referenced by 593

gandalf3 commented

2015-09-10 23:56:52 +02:00

Changed status from 'Open' to: 'Resolved'

gandalf3 closed this issue

2015-09-10 23:56:52 +02:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Split up "getting started" section #46017