diff --git a/website/docs/artist_my_tasks_page.md b/website/docs/artist_my_tasks_page.md new file mode 100644 index 00000000..8d1869bb --- /dev/null +++ b/website/docs/artist_my_tasks_page.md @@ -0,0 +1,97 @@ +--- +id: artist_my_tasks_page +title: Tasks (Home) Page +sidebar_label: Tasks (Home) Page +--- + +:::tip +Use the shortcut H+H (double press H) to navigate to the home page from anywhere. +::: + +![Tasks overview](assets/home_tasks/home_tasks_main.png) + +## Overview + +Welcome to your Tasks home page! This is where you'll land when you first log in and is likely to be your central hub for managing your tasks. Designed specifically for artists, it provides a clear view of your assignments, their statuses, and allows you to collaborate by leaving comments and receiving feedback. + +:::note +This page displays all your **assigned** tasks. To see the complete project context, open it in the browser or log in with an admin or manager account. +::: + +## Board View + +The task board, also known as Kanban, visually organizes your tasks by status. Click a task to open the details panel, revealing more information like its activity feed, versions, and attributes. Within the activity feed, you can discuss the task and leave comments. [Read more about the activity feed](artist_activity_feed). + +### Status Management + +You can change a task's status by either dragging it to a different column on the board or selecting a new status from the dropdown menu within its details panel. + +![Drag tasks between columns](assets/home_tasks/home_tasks_dragging.png) + +:::tip +Boost your efficiency! Select multiple tasks simultaneously and either drag them together to update their status or manage them all at once through the details panel. + +![Select multiple tasks](assets/home_tasks/home_tasks_dragging_multiple.png) +::: + +### Board Organisation + +You can minimize the Kanban board by collapsing individual status columns. Click the small button located in the top right corner of each column to collapse it. + +![Collapse status columns](assets/home_tasks/home_tasks_collapse.png) + +### Thumbnails + +While we recommend using thumbnails for published versions, you can easily update any task's thumbnail by dragging a file directly onto its details panel. + +![Drop images on tasks](assets/home_tasks/home_tasks_dropping.png) + +:::note +By default, task thumbnails display the latest version's thumbnail. However, if a custom thumbnail has been set for a specific task, that will take precedence. +::: + +## Sorting and Filtering + +The Tasks page has powerful sorting and filtering features and we intend to add more overtime based on user feedback. + +### Sort By + +Sort tasks by multiple types and in different directions. + +For example, you might sort by folder name to group related tasks. However, if you have multiple tasks within a folder named similarly (like "sh020"), you can add a secondary sort by task name for a more granular view. + +![Sort tasks](assets/home_tasks/home_tasks_sortby.png) + +### Group By + +Group tasks by any relevant field, like project or type. This is especially helpful for managing tasks across different projects or bringing similar tasks together for a clearer view. Grouping even works alongside sorting, so you can sort your grouped tasks for ultimate organization! + +![Group tasks](assets/home_tasks/home_tasks_groupby.png) + +### Assignee View + +Admins and managers can view other users' boards. This provides a quick way to see what tasks are assigned to specific artists and their current workload. + +![Group tasks](assets/home_tasks/home_tasks_assignee_select.png) + +:::note +Stay tuned! We're developing a feature that will allow you to select all users simultaneously. +::: + +## List View + +Switch to the list view for a data-rich, minimalist layout that prioritizes efficiency. This view is perfect for users with heavy workloads, and it offers full keyboard support for lightning-fast task selection. Plus, grouping lets you organize your tasks and collapse them for a cleaner, focused workspace. + +![Group tasks](assets/home_tasks/home_tasks_list.png) + +:::tip +To collapse or expand a group in the list view, simply hover over the group and press To collapse or expand a group in the list view, simply hover over the group and press **C** on your keyboard. on your keyboard. + +![Group tasks](assets/home_tasks/home_tasks_list_collapse.png) +::: + +:::tip +In the list view, you can change a task's status directly. Just click the status icon next to the task to see the available options and choose the new one. + +![Group tasks](assets/home_tasks/home_tasks_list_status.png) +::: diff --git a/website/docs/assets/home_tasks/home_tasks_assignee_select.png b/website/docs/assets/home_tasks/home_tasks_assignee_select.png new file mode 100644 index 00000000..009a936e Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_assignee_select.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_collapse.png b/website/docs/assets/home_tasks/home_tasks_collapse.png new file mode 100644 index 00000000..29ba457d Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_collapse.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_dragging.png b/website/docs/assets/home_tasks/home_tasks_dragging.png new file mode 100644 index 00000000..6e925da5 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_dragging.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_dragging_multiple.png b/website/docs/assets/home_tasks/home_tasks_dragging_multiple.png new file mode 100644 index 00000000..2ba7f631 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_dragging_multiple.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_dropping.png b/website/docs/assets/home_tasks/home_tasks_dropping.png new file mode 100644 index 00000000..e9d546b4 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_dropping.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_groupby.png b/website/docs/assets/home_tasks/home_tasks_groupby.png new file mode 100644 index 00000000..91d31cd4 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_groupby.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_list.png b/website/docs/assets/home_tasks/home_tasks_list.png new file mode 100644 index 00000000..37127a69 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_list.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_list_collapse.png b/website/docs/assets/home_tasks/home_tasks_list_collapse.png new file mode 100644 index 00000000..d35689b2 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_list_collapse.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_list_status.png b/website/docs/assets/home_tasks/home_tasks_list_status.png new file mode 100644 index 00000000..3c8b1b43 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_list_status.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_main.png b/website/docs/assets/home_tasks/home_tasks_main.png new file mode 100644 index 00000000..1c7beb81 Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_main.png differ diff --git a/website/docs/assets/home_tasks/home_tasks_sortby.png b/website/docs/assets/home_tasks/home_tasks_sortby.png new file mode 100644 index 00000000..6c3a297f Binary files /dev/null and b/website/docs/assets/home_tasks/home_tasks_sortby.png differ diff --git a/website/sidebars.js b/website/sidebars.js index 40835625..13a97935 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1,195 +1,186 @@ function sorted(a, b) { - const nameA = typeof a == 'string' ? a : (a.items[0] || a.label); - const nameB = typeof b == 'string' ? b : (b.items[0] || b.label); - return nameA > nameB ? 1 : -1; + const nameA = typeof a == "string" ? a : a.items[0] || a.label; + const nameB = typeof b == "string" ? b : b.items[0] || b.label; + return nameA > nameB ? 1 : -1; } module.exports = { - artist: [ - { - type: "category", - collapsed: false, - label: "General", - items: [ - "artist_getting_started", - "artist_concepts", - "artist_publish", - { - type: "category", - collapsed: true, - label: "Tools", - link: { type: "doc", id: "artist_tools" }, - items: [ - "artist_tools_creator", - "artist_tools_loader", - "artist_tools_library_loader", - "artist_tools_publisher", - "artist_tools_inventory", - "artist_tools_workfiles", - "artist_tools_look_assigner", - ], - }, + artist: [ + { + type: "category", + collapsed: false, + label: "General", + items: [ + "artist_getting_started", + "artist_concepts", + "artist_publish", + { + type: "category", + collapsed: true, + label: "Tools", + link: { type: "doc", id: "artist_tools" }, + items: [ + "artist_tools_creator", + "artist_tools_loader", + "artist_tools_library_loader", + "artist_tools_publisher", + "artist_tools_inventory", + "artist_tools_workfiles", + "artist_tools_look_assigner", + ], + }, + ], + }, + { + type: "category", + collapsed: false, + label: "Integrations", + items: [ + "addon_3dsmax_artist", + "addon_aftereffects_artist", + "addon_blender_artist", + "addon_resolve_artist", + { + type: "category", + label: "Ftrack", + items: [ + "addon_ftrack_artist", + "addon_ftrack_manager", + "addon_ftrack_actions", + ], + }, + "addon_harmony_artist", + "addon_hiero_artist", + "addon_houdini_artist", + "addon_kitsu_artist", + { + type: "category", + label: "Maya", + items: [ + "addon_maya_artist", + "addon_maya_multiverse_artist", + "addon_maya_yeti_artist", + "addon_maya_xgen_artist", + "addon_maya_arnold_artist", + "addon_maya_vray_artist", + "addon_maya_redshift_artist", + ], + }, + "addon_nuke_artist", + "addon_photoshop_artist", + "addon_substancepainter_artist", + "addon_tvpaint_artist", + "addon_unreal_artist", + "addon_wrap_artist", + "addon_openrv_artist", + { + type: "category", + label: "Aquarium", + items: ["addon_aquarium_artist", "addon_aquarium_manager"], + }, + ].sort(sorted), + }, + { + type: "category", + collapsed: false, + label: "Production Tracking", + items: ["artist_my_tasks_page", "artist_activity_feed"], + }, ], - }, - { - type: "category", - collapsed: false, - label: "Integrations", - items: [ - "addon_3dsmax_artist", - "addon_aftereffects_artist", - "addon_blender_artist", - "addon_resolve_artist", - { - type: "category", - label: "Ftrack", - items: [ - "addon_ftrack_artist", - "addon_ftrack_manager", - "addon_ftrack_actions", - ], - }, - "addon_harmony_artist", - "addon_hiero_artist", - "addon_houdini_artist", - "addon_kitsu_artist", - { - type: "category", - label: "Maya", - items: [ - "addon_maya_artist", - "addon_maya_multiverse_artist", - "addon_maya_yeti_artist", - "addon_maya_xgen_artist", - "addon_maya_arnold_artist", - "addon_maya_vray_artist", - "addon_maya_redshift_artist", - ], - }, - "addon_nuke_artist", - "addon_photoshop_artist", - "addon_substancepainter_artist", - "addon_tvpaint_artist", - "addon_unreal_artist", - "addon_wrap_artist", - "addon_openrv_artist", - "addon_traypublisher_artist", - { - type: "category", - label: "Aquarium", - items: [ - "addon_aquarium_artist", - "addon_aquarium_manager", - ], - }, - ].sort(sorted), - }, - { - type: "category", - collapsed: false, - label: "Production Tracking", - items: ["artist_activity_feed"], - }, -], -Admin: [ - "system_introduction", - { - type: "category", - label: "AYON server", - items: [ - "admin_server_deployment", - "admin_server_configuration", - "admin_server_installing_addons", - "admin_server_provisioning", - "admin_server_services", - "admin_server_email", + Admin: [ + "system_introduction", + { + type: "category", + label: "AYON server", + items: [ + "admin_server_deployment", + "admin_server_configuration", + "admin_server_installing_addons", + "admin_server_provisioning", + "admin_server_services", + "admin_server_email", + ], + }, + { + type: "category", + label: "AYON Launcher", + items: ["admin_launcher_distribute", "admin_launcher_run"], + }, + { + type: "category", + label: "Configuration", + items: [ + "admin_environment", + "admin_settings", + "admin_colorspace", + "admin_settings_project_anatomy", + "addon_core_settings", + "addon_applications_admin", + ], + }, + { + type: "category", + label: "Integrations", + items: [ + "addon_3dsmax_admin", + "addon_aftereffects_admin", + "addon_blender_admin", + "addon_resolve_admin", + "addon_deadline_admin", + "addon_ftrack_admin", + "addon_harmony_admin", + "addon_hiero_admin", + "addon_houdini_admin", + "addon_keycloak_admin", + "addon_maya_admin", + "addon_nuke_admin", + "addon_photoshop_admin", + "addon_site_sync_admin", + "addon_slack_admin", + "addon_sso_admin", + "addon_substancepainter_admin", + "addon_tvpaint_admin", + "addon_unreal_admin", + "addon_kitsu_admin", + "addon_clockify_admin", + "addon_traypublisher_admin", + "addon_wrap_admin", + "addon_syncsketch_admin", + "addon_flow_admin", + "addon_aquarium_admin", + ].sort(sorted), + }, + "admin_releases", + "admin_import_openpype_project", ], - }, - { - type: "category", - label: "AYON Launcher", - items: ["admin_launcher_distribute", "admin_launcher_run"], - }, - { - type: "category", - label: "Configuration", - items: [ - "admin_environment", - "admin_settings", - "admin_colorspace", - "admin_settings_project_anatomy", - "addon_core_settings", - "addon_applications_admin", + Dev: [ + "dev_introduction", + "dev_requirements", + { + type: "category", + label: "AYON launcher", + items: [ + "dev_launcher", + "dev_launcher_build_windows", + "dev_launcher_build_macos", + "dev_launcher_build_linux", + ], + }, + "dev_dev_mode", + "dev_testing", + "dev_contribute", + { + type: "category", + label: "Hosts integrations", + items: ["dev_host_implementation", "dev_publishing"], + }, + "dev_deadline", + "dev_colorspace", + "dev_event_system", + { + type: "category", + label: "Integrations", + items: ["addon_aquarium_developer"].sort(sorted), + }, ], - }, - { - type: "category", - label: "Integrations", - items: [ - "addon_3dsmax_admin", - "addon_aftereffects_admin", - "addon_blender_admin", - "addon_resolve_admin", - "addon_deadline_admin", - "addon_ftrack_admin", - "addon_harmony_admin", - "addon_hiero_admin", - "addon_houdini_admin", - "addon_keycloak_admin", - "addon_maya_admin", - "addon_nuke_admin", - "addon_photoshop_admin", - "addon_site_sync_admin", - "addon_slack_admin", - "addon_sso_admin", - "addon_substancepainter_admin", - "addon_tvpaint_admin", - "addon_unreal_admin", - "addon_kitsu_admin", - "addon_clockify_admin", - "addon_traypublisher_admin", - "addon_wrap_admin", - "addon_syncsketch_admin", - "addon_flow_admin", - "addon_aquarium_admin" - ].sort(sorted), - }, - "admin_releases", - "admin_import_openpype_project", -], -Dev: [ - "dev_introduction", - "dev_requirements", - { - type: "category", - label: "AYON launcher", - items: [ - "dev_launcher", - "dev_launcher_build_windows", - "dev_launcher_build_macos", - "dev_launcher_build_linux", - ], - }, - "dev_dev_mode", - "dev_testing", - "dev_contribute", - { - type: "category", - label: "Hosts integrations", - items: [ - "dev_host_implementation", - "dev_publishing", - ], - }, - "dev_deadline", - "dev_colorspace", - "dev_event_system", - { - type: "category", - label: "Integrations", - items: [ - "addon_aquarium_developer" - ].sort(sorted), - }, -], };