for-users: document background tasks (#79757)#5
Open
martinrode wants to merge 1 commit into
Open
Conversation
Charlotte (#79757) asked for a comprehensive user-facing article on
fylr's background tasks under additional-features.
New page covers:
- What background tasks are and why a user would reach for them
- Where the Task Manager lives (tray icon in the header)
- How to create a task — pick a Module, give it a Title, fill the
per-module parameters, save, walk away
- The three end-user-relevant modules and their parameters:
* Metadata — re-apply a mapping, optionally limited by a search, with
merge-vs-override and tag-set/unset options
* Delete Objects — bulk delete from a search, with the delete-policy
choice between "also delete linked" and "unlink"
* Set / Unset Tags — bulk tag operation from a search
- The Task Manager list (Module / Title / Status / Started / Finished /
Next Run) and how to read it, including where the task log lives when
something fails
- Deleting old task receipts vs cancelling a running task
- The system.task system right and the rule that module-level operations
still require their own underlying permissions (no rights bypass)
Two hint blocks:
- a warning to spot-check the search filter before bulk-delete, since a
task with the wrong filter can affect far more records than intended
- a note that tasks are user-scoped, with system.root being the
exception that sees everyone's tasks
The page is added to SUMMARY.md under
FOR USERS > Additional Features, next to Change History, matching the
location requested in the ticket. The page style follows the existing
user-facing articles (change-history.md, lists.md): short intro,
parameter bullets, hint callouts for caveats, a Required Permissions
block at the end.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves Trac #79757: charlotte asked for a comprehensive user-facing article on fylr's background tasks under
for-users/additional-features/.New page (
for-users/additional-features/background-tasks.md) walks users through:system.tasksystem right and the rule that module-level operations still require the underlying permissionsIncludes two hint callouts: a
warningon bulk-delete-filter spot-checking, and aninfoblock on the user-scope rule (system.root sees everyone's).Linked into
SUMMARY.mdunder FOR USERS > Additional Features, next to Change History.Style matches existing user-facing articles (change-history.md, lists.md): short intro, parameter bullets, hint blocks, Required Permissions section at the end.
Test plan
🤖 Generated with Claude Code