studio/blender-studio-tools
13
32
Fork 19
Code Issues 21 Pull Requests 4 Projects Releases 1 Activity

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
Conversation 0 Commits 59 Files Changed 27 +43 -41
11 changed files with 43 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 3a4da7bf6a - Show all commits

62
docs/.vitepress/config.ts
View File

@ -141,24 +141,8 @@ export default defineConfig({
text: 'User Guide',
collapsed: false,
items: [
{
text: 'Project Setup',
collapsed: true,
items: [
{ text: 'Intro', link: '/user-guide/project-setup/intro' },
{ text: 'SVN', link: '/user-guide/project-setup/svn' },
{
text: 'Workstation',
collapsed: true,
items: [
{ text: 'Introduction', link: '/user-guide/project-setup/workstations/introduction' },
{ text: 'Installing Software', link: '/user-guide/project-setup/workstations/installing-software' },
{ text: 'Running Blender', link: '/user-guide/project-setup/workstations/running-blender' },
{ text: 'Troubleshooting', link: '/user-guide/project-setup/workstations/troubleshooting' },
],
},
],
},
{ text: 'Project Setup', link: '/user-guide/project-setup/intro' },
{ text: 'Running Blender', link: '/user-guide/running_blender' },
{
text: 'Organization',
collapsed: true,
@ -177,17 +161,6 @@ export default defineConfig({
collapsed: false,
items: [
{text: 'Project Setup', link: '/td-guide/project-setup'},
{
text: 'Workstation',
collapsed: true,
items: [
{ text: 'Overview', link: '/td-guide/workstations/overview'},
{ text: 'Installation', link: '/td-guide/workstations/installation'},
{ text: 'Maintenance', link: '/td-guide/workstations/maintaince'},
{ text: 'Render Farm', link: '/td-guide/workstations/render_farm'},
]
},
]
},
{
@ -207,7 +180,36 @@ export default defineConfig({
{text: 'Asset Publishing', link: '/archive/pipeline-proposal-2019/asset-publishing/introduction'},
{text: 'Character Pipeline Assistant', link: '/archive/pipeline-proposal-2019/asset-publishing/character-pipeline-assistant'},
],
}
},
{
text: 'Gentoo',
collapsed: true,
items: [
{
text: 'TD',
collapsed: false,
items: [
{ text: 'Overview', link: '/gentoo/td/overview'},
{ text: 'Installation', link: '/gentoo/td/installation'},
{ text: 'Maintenance', link: '/gentoo/td/maintaince'},
{ text: 'Render Farm', link: '/gentoo/td/render_farm'},
],
},
{
text: 'User',
collapsed: false,
items: [
{ text: 'Introduction', link: '/gentoo/user/introduction' },
{ text: 'Installing Software', link: '/gentoo/user/installing-software' },
{ text: 'Running Blender', link: '/gentoo/user/running-blender' },
{ text: 'SVN', link: '/gentoo/user/svn' },
{ text: 'Troubleshooting', link: '/gentoo/user/troubleshooting' },
]
},
],
},
],
},
markdown: {

0
docs/td-guide/workstations/installation.md → docs/gentoo/td/installation.md
View File

6
docs/td-guide/workstations/maintaince.md → docs/gentoo/td/maintaince.md
View File

@ -17,7 +17,7 @@ are used in Gentoo see the [Gentoo Handbook](https://wiki.gentoo.org/wiki/Ebuild
2. `ssh user@build-server-addr` connect to your build server via ssh
3. Update the package recipes on the Build Server `emaint sync --repo blender-studio-overlay`
Once an update of the recipe is complete any affected packages can be installed our updated by following the [Installing Packages on Build Server](/td-guide/workstations/maintaince#installing-packages-on-build-server) guide.
Once an update of the recipe is complete any affected packages can be installed our updated by following the [Installing Packages on Build Server](/gentoo/td/maintaince#installing-packages-on-build-server) guide.
## Installing Packages on Build Server
Packages need to be compiled on the Build Server and marked with a date to be able to discovered by the workstations. Follow the below steps to install/update a package on the build server.
@ -32,9 +32,9 @@ The command `emerge --oneshot {package-name}` compiles package, but does not add
:::
## Update Add-ons in `/shared/software/addons`
The software inside the `shared/software/addons` directory are the [Blender Studio Pipeline Add-ons](/addons/overview) and any other Add-ons that need to be distributed to all Blender Studio Users. These Add-ons are considered Live Packages. Live Packages are packages that fetch updates from the source repository directly and are not tied to a specific release. To update packages not included in `/shared/software/addons` see [Installing Software](/user-guide/project-setup/workstations/installing-software)
The software inside the `shared/software/addons` directory are the [Blender Studio Pipeline Add-ons](/addons/overview) and any other Add-ons that need to be distributed to all Blender Studio Users. These Add-ons are considered Live Packages. Live Packages are packages that fetch updates from the source repository directly and are not tied to a specific release. To update packages not included in `/shared/software/addons` see [Installing Software](/gentoo/user/installing-software)
1. Follow the instructions in [Installing Packages on Build Server](/td-guide/workstations/maintaince#installing-packages-on-build-server) using `blender-studio-tools` as the package name.
1. Follow the instructions in [Installing Packages on Build Server](/gentoo/td/maintaince#installing-packages-on-build-server) using `blender-studio-tools` as the package name.
### How to update to specific version?

0
docs/td-guide/workstations/overview.md → docs/gentoo/td/overview.md
View File

2
docs/td-guide/workstations/render_farm.md → docs/gentoo/td/render_farm.md
View File

@ -43,7 +43,7 @@ The Blender add-on also needs to be reloaded, make sure that Blender is restarte
This section will only provide a quick rundown of how to update the Flamenco package that is part of the Render Farm setup.
For more details and how to update other packages, see the [Maintenance](/td-guide/workstations/maintaince) page.
For more details and how to update other packages, see the [Maintenance](/gentoo/td/maintaince) page.
::: info Note
The Flamenco package should already have the correct [USE flags](https://wiki.gentoo.org/wiki/Handbook:AMD64/Working/USE) configured.

4
docs/user-guide/project-setup/workstations/installing-software.md → docs/gentoo/user/installing-software.md
View File

@ -22,7 +22,7 @@ emerge is the default package manager, use emerge to install, update, and genera
**emerge** provides commands to install packages onto your system including any dependencies. You must be **root** to make changes via **emerge**. _In this example package name is **spotify**._
1. [Open Terminal and Become Root](/user-guide/project-setup/workstations/installing-software.md#open-terminal-and-become-root)
1. [Open Terminal and Become Root](/gentoo/user/installing-software.md#open-terminal-and-become-root)
2. Find avaliable packages using the `eix` for example: `eix spotify`
```bash
@ -68,7 +68,7 @@ Dependency resolution took 8.40 s.
In this example package name is **spotify**.
1. [Open Terminal and Become Root](/user-guide/project-setup/workstations/installing-software.md#open-terminal-and-become-root)
1. [Open Terminal and Become Root](/gentoo/user/installing-software.md#open-terminal-and-become-root)
2. Remove a package and it’s dependacies safely.
1. `emerge --deselect spotify`
2. `emerge --depclean`

0
docs/user-guide/project-setup/workstations/introduction.md → docs/gentoo/user/introduction.md
View File

0
docs/user-guide/project-setup/workstations/running-blender.md → docs/gentoo/user/running-blender.md
View File

0
docs/user-guide/project-setup/svn.md → docs/gentoo/user/svn.md
View File

6
docs/user-guide/project-setup/workstations/troubleshooting.md → docs/gentoo/user/troubleshooting.md
View File

@ -16,11 +16,11 @@ _If successful, you will be greated with the following screen_
![IPXE Boot Menu](/media/user-guide/workstations/gentoo_boot_menu.png)
## Run MEM Test
1. [Boot into IPXE](/user-guide/project-setup/workstations/troubleshooting.md#run-mem-test)
1. [Boot into IPXE](/gentoo/user/troubleshooting.md#run-mem-test)
2. Select “Run MemTest”
## Chrooting into the root drive (for recovery)
1. [Boot into IPXE](/user-guide/project-setup/workstations/troubleshooting.md#run-mem-test)
1. [Boot into IPXE](/gentoo/user/troubleshooting.md#run-mem-test)
2. Select Gentoo Installer (Blender Institute Customized)
3. Wait for Gentoo Installer to boot ![Gentoo Installer](/media/user-guide/workstations/gentoo_installer_boot.png)
4. Use CTR+C to cancel Installer
@ -30,7 +30,7 @@ _If successful, you will be greated with the following screen_
## Recovery/Inspection of Linux Kernel
1. [Follow steps in Chrooting into the root drive](/user-guide/project-setup/workstations/troubleshooting.md#chrooting-into-the-root-drive-for-recovery)
1. [Follow steps in Chrooting into the root drive](/gentoo/user/troubleshooting.md#chrooting-into-the-root-drive-for-recovery)
2. Ensure the mount the boot drive is mounted **`mount /boot`**
3. Go into the kernel source dir **`cd /usr/src/linux`**
4. Use `make menuconfig` to enter linux kernel configuration

4
docs/pipeline-overview/organization/infrastructure.md
View File

@ -10,8 +10,8 @@ Artists at Blender Studio use Linux workstations, running Gentoo Linux. While th
Artist workstations double as clients for the render farm.
* [**Link to reference manual**](/user-guide/project-setup/workstations/introduction.md)
* [**Link to setup guide**](/td-guide/workstations/overview.md)
* [**Link to reference manual**](/gentoo/user/introduction.md)
* [**Link to setup guide**](/gentoo/td/overview.md)
## Shared storage
We use two shared drives