55 Commits

Author SHA1 Message Date
Sybren A. Stüvel
eb763a605b Website: document absolute vs. relative asset paths
Flamenco treats assets differently, depending on whether they're referenced
by an absolute or a blendfile-relative path. This is now actually
documented.
2024-07-23 09:33:52 +02:00
Sybren A. Stüvel
30c92d2854 Website: document when the oom_score_adjust option was added 2024-04-16 10:46:04 +02:00
Sybren A. Stüvel
e2bca9ad61 Worker: add configuration for Linux out-of-memory killer
Add a Worker configuration option to configure the Linux out-of-memory
behaviour. Add `oom_score_adjust=500` to `flamenco-worker.yaml` to increase
the chance that Blender gets killed when the machine runs out of memory,
instead of Flamenco Worker itself.
2024-04-15 17:21:11 +02:00
Sybren A. Stüvel
1fee086cef Website: add MQTT prefix to table of MQTT topics 2024-03-13 19:16:40 +01:00
Sybren A. Stüvel
041f792594 Website: document Flamenco's MQTT support 2024-03-13 19:10:51 +01:00
Sybren A. Stüvel
5b17fb24fd Website: clarify the worker configuration files
Add a little intro that explains that there are multiple config files. And
add a section that explains that the worker-specific files are not to be
edited, just deleted.
2024-02-22 13:05:22 +01:00
Sybren A. Stüvel
99062d42ac Website: add draft documentation for failure handling
The documentation isn't complete yet, I want to have a nice flow diagram
in there as well. But it's a start.
2024-02-22 13:00:24 +01:00
Sybren A. Stüvel
f464aea137 Manager & website: provide more helpful info when Worker auth fails
Provide more useful info when a Worker tries to communicate but fails
the authentication check. The message about this is now more friendly
and links to a new FAQ entry at
https://flamenco.blender.org/faq/#what-does-unknown-worker-is-trying-to-communicate-mean
2024-01-25 14:19:24 +01:00
Sybren A. Stüvel
13a793743f Website: add documentation for worker tags and sleep schedule
The worker tags and sleep schedule features are now actually documented.
2024-01-25 12:15:29 +01:00
Sybren A. Stüvel
fd29f58c2e Website: move info about cloud storage into the main documentation
Move the info about using cloud storage from the FAQ to the Shared
Storage chapter of the documentation. The FAQ entry of the topic is now
reduced to a short answer + a link to the moved documentation.
2024-01-23 10:27:20 +01:00
Sybren A. Stüvel
c284b5fa67 Website: slight wording change
Change "...with the configured status code" to "...with a configurable
status code", as there hasn't been any explanation of this configurability
yet.
2023-11-06 14:56:23 +01:00
Sybren A. Stüvel
3b7847c445 Website: Expand the Shaman documentation
- Describe how to enable/disable the Shaman in more detail,
- adjust the link to Stack Exchange w.r.t. SAMBA & symlinks, and
- include a table of contents at the top of the page.
2023-11-03 16:00:39 +01:00
dblanque
36e90f0066 Website: Update docs for Shaman + SAMBA
Add documentation on Shaman with SAMBA requiring symlinks.
This has been tested with Linux and Windows Clients.
2023-11-03 15:50:48 +01:00
Sybren A. Stüvel
06f2a2bc29 Rename cli command to exec and document it
The `cli` word, to me, implies too much that it's run via a shell, which
it isn't. Renaming to `exec` resolves that.
2023-10-31 10:17:16 +01:00
Sybren A. Stüvel
aa4d3cff75 Windows: check user's system privileges when Shaman is enabled
Symbolic links on Windows require some special user privilege, and
Shaman can now check for this at startup. Hopefully this helps in guiding
people towards a working Shaman system.
2023-10-16 21:36:16 +02:00
Sybren A. Stüvel
72ec9501b9 Website: add restart_exit_code to the worker config documentation 2023-08-14 17:40:36 +02:00
Sybren A. Stüvel
9a406f2e33 Website: better documentation of worker actions
Instead of explaining all the menu items, just explain the basic actions
(shut down, restart, sleep, wake up), and explain the 'after task is
finished' vs. 'immediately' separately.
2023-08-14 16:14:44 +02:00
Sybren A. Stüvel
0364a7ad79 Merge pull request 'Restartable workers' (#104242) from restartable-workers into main 2023-08-14 16:01:33 +02:00
Sybren A. Stüvel
9009b60379 Website: add list of supported commands
Document the commands currently implemented in Flamenco Worker.
2023-08-09 10:55:58 -07:00
Michael Cook
dd34d538ec fix links in mgr configuration doc section (#104226)
Actually include the link URLs in the documentation.

Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104226
2023-07-03 11:11:44 +02:00
Adi Sage
8a5c099d57 Website: Documenting descriptions for Job and Task Statuses in the documentation webpage
This is a comprehensive list of all possible job and task statuses,
along with a brief description of each status
and a list of possible next statuses.

Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104214
2023-06-22 19:41:51 +02:00
Adi Sage
0a2d7d3361 Website: Fix a typo in the docs for Job Types
In the first line of description for Job Types the word 'or' is changed to 'for'.

Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104212
2023-05-23 11:44:38 +02:00
Francesco Siddi
8da71a323f Website: Content refactor
- Hide sidebar in pages visible in the top nav, except for Docs
- Create an "About" page, featuring the design principles
- Update components illustration
- Move the "What's new in Flamenco 3" page in the FAQ
- Add TOD to the FAQ
- Tweak homepage layout to use two columns
- Styling: slightly reduce max page width (around 12 words per line)
- Styling: tweak padding for titles and paragraphs
2023-05-06 03:34:54 +02:00
Sybren A. Stüvel
42878e169f Web: document the need to use drive letters on Windows
Flamenco doesn't support UNC notation. Now that's actually documented.
2023-04-20 10:44:25 +02:00
Dylan Gabriel Blanqué
c61530e9cc Doc: custom job types, bat-pack error, two-way variables (#104202)
Additions to the documentation:

- Page for collecting custom job types, with multi-pass job type.
- BAT Pack Error Message solution on Windows.
- Clarificationof two-way variable usage in jobs.

Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104202
2023-04-14 10:59:57 +02:00
Sybren A. Stüvel
55bfc8db88 Website: update URLs to point to projects.blender.org 2023-02-07 17:41:26 +01:00
Sybren A. Stüvel
80fee0837b Documentation: expand the 'Variables' page
Expand the 'Variables' page so that it links to the two-way variables
page from within the body of text. Having the link in only the side-bar
was too easy to miss.
2022-12-06 12:57:30 +01:00
Sybren A. Stüvel
9dbeddba35 Documentation: remove use of "expandable" sections
Move the "Custom Job Types" expandable section to its own, normal
section.

The expandable sections in the docs aren't that clear, visually. It's
easy to miss that they can be expanded. This was the only use of this
feature.
2022-12-06 12:47:42 +01:00
Sybren A. Stüvel
f75a8f4c65 Website: remove the "what is new" link
Remove the "what is new" link, because it's not that relevant for a quick-
start page. Also it got lost a bit between the videos and felt out of
place.
2022-11-05 10:29:19 +01:00
Sybren A. Stüvel
c174951cd2 Website: remove "videos coming soon" promise
They may or may not be coming soon.
2022-11-05 10:28:40 +01:00
Sybren A. Stüvel
7816f218d5 Website: add BCON22 presentation to quickstart
Add the Blender Conference presentation video to the Quickstart page.
2022-11-05 10:27:57 +01:00
Sybren A. Stüvel
b23d2c2a89 Website: better explanation of non-Shaman storage options 2022-11-05 10:26:10 +01:00
Sybren A. Stüvel
a3e3d7af16 Website: clarify some things in the worker configuration doc 2022-09-29 10:51:53 +02:00
Sybren A. Stüvel
5d8528d11a Website: include example flamenco-manager.yaml
Sometimes the setup assistant doesn't work (port already in use, Blender
not installed), so having an example file will make it possible to still
start Flamenco.
2022-09-13 15:29:02 +02:00
Sybren A. Stüvel
f41558b93f Website: update for the 3.0 release
Remove mentions/disclaimers that Flamenco is in beta or in "heavy
development". Some small text fixes.
2022-09-12 16:52:03 +02:00
Sam Miller
5a25952167 Website: Fix documentation of Flamenco Worker YAML task types list
The example on the project website is incorrect:

```
task_types: blender, ffmpeg, file-management, misc
```

It results in an error:

```
loading configuration: yaml: unmarshal errors:\n line 2:
  cannot unmarshal ||str "blender..." into []string
```

The fix seems to be adding square brackets around the list of comma
delineated tasks:

```
task_types: [blender, ffmpeg, file-management, misc]
```

This results in output with the confirmation that
`taskType=["blender","ffmpeg","file-management","misc"]`
2022-08-31 15:42:58 +02:00
Sybren A. Stüvel
4761e3d76e Website: replace note-hint with 'expand' block
It's slightly less distracting now.
2022-08-30 18:03:17 +02:00
Sybren A. Stüvel
d88587f989 Website: split up variables section & adjust for argument split
Split up the "Variables" section, and adjust the wording for the splitting
of `{blender}` into `{blender}` and `{blenderArgs}` (rFe5a20425c474).
2022-08-30 18:01:10 +02:00
Sybren A. Stüvel
22aa041ec1 Allow relative render output root paths
Add a new `abspath(path)` function to the add-on, for use in job type
settings. With this, the "simple blender render" job can support relative
paths for the "render output root" setting, and still have an absolute
final "render output path".
2022-08-25 13:14:48 +02:00
Sybren A. Stüvel
945e3060f4 Website: document location of custom job type scripts 2022-08-25 12:32:29 +02:00
Sybren A. Stüvel
97243d15f1 Website: document path separator replacement in two-way vars docs
Document the path separator replacement introduced in
rF63c60a5b15b362e5a951345962d0a6fcbc81c101
2022-08-25 12:27:41 +02:00
Sybren A. Stüvel
d239350ee4 Website: cleanup, reformat markdown table 2022-08-25 11:11:51 +02:00
Sybren A. Stüvel
0c69b5c41b Website: document variables 2022-08-25 11:11:00 +02:00
Sybren A. Stüvel
9d5c269398 Website: add Shaman documentation 2022-08-07 07:54:04 -07:00
Francesco Siddi
6e67f81804 Website: Add setup video for Windows 2022-08-03 14:32:29 +02:00
Francesco Siddi
4b434b785a Website: Rename "Getting Started" to "Quickstart" 2022-08-03 12:55:05 +02:00
Sybren A. Stüvel
6022f781d3 Website: add download page & links
Add links to download the latest version of Flamenco. Which version is
offered can be managed in `web/project-website/data/flamenco.yaml`.
2022-08-02 12:56:42 +02:00
Sybren A. Stüvel
efff61c454 Website: add some documentation about the storage options
Basically it's "simple, efficient, isolated -- pick two".
2022-08-01 16:36:29 +02:00
Sybren A. Stüvel
b1f13c47f7 Website: add some documentation for the shared storage
This still needs expanding.
2022-07-29 11:39:31 +02:00
Sybren A. Stüvel
0cca867195 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.
2022-07-29 11:15:15 +02:00