Docs: Project Tools Update #156

Merged
Nick Alberelli merged 59 commits from :docs/project-tools-update into main 2023-10-19 22:21:50 +02:00
5 changed files with 30 additions and 104 deletions
Showing only changes of commit 06c5205aaa - Show all commits

View File

@ -138,6 +138,7 @@ export default defineConfig({
text: 'Project Tools', text: 'Project Tools',
collapsed: true, collapsed: true,
items: [ items: [
{ text: 'Project Overview', link: '/user-guide/project_tools/project-overview' },
{ text: 'Pipeline Usage', link: '/user-guide/quick_start'}, { text: 'Pipeline Usage', link: '/user-guide/quick_start'},
{ text: 'Running Blender', link: '/user-guide/running_blender' }, { text: 'Running Blender', link: '/user-guide/running_blender' },
], ],
@ -164,7 +165,6 @@ export default defineConfig({
text: 'Project Tools', text: 'Project Tools',
collapsed: true, collapsed: true,
items: [ items: [
{ text: 'Project Overview', link: '/td-guide/project-overview' },
{text: 'Project Setup', link: '/td-guide/project-tools-setup'}, {text: 'Project Setup', link: '/td-guide/project-tools-setup'},
], ],
}, },

View File

@ -11,7 +11,7 @@ hero:
link: /pipeline-overview/introduction link: /pipeline-overview/introduction
- theme: alt - theme: alt
text: User Guide text: User Guide
link: /td-guide/project-overview link: /user-guide/project_tools/project-overview
features: features:
- title: Free Software - title: Free Software

View File

@ -1,80 +0,0 @@
# Project Overview
The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems.
Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder.
## Directory Layout
### Project Layout
The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project.
* `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`.
* `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc)
* `svn` This the versioned controlled folder where the .blend production files will live.
```bash
.
└── my_project/
├── local # The local copy of Blender and the add-ons will be installed.
├── shared # Shared over the network (Syncthing, NFS, Dropbox, etc)
└── svn # Contains the `.blend` production files. (SVN, GIT-LFS, etc)
```
### Shared
This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure.
<!--- TODO Replace with new folder structure --->
::: warning Work in Progress
15 Oct. 2023 - The following folder trees are out of data, and will soon be updated.
:::
```bash
.
├── bts # Behind the scenes
├── concepts # Concept art and paintings
├── development # Piches and boards
├── edit # VSE Editing sequences/exports
├── inspiration # Various inspirations & references
├── music
├── planning
├── pr
├── resources
├── script # Latest scripts for the movie
├── shot_packs # Shots for sharing online
├── training # Training produced for the production
└── videoref # Video shoots from animators
```
### SVN
This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure.
```bash
.
└── svn /
├── dev / # Anything related to early development or tests
│ ├── boards
│ ├── concepts
│ └── tests
├── pre/ # For pre-production
│ ├── assets
│ └── shots
├── pro/ # All files from the production
│ ├── assets/ # All assets from the production
│ │ ├── cam # Camera rig & setup
│ │ ├── chars # Characters & character variations
│ │ ├── fx # Effects
│ │ ├── lgt # Lighting setups
│ │ ├── lib
│ │ ├── maps # General textures and HDRIs
│ │ ├── nodes # General Node groups
│ │ ├── poses # Pose libraries for animation
│ │ ├── props
│ │ ├── scripts
│ │ └── sets
│ ├── config
│ └── shots #Structured into sequences
└── tools
```

View File

@ -55,31 +55,13 @@ mkdir /data/my_project/render/
This directory is used for the temporary storage of render files generated by Flamenco. This storage must be accessible by all computers using Flamenco for rendering, commonly this is a Network Attached Storage of some kind. In this guide, our renders will live in the root of our project directory. This directory is used for the temporary storage of render files generated by Flamenco. This storage must be accessible by all computers using Flamenco for rendering, commonly this is a Network Attached Storage of some kind. In this guide, our renders will live in the root of our project directory.
::: warning Work in Progress
15 Oct. 2023 - The following folder trees are out of data, and will soon be updated.
:::
### Populating `shared` ### Populating `shared`
This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure.
<!--- TODO Need to improve, ask Sebastian maybe ---> ::: warning Work in Progress
15 Oct. 2023 - The following folder trees are out of data, and will soon be updated.
```bash :::
.
├── bts # Behind the scenes
├── concepts # Concept art and paintings
├── development # Piches and boards
├── edit # VSE Editing sequences/exports
├── inspiration # Various inspirations & references
├── music
├── planning
├── pr
├── resources
├── script # Latest scripts for the movie
├── shot_packs # Shots for sharing online
├── training # Training produced for the production
└── videoref # Video shoots from animators
```
### Populating `SVN` ### Populating `SVN`
This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure.

View File

@ -0,0 +1,24 @@
# Project Overview
The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems.
Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder.
## Directory Layout
The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project.
* `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`.
* `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc)
* `svn` This the versioned controlled folder where the .blend production files will live.
```bash
.
└── my_project/
├── local # The local copy of Blender and the add-ons will be installed.
├── shared # Shared over the network (Syncthing, NFS, Dropbox, etc)
└── svn # Contains the `.blend` production files. (SVN, GIT-LFS, etc)
```
To learn the layout of the above directories, see the [`shared`](/naming-conventions/shared-folder-structure.md) and [`svn`](/naming-conventions/svn-folder-structure.md) directory overviews.
To learn more about setting up a production pipeline using the project tools see the [Project Tools Setup Guide](/td-guide/project-tools-setup.md)