Website: move job-compiler-scripts to job-types

The concept of "job types" is more important. The fact that they are
defined by scripts is secondary. I've also added more documentation about
the settings & task types.
This commit is contained in:
Sybren A. Stüvel 2022-07-29 11:10:10 +02:00
parent 139d635695
commit 0cca867195
3 changed files with 16 additions and 9 deletions

View File

@ -1,10 +1,13 @@
--- ---
title: Job Compiler Scripts title: Job Types
weight: 10 weight: 10
--- ---
Flamenco uses *job compiler scripts* to convert a job definition (like "*render Flamenco uses JavaScript files called *job compiler scripts* or two things. They
this Blend file*") into concrete tasks that can be executed by workers.
- define a *job type*, with its own set of settings, and
- convert a job of this type (like "*render this Blend file*") into concrete
tasks that can be executed by workers.
## Example ## Example
@ -50,9 +53,9 @@ compiler scripts][built-in-scripts] as examples.
## Task Types ## Task Types
In the above example code, you can see calls like `author.Task("echo", "misc")`. Each Flamenco task has a *task type*. This is a broad indicator of the kind of
The first parameter is the task name, which will be shown in the web interface work this task encompasses. The task's type determines which worker is allowed
and can help to identify each task. The second parameter is the *task type*. to execute the task.
The following task types are defined by the standard job compiler scripts: The following task types are defined by the standard job compiler scripts:
@ -69,6 +72,10 @@ FFmpeg, while the Blender tasks are left for the big ones. By default the
workers can run all the above task types. See [worker workers can run all the above task types. See [worker
configuration][worker-config] for more info. configuration][worker-config] for more info.
In the above example code, you can see calls like `author.Task("echo", "misc")`.
The first parameter is the task name, which will be shown in the web interface
and can help to identify each task. The second parameter is the *task type*.
In the end, these are just strings. When you create your own job compiler In the end, these are just strings. When you create your own job compiler
scripts, you can follow these types or make them up yourself. Don't forget to scripts, you can follow these types or make them up yourself. Don't forget to
configure your workers to run them! configure your workers to run them!

View File

@ -17,8 +17,8 @@ The task types are determined by the [job compiler scripts][scripts]. The ones
listed here are in use by the default scripts. These determine which kind of listed here are in use by the default scripts. These determine which kind of
tasks this Worker will get. See [task types][task-types] for more info. tasks this Worker will get. See [task types][task-types] for more info.
[scripts]: {{< ref "usage/job-compiler-scripts/_index.md" >}} [scripts]: {{< ref "usage/job-types" >}}
[task-types]: {{< ref "usage/job-compiler-scripts/_index.md" >}}#task-types [task-types]: {{< ref "usage/job-types" >}}#task-types
## Worker Local Files ## Worker Local Files

View File

@ -16,6 +16,6 @@ Compared to version 2, Flamenco 3:
- supports [custom job types][custom-jobs] written in JavaScript. - supports [custom job types][custom-jobs] written in JavaScript.
- comes bundled with FFmpeg; you only need to install Blender. - comes bundled with FFmpeg; you only need to install Blender.
[custom-jobs]: {{< ref "/usage/job-compiler-scripts" >}} [custom-jobs]: {{< ref "usage/job-types" >}}
{{< button size="large" relref="usage/getting-started/" >}}Get Started{{< /button >}} {{< button size="large" relref="usage/getting-started/" >}}Get Started{{< /button >}}