Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken and missing links and titles. #105

Merged
merged 9 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions website/docs/addon_3dsmax_admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: addon_3dsmax_admin
title: 3Ds Max Admin Docs
sidebar_label: 3Ds Max
---

:::note Work in progress
This part of documentation is still work in progress.
:::
4 changes: 2 additions & 2 deletions website/docs/addon_3dsmax_artist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: addon_3dsmax_artist
title: 3dsmax
sidebar_label: 3dsmax
title: 3Ds Max Artist Docs
sidebar_label: 3Ds Max
---

:::note Work in progress
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_aftereffects_admin.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: addon_aftereffects_admin
title: AfterEffects Admin docs
sidebar_label: AfterEffects
title: After Effects Admin Docs
sidebar_label: After Effects
---

import Tabs from '@theme/Tabs';
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_aftereffects_artist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: addon_aftereffects_artist
title: AfterEffects
sidebar_label: AfterEffects
title: After Effects Artist Docs
sidebar_label: After Effects
---
<!-- based on PS implementation, same principle and menu -->
## Available Tools
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_blender_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_blender_admin
title: Blender Admin docs
title: Blender Admin Docs
sidebar_label: Blender
---

Expand Down Expand Up @@ -95,7 +95,7 @@ Enable it to define a default unit scale.
//

### Workfile Builder
Find more informations about the Workfile Builder in the [Nuke Documentation](admin_hosts_nuke#workfile-builder).
Find more informations about the Workfile Builder in the [Nuke Documentation](addon_nuke_admin.md#workfile-builder).

### Publish plugins
Find here the publish plugins.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_blender_artist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_blender_artist
title: Blender
title: Blender Artist Docs
sidebar_label: Blender
---

Expand Down
5 changes: 4 additions & 1 deletion website/docs/addon_clockify_admin.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
id: addon_clockify_admin
title: Clockify Admin docs
title: Clockify Admin Docs
sidebar_label: Clockify
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

:::note Work in progress
This part of documentation is still work in progress.
:::

2 changes: 1 addition & 1 deletion website/docs/addon_deadline_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_deadline_admin
title: Deadline Admin docs
title: Deadline Admin Docs
sidebar_label: Deadline
---

Expand Down
6 changes: 3 additions & 3 deletions website/docs/addon_ftrack_actions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: addon_ftrack_actions
title: Ftrack Actions
sidebar_label: Ftrack actions
sidebar_label: Ftrack Actions
---

Actions are small useful tools that help artists, managers and administrators.
Expand Down Expand Up @@ -73,7 +73,7 @@ Project Manager or Supervisor must set project's applications during project pre
Synchronization to AYON is key process to keep AYON data updated. Action updates selected entities (Project, Shot, Sequence, etc.) and all nested entities to AYON database. If action is successfully finished [Sync Hier Attrs](#sync-hier-attrs) action is triggered.

There are 2 versions of **Sync to AYON**, first labeled as **server** second as **local**.
* **server** version will be processed with [event server](module_ftrack.md#event-server)
* **server** version will be processed with [event server](addon_ftrack_admin#event-server)
* **local** version will be processed with user's AYON tray application

It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.
Expand All @@ -85,7 +85,7 @@ It is recommended to use **local** version if possible to avoid unnecessary dece
Synchronization to AYON of Ftrack's hierarchical Custom attributes is a bit complicated so we decided to split synchronization process into 2 actions. This action updates hierarchical Custom attributes of selected entities (Project, Shot, Sequence, etc.) and all their nested entities to pipeline database. This action is also triggered automatically after successfully finished [Sync To AYON](#sync-to-ayon) action.

There are 2 versions of **Sync Hier Attrs** first labeled as **server** second as **local**.
* **server** version will be processed with [event server](module_ftrack.md#event-server)
* **server** version will be processed with [event server](addon_ftrack_admin.md#event-server)
* **local** version will be processed with user's AYON application

It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.
Expand Down
14 changes: 7 additions & 7 deletions website/docs/addon_ftrack_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_ftrack_admin
title: Ftrack Admin docs
title: Ftrack Admin Docs
sidebar_label: Ftrack
---

Expand All @@ -16,17 +16,17 @@ Ftrack is currently the main project management option for AYON. This documentat
If you want to connect Ftrack to AYON you might need to make few changes in Ftrack settings. These changes would take a long time to do manually, so we prepared a few Ftrack actions to help you out. First, you'll need to launch AYON settings, enable [Ftrack module](admin_settings_system.md#Ftrack), and enter the address to your Ftrack server.

### Login
Once your server is configured, restart AYON and you should be prompted to enter your [Ftrack credentials](artist_ftrack.md#How-to-use-Ftrack-in-AYON) to be able to run our Ftrack actions. If you are already logged in to Ftrack in your browser, it is enough to press `Ftrack login` and it will connect automatically.
Once your server is configured, restart AYON and you should be prompted to enter your [Ftrack credentials](addon_kitsu_artist.md#How-to-use-Ftrack-in-AYON) to be able to run our Ftrack actions. If you are already logged in to Ftrack in your browser, it is enough to press `Ftrack login` and it will connect automatically.

For more details step by step on how to login to Ftrack in AYON to go [artist Ftrack login](artist_ftrack.md#How-to-use-Ftrack-in-AYON) documentation.
For more details step by step on how to login to Ftrack in AYON to go [artist Ftrack login](addon_kitsu_artist.md#How-to-use-Ftrack-in-AYON) documentation.

You can only use our Ftrack Actions and publish to Ftrack if each artist is logged in.


### Custom Attributes
After successfully connecting AYON with you Ftrack, you can right-click on any project in Ftrack and you should see a bunch of actions available. The most important one is called `AYON Admin` and contains multiple options inside.

To prepare Ftrack for working with AYON you'll need to run [AYON Admin - Create/Update Custom Attributes](manager_ftrack_actions.md#create-update-custom-attributes), which creates and sets the Custom Attributes necessary for AYON to function.
To prepare Ftrack for working with AYON you'll need to run [AYON Admin - Create/Update Custom Attributes](addon_ftrack_manager.md#create-update-custom-attributes), which creates and sets the Custom Attributes necessary for AYON to function.


## Event Server
Expand Down Expand Up @@ -60,15 +60,15 @@ Events are helpers for automation. They react to Ftrack Web Server events like c

### Sync to AYON

Automatic [synchronization to pipeline database](manager_ftrack.md#synchronization-to-ayon-server).
Automatic [synchronization to pipeline database](addon_ftrack_manager.md#synchronization-to-ayon-server).

This event updates entities on their changes Ftrack. When new entity is created or existing entity is modified. Interface with listing information is shown to users when [synchronization rules](manager_ftrack.md#synchronization-rules) are not met. This event may also undo changes when they might break pipeline. Namely _change name of synchronized entity_, _move synchronized entity in hierarchy_.
This event updates entities on their changes Ftrack. When new entity is created or existing entity is modified. Interface with listing information is shown to users when [synchronization rules](addon_ftrack_manager.md#synchronization-rules) are not met. This event may also undo changes when they might break pipeline. Namely _change name of synchronized entity_, _move synchronized entity in hierarchy_.

### Synchronize Hierarchical and Entity Attributes

Auto-synchronization of hierarchical attributes from Ftrack entities.

Related to [Synchronize to AYON database](manager_ftrack.md#synchronization-to-ayon-server) event _(without it, it makes no sense to use this event)_. Hierarchical attributes must be synchronized with special way so we needed to split synchronization into 2 parts. There are [synchronization rules](manager_ftrack.md#synchronization-rules) for hierarchical attributes that must be met otherwise interface with messages about not meeting conditions is shown to user.
Related to [Synchronize to AYON database](addon_ftrack_manager.md#synchronization-to-ayon-server) event _(without it, it makes no sense to use this event)_. Hierarchical attributes must be synchronized with special way so we needed to split synchronization into 2 parts. There are [synchronization rules](addon_ftrack_manager.md#synchronization-rules) for hierarchical attributes that must be met otherwise interface with messages about not meeting conditions is shown to user.

### Update Hierarchy thumbnails

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_ftrack_artist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_ftrack_artist
title: Ftrack
title: Ftrack Artist Docs
sidebar_label: Artist
---

Expand Down
10 changes: 5 additions & 5 deletions website/docs/addon_ftrack_manager.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_ftrack_manager
title: Ftrack
title: Ftrack Manager
sidebar_label: Project Manager
---

Expand All @@ -12,13 +12,13 @@ Setting project attributes is the key to properly working pipeline.
### New Project
The best practice for creating a new project ready for AYON.
1. First of all you must [create a project](http://ftrack.rtd.ftrack.com/en/stable/using/managing_projects/creating_a_new_project.html) in Ftrack.
2. All the required attributes need to be populated. The easiest way to do it is by using [Prepare Project](manager_ftrack_actions.md#prepare-project) action.
2. All the required attributes need to be populated. The easiest way to do it is by using [Prepare Project](addon_ftrack_actions.md#prepare-project) action.

:::tip
Do not forget to set up `applications` and `tools`, otherwise users won't be able to launch applications.
:::

3. Now you can create Project hierarchy with shots, assets, tasks and others, which has [specific rules](#synchronization-rules). [Create Project Structure](manager_ftrack_actions.md#create-project-structure) action may help you with this step.
3. Now you can create Project hierarchy with shots, assets, tasks and others, which has [specific rules](#synchronization-rules). [Create Project Structure](addon_ftrack_actions.md#create-project-structure) action may help you with this step.
4. Last step is to [synchronize](#synchronization-to-ayon-server) project to AYON database.

:::tip
Expand All @@ -29,9 +29,9 @@ Turn on `auto-sync` attribute on your project in ftrack. That way you'll only ne
This process describes how data from Ftrack will get into AYON server.

### How to synchronize
You can trigger synchronization manually using [Sync To AYON](manager_ftrack_actions.md#sync-to-ayon) action.
You can trigger synchronization manually using [Sync To AYON](addon_ftrack_actions.md#sync-to-ayon) action.

Synchronization can also be automated with AYON's [event server](#event-server) and synchronization events. If your Ftrack is [prepared for AYON](module_ftrack.md#prepare-ftrack-for-ayon), the project should have custom attribute `AYON auto-sync`. Check the custom attribute to allow auto-updates with event server.
Synchronization can also be automated with AYON's [event server](#event-server) and synchronization events. If your Ftrack is [prepared for AYON](addon_ftrack_admin.md#prepare-ftrack-for-ayon), the project should have custom attribute `AYON auto-sync`. Check the custom attribute to allow auto-updates with event server.

:::tip
Always use `Sync To AYON` action before you enable `AYON auto-sync`!
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_harmony_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_harmony_admin
title: ToonBoom Harmony Admin docs
title: Harmony Admin Docs
sidebar_label: ToonBoom Harmony
---

Expand Down Expand Up @@ -62,4 +62,4 @@ Set regex pattern(s) for filtering Task name that should skip validation `frameS

## Render farm settings

* For setting up Deadline support see [here](module_deadline.md)
* For setting up Deadline support see [here](addon_deadline_admin.md)
4 changes: 2 additions & 2 deletions website/docs/addon_harmony_artist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: addon_harmony_artist
title: Harmony
sidebar_label: Harmony
title: Harmony Artist Docs
sidebar_label: ToonBoom Harmony
---

## Available Tools
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_hiero_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_hiero_admin
title: Hiero Admin docs
title: Hiero Admin Docs
sidebar_label: Hiero
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_hiero_artist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_hiero_artist
title: Hiero
title: Hiero Artist Docs
sidebar_label: Hiero / Nuke Studio
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_houdini_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_houdini_admin
title: Houdini Admin docs
title: Houdini Admin Docs
sidebar_label: Houdini
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_houdini_artist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_houdini_artist
title: Houdini
title: Houdini Artist Docs
sidebar_label: Houdini
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_kitsu_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_kitsu_admin
title: Kitsu Admin docs
title: Kitsu Admin Docs
sidebar_label: Kitsu
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_kitsu_artist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_kitsu_artist
title: Kitsu
title: Kitsu Artist Docs
sidebar_label: Kitsu
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_maya_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_maya_admin
title: Maya Admin docs
title: Maya Admin Docs
sidebar_label: Maya
---

Expand Down
12 changes: 6 additions & 6 deletions website/docs/addon_maya_artist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_maya_artist
title: Maya
title: Maya Artist Docs
sidebar_label: Maya
---

Expand Down Expand Up @@ -185,7 +185,7 @@ Let see how it works.
### Loading model

In this example I have already published model of Buddha. To see how to publish
model with AYON see [Publishing Model](artist_hosts_maya.md#publishing-models).
model with AYON see [Publishing Model](addon_maya_artist.md#publishing-models).

First of lets start with empty scene. Now go **AYON → Load...**

Expand Down Expand Up @@ -283,7 +283,7 @@ arm, just made out of simple boxes and I'll publish it.

![Maya - Simple model for rigging](assets/maya-rig_model_setup.jpg)

For more information about publishing models, see [Publishing models](artist_hosts_maya.md#publishing-models).
For more information about publishing models, see [Publishing models](addon_maya_artist.md#publishing-models).

Now lets start with empty scene. Load your model - **AYON → Load...**, right
click on it and select **Reference (abc)**.
Expand Down Expand Up @@ -413,7 +413,7 @@ It has 3 options:
AYON in Maya can be used for submitting renders to render farm and for their
subsequent publishing. Right now AYON support [AWS Thinkbox Deadline](https://www.awsthinkbox.com/deadline).

* For setting up Deadline support see [here](module_deadline.md)
* For setting up Deadline support see [here](addon_deadline_admin.md)


### Creating basic render setup
Expand Down Expand Up @@ -555,7 +555,7 @@ after it is rendered, it will be attached to your model product.

### Tile Rendering
:::note Deadline
This feature is only supported when using Deadline. See [here](module_deadline#ayontileassembler-plugin) for setup.
This feature is only supported when using Deadline. See [here](addon_deadline_admin#ayontileassembler-plugin) for setup.
:::
On the render instance objectset you'll find:

Expand Down Expand Up @@ -615,7 +615,7 @@ Create your model, import it or load from AYON. I'll just import model as OBJ
file.

After we have our model in, we need to set everything to be able to publish it
as model - for detail see [Publishing models](artist_hosts_maya.md#publishing-models).
as model - for detail see [Publishing models](addon_maya_artist.md#publishing-models).

To recap - freeze transforms, rename it to `dragon_GEO` and put it into group
`dragon_GRP`. Then select this group and **AYON → Create...** and choose **Model**.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_maya_xgen_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ For example publishing `xgenMain` version 1 with the attribute `renderer` set to

### Connect Patches

When loading in an Xgen version, it does not have any connections to anything in the workfile, so its static in the position it was published in. Use the [Connect Geometry](artist_hosts_maya#connect-geometry) action to connect Xgen to any matching loaded animated geometry.
When loading in an Xgen version, it does not have any connections to anything in the workfile, so its static in the position it was published in. Use the [Connect Geometry](addon_maya_artist#connect-geometry) action to connect Xgen to any matching loaded animated geometry.

### Connect Guides

Expand All @@ -92,7 +92,7 @@ The animation container gets connected with the Xgen container, so if the animat

## Rendering

To render with Xgen, follow the [Rendering With AYON](artist_hosts_maya#rendering-with-ayon) guide.
To render with Xgen, follow the [Rendering With AYON](addon_maya_artist#rendering-with-ayon) guide.

### Details

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_maya_yeti_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ when you open graph on this Yeti node, all nodes are as they were in publishing

Yeti Rigs are designed to connect to published models or animation rig. The workflow gives the Yeti Rig full control on that geometry to do additional things on top of whatever input comes in, e.g. deleting faces, pushing faces in/out, subdividing, etc.

Let's start with a [model](artist_hosts_maya.md#loading-model) or [rig](artist_hosts_maya.md#loading-rigs) loaded into the scene. Here we are using a simple rig.
Let's start with a [model](addon_maya_artist.md#loading-model) or [rig](addon_maya_artist.md#loading-rigs) loaded into the scene. Here we are using a simple rig.

![Maya - Yeti Simple Rig](assets/maya-yeti_simple_rig.png)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_nuke_admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: addon_nuke_admin
title: Nuke Admin docs
title: Nuke Admin Docs
sidebar_label: Nuke
---

Expand Down
Loading