diff --git a/web/project-website/content/usage/job-compiler-scripts/_index.md b/web/project-website/content/usage/job-types/_index.md similarity index 90% rename from web/project-website/content/usage/job-compiler-scripts/_index.md rename to web/project-website/content/usage/job-types/_index.md index 9ab60c86..65b7e0cc 100644 --- a/web/project-website/content/usage/job-compiler-scripts/_index.md +++ b/web/project-website/content/usage/job-types/_index.md @@ -1,10 +1,13 @@ --- -title: Job Compiler Scripts +title: Job Types weight: 10 --- -Flamenco uses *job compiler scripts* to convert a job definition (like "*render -this Blend file*") into concrete tasks that can be executed by workers. +Flamenco uses JavaScript files called *job compiler scripts* or two things. They + +- 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 @@ -50,9 +53,9 @@ compiler scripts][built-in-scripts] as examples. ## Task Types -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*. +Each Flamenco task has a *task type*. This is a broad indicator of the kind of +work this task encompasses. The task's type determines which worker is allowed +to execute the task. 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 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 scripts, you can follow these types or make them up yourself. Don't forget to configure your workers to run them! diff --git a/web/project-website/content/usage/worker-configuration/_index.md b/web/project-website/content/usage/worker-configuration/_index.md index fc11ef46..bcc88901 100644 --- a/web/project-website/content/usage/worker-configuration/_index.md +++ b/web/project-website/content/usage/worker-configuration/_index.md @@ -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 tasks this Worker will get. See [task types][task-types] for more info. -[scripts]: {{< ref "usage/job-compiler-scripts/_index.md" >}} -[task-types]: {{< ref "usage/job-compiler-scripts/_index.md" >}}#task-types +[scripts]: {{< ref "usage/job-types" >}} +[task-types]: {{< ref "usage/job-types" >}}#task-types ## Worker Local Files diff --git a/web/project-website/content/what-is-new/_index.md b/web/project-website/content/what-is-new/_index.md index 1a101145..6a679082 100644 --- a/web/project-website/content/what-is-new/_index.md +++ b/web/project-website/content/what-is-new/_index.md @@ -16,6 +16,6 @@ Compared to version 2, Flamenco 3: - supports [custom job types][custom-jobs] written in JavaScript. - 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 >}}