Skip to content

Commit

Permalink
Merge pull request #288 from ynput/183-broken-links-in-docs
Browse files Browse the repository at this point in the history
Have consistant links and fix broken links
  • Loading branch information
MustafaJafar authored Nov 28, 2024
2 parents 7dcee53 + d405752 commit d79d620
Show file tree
Hide file tree
Showing 53 changed files with 214 additions and 216 deletions.
4 changes: 2 additions & 2 deletions website/docs/addon_3dequalizer_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ The 3DEqualizer (3DE) Addon lets you manage your 3DE projects, load plates as ca

### Loading Plates

You can load image data into 3DE by using the [Loader](artist_tools_loaderزةي) tool. Go to the `AYON` menu in 3DE, select `Load`, and pick the image sequence you want to use. This will create a new sequence camera, set the path for the image sequence, and set the correct frame range. From that moment, the loaded sequence is version tracked. You can follow the used versions in the [Manage tool](artist_tools_inventory.md).
You can load image data into 3DE by using the [Loader](artist_tools_loader.md) tool. Go to the `AYON` menu in 3DE, select `Load`, and pick the image sequence you want to use. This will create a new sequence camera, set the path for the image sequence, and set the correct frame range. From that moment, the loaded sequence is version tracked. You can follow the used versions in the [Manage tool](artist_tools_inventory.md).

:::note
AYON uses **Project Notes** to store some of its information for version tracking. If you want to use them, please do not modify the content of the `AYON_CONTEXT:: ... ::AYON_CONTEXT` block, as it will probably break the version management of loaded image sequences.
:::

### Publishing Matchmove Scripts

Once you track your camera in 3DE, you can export and publish it as a version for Maya and/or Nuke. Go to the `AYON` menu in 3DE and click on [Publish](artist_tools_publisher). You can create a `Match Move` publishing instance and set various settings:
Once you track your camera in 3DE, you can export and publish it as a version for Maya and/or Nuke. Go to the `AYON` menu in 3DE and click on [Publish](artist_tools_publisher.md). You can create a `Match Move` publishing instance and set various settings:

- **Camera(s) to Publish**: Select which camera mode to publish. Options include *All Cameras*, *Current Camera* (active), *Reference Cameras* (for all reference cameras), and *Sequence Cameras*.
- **Model Export**: Choose to export *All 3D Models* or no models.
Expand Down
12 changes: 6 additions & 6 deletions website/docs/addon_3dsmax_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ This part of documentation is still work in progress.

<!-- ## AYON Global Tools
- [Work Files](artist_tools_workfiles)
- [Create](artist_tools_creator)
- [Load](artist_tools_loader)
- [Manage (Inventory)](artist_tools_inventory)
- [Publish](artist_tools_publisher)
- [Library Loader](artist_tools_library_loader)
- [Work Files](artist_tools_workfiles.md)
- [Create](artist_tools_creator.md)
- [Load](artist_tools_loader.md)
- [Manage (Inventory)](artist_tools_inventory.md)
- [Publish](artist_tools_publisher.md)
- [Library Loader](artist_tools_library_loader.md)
-->


Expand Down
10 changes: 5 additions & 5 deletions website/docs/addon_aftereffects_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ import TabItem from '@theme/TabItem';
<!-- based on PS implementation, same principle and menu -->
## Available Tools

- [Work Files](artist_tools_workfiles)
- [Create](artist_tools_creator)
- [Load](artist_tools_loader)
- [Publish](artist_tools_publisher)
- [Manage](artist_tools_inventory)
- [Work Files](artist_tools_workfiles.md)
- [Create](artist_tools_creator.md)
- [Load](artist_tools_loader.md)
- [Publish](artist_tools_publisher.md)
- [Manage](artist_tools_inventory.md)

## AE Extension installation

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_applications_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ All the tools defined in Tools Definitions can then be assigned to projects, cer

:::tip Example Filter profile
Find example of Tool definition and a profile Filter in the FAQ section below:
[How to make a tool available for all folder paths in a project for a specific application variant?](addon_applications_admin#how-to-make-a-tool-available-for-all-folder-paths-in-a-project-for-a-specific-application-variant-)
[How to make a tool available for all folder paths in a project for a specific application variant?](#how-to-make-a-tool-available-for-all-folder-paths-in-a-project-for-a-specific-application-variant)
:::

## FAQ
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_aquarium_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Aquarium addon, allow you to:
In the future, new feature will be added, based on your requests. Feel free to [reach us](https://[email protected]).
:::

We are open to receive new pull request (PR). Follow our [developer documentation to start](addon_aquarium_developer).
We are open to receive new pull request (PR). Follow our [developer documentation to start](addon_aquarium_developer.md).


## Configuring addon

First, you need to install the addon. It's available from Ayon market or you can install it from its repository. For that follow our [developer documentation](addon_aquarium_developer) or [Ayon's manual installation guide](admin_server_installing_addons)
First, you need to install the addon. It's available from Ayon market or you can install it from its repository. For that follow our [developer documentation](addon_aquarium_developer.md) or [Ayon's manual installation guide](admin_server_installing_addons.md)

### Getting Aquarium bot

Expand Down
6 changes: 3 additions & 3 deletions website/docs/addon_aquarium_developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ This folder is used to provide a web UI in your Ayon settings to pair projects b

#### Services

Syncing data between Ayon and Aquarium relies on [Ayon services system](./dev_event_system).
Syncing data between Ayon and Aquarium relies on [Ayon services system](dev_event_system.md).

This addon use two services:

Expand All @@ -92,14 +92,14 @@ You will need to clone several Ayon repositories in order to run everything loca
- You can clone this one, into `ayon-docker/addons/core` folder. Here is the steps :
2. From the `core` folder execute this command:
- `git clone ssh://[email protected]:ynput/ayon-core.git dev`
- This command will clone the repository and rename it `dev`, in order to follow [Ayon addon directory structure](https://ayon.ynput.io/docs/admin_server_installing_addons#directory-structure)
- This command will clone the repository and rename it `dev`, in order to follow [Ayon addon directory structure](admin_server_installing_addons.md#directory-structure)
- [Ayon dependencies](https://github.com/ynput/ayon-dependencies-tool)
- [Aquarium addon](https://github.com/ynput/ayon-aquarium)
- You can clone this one, into `ayon-docker/addons` folder. Here is the steps :
1. Create a folder `ayon-aquarium` in `ayon-docker/addons` folder
2. From the `ayon-aquarium` folder execute this command:
- `git clone ssh://[email protected]:ynput/ayon-aquarium.git dev`
- This command will clone the repository and rename it `dev`, in order to follow [Ayon addon directory structure](https://ayon.ynput.io/docs/admin_server_installing_addons#directory-structure)
- This command will clone the repository and rename it `dev`, in order to follow [Ayon addon directory structure](admin_server_installing_addons.md#directory-structure)

### Optional requirements

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_aquarium_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem';
![Aquarium addon for Ayon](assets/aquarium/aquarium-ayon-logo.png)

:::info Requirements
Don't forget to [setup and configure your addon](addon_aquarium_admin) before being able to use it.
Don't forget to [setup and configure your addon](addon_aquarium_admin.md) before being able to use it.
:::

:::danger Only for Ayon managers
Expand Down
26 changes: 13 additions & 13 deletions website/docs/addon_blender_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ Before starting to use the Blender AYON integration, please check the following

## AYON Tools

- [Work Files](artist_tools_workfiles)
- [Create](artist_tools_creator)
- [Load](artist_tools_loader)
- [Manage (Inventory)](artist_tools_inventory)
- [Publish](artist_tools_publisher)
- [Library Loader](artist_tools_library_loader)
- [Work Files](artist_tools_workfiles.md)
- [Create](artist_tools_creator.md)
- [Load](artist_tools_loader.md)
- [Manage (Inventory)](artist_tools_inventory.md)
- [Publish](artist_tools_publisher.md)
- [Library Loader](artist_tools_library_loader.md)

## Working with AYON in Blender

Expand Down Expand Up @@ -55,7 +55,7 @@ You will use `Workfiles` tool not just for saving your work but for all `.blend`

Just navigate to `AYON` > `Workfiles` > `Open` instead.

For more details and what options it offers navigate to [Work Files](artist_tools_workfiles) user's docs section.
For more details and what options it offers navigate to [Work Files](artist_tools_workfiles.md) user's docs section.


## Publishing
Expand Down Expand Up @@ -120,7 +120,7 @@ Finally, let's publish our model! Go to **AYON → Publish...**. You will be pre

:::note
Content of this window can differ depending on your studio's AYON configuration.
For more details see [Publisher](artist_tools_publisher) user's docs section.
For more details see [Publisher](artist_tools_publisher.md) user's docs section.
:::

Items in left column are instances you will be publishing. You can disable them
Expand Down Expand Up @@ -186,7 +186,7 @@ By selecting your Suzanne's `modelMain` and performing right click on it and cho

:::note
**AYON Loader** offers you the ability to load available published products using different methods, which will vary depending on the occasion. Check
[Asset Loader](artist_tools_loader) for more details.
[Asset Loader](artist_tools_loader.md) for more details.
:::

## Creating Rigs
Expand Down Expand Up @@ -225,11 +225,11 @@ this:
### Publishing rigs

Publishing rig is done in same way as publishing everything else. Save your scene
and go **AYON → Publish**. For more detail see [Publisher](artist_tools_publisher).
and go **AYON → Publish**. For more detail see [Publisher](artist_tools_publisher.md).

### Loading rigs

You can load rig with [Loader](artist_tools_loader). Go **AYON → Load...**,
You can load rig with [Loader](artist_tools_loader.md). Go **AYON → Load...**,
select your rig, right click on it and click **Link rig (blend)**.

## Layouts in Blender
Expand All @@ -240,7 +240,7 @@ layout from selected products and version manage such set via AYON toolset.
### Publishing a layout

Working with Layout is easy. Just load your assets into scene with
[Loader](artist_tools_loader) (**AYON → Load...**). Populate your scene as
[Loader](artist_tools_loader.md) (**AYON → Load...**). Populate your scene as
you wish, translate each piece to fit your need. When ready, select all imported
stuff and go **AYON → Create...** and select **Layout**. When selecting rigs,
you need to select only the armature, the geometry will automatically be included.
Expand All @@ -250,7 +250,7 @@ Now you can publish is with **AYON → Publish**.

### Loading layouts

You can load a Layout using [Loader](artist_tools_loader)
You can load a Layout using [Loader](artist_tools_loader.md)
(**AYON → Load...**). Select your layout, right click on it and
select **Link Layout (blend)**. This will populate your scene with all those
models you've put into layout.
Expand Down
14 changes: 7 additions & 7 deletions website/docs/addon_core_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ Globally applied environment variables that will be appended to any AYON process
- Uses `subst` command, if configured volume character in `Destination` field already exists, no re-mapping is done for that character(volume).

:::info
Project settings can have project specific values. Each new project is using studio values defined in **studio settings** but these values can be modified or overridden per project. Refer to Settings related to [Working with settings](admin_settings) for more details.
Project settings can have project specific values. Each new project is using studio values defined in **studio settings** but these values can be modified or overridden per project. Refer to Settings related to [Working with settings](admin_settings.md) for more details.
:::


## Tools
### Creator
Settings related to [Creator tool](artist_tools_creator).
Settings related to [Creator tool](artist_tools_creator.md).

#### Product name profiles
![core_tools_creator_product_template](assets/core_tools_creator_product_template.png)
Expand Down Expand Up @@ -77,7 +77,7 @@ Some creators may have other keys as their context may require more information


### Workfiles
Settings related to [Workfile tool](artist_tools_workfiles).
Settings related to [Workfile tool](artist_tools_workfiles.md).

#### Open last workfile at launch
This feature allows you to define a rule for each task/host or toggle the feature globally to all tasks as they are visible in the picture.
Expand All @@ -88,7 +88,7 @@ This feature allows you to define a rule for each task/host or toggle the featur

#### Template name profiles

Allows to select [anatomy template](admin_settings_project_anatomy#templates) based on context of product being published.
Allows to select [anatomy template](admin_settings_project_anatomy.md#templates) based on context of product being published.

For example for `render` profile you might want to publish and store assets in different location (based on anatomy setting) then for `publish` profile.
Profile filtering is used to select between appropriate template for each context of published products.
Expand Down Expand Up @@ -150,7 +150,7 @@ AYON distributes its own OCIO configs. Those can be found in `{ayon install dir}
### Using OCIO config
Global config path is set by default to AYON distributed configs. At the moment there are only two - **aces_1.2** and **nuke-default**. Since this path input is not platform specific it is required to use at least an environment variable for platform specific config root directory. Order of paths matter so first existing path found is used.

Each OCIO config path input supports formatting using environment variables and [anatomy template keys](admin_settings_project_anatomy#available-template-keys). The default global OCIO config path is `{AYON_ROOT}/vendor/bin/ocioconfig/OpenColorIOConfigs/aces_1.2/config.ocio`.
Each OCIO config path input supports formatting using environment variables and [anatomy template keys](admin_settings_project_anatomy.md#available-template-keys). The default global OCIO config path is `{AYON_ROOT}/vendor/bin/ocioconfig/OpenColorIOConfigs/aces_1.2/config.ocio`.

If the project settings for a particular host has its own OCIO config **enabled** and set to at least one path and the path exists, it overrides the global OCIO config for that host.

Expand Down Expand Up @@ -364,13 +364,13 @@ Create profiles to control how the plugin functions:
- Choose specific products, hosts, and tasks that the plugin will identify and work with.
2. Burnin definitions:
- a. **Name**: Burnin definition name.
- b. **Placeholders Customization**: Tailor the placeholder text using [template keys](admin_settings_project_anatomy#available-template-keys), allowing flexibility for each user and context.
- b. **Placeholders Customization**: Tailor the placeholder text using [template keys](admin_settings_project_anatomy.md#available-template-keys), allowing flexibility for each user and context.
- c. **Additional Filtering**: Add extra filters to manage the use of multiple burnin definitions effectively.
- d. **Expansion (+)**: Add more definitions to fit your need.
3. **Expansion (+)**: Add more profiles.

:::info Placeholders and template keys
To see a list of available template keys, please visit the [template keys](admin_settings_project_anatomy#available-template-keys) section.
To see a list of available template keys, please visit the [template keys](admin_settings_project_anatomy.md#available-template-keys) section.
Additionally, be aware that some keys are exclusive to specific hosts. Nevertheless, these keys should function properly as we often align the addon features to ensure compatibility.
:::

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_ftrack_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,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](addon_ftrack_admin#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 tray application

It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.
Expand Down
10 changes: 5 additions & 5 deletions website/docs/addon_harmony_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ import versions from '@site/docs/assets/json/Ayon_addons_version.json'

## Available Tools

- [Work Files](artist_tools_workfiles)
- [Create](artist_tools_creator)
- [Load](artist_tools_loader)
- [Publish](artist_tools_publisher)
- [Manage](artist_tools_inventory)
- [Work Files](artist_tools_workfiles.md)
- [Create](artist_tools_creator.md)
- [Load](artist_tools_loader.md)
- [Publish](artist_tools_publisher.md)
- [Manage](artist_tools_inventory.md)

:::note
Only one tool can be open at a time. If you open a tool while another tool is open, it will wait in queue for the existing tool to be closed. Once the existing tool is closed, the new tool will open.
Expand Down
10 changes: 5 additions & 5 deletions website/docs/addon_hiero_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ All the information also applies to **_Nuke Studio_**(NKS), but for simplicity w

## AYON global tools

- [Work Files](artist_tools_workfiles)
- [Create](artist_tools_creator)
- [Load](artist_tools_loader)
- [Manage (Inventory)](artist_tools_inventory)
- [Publish](artist_tools_publisher)
- [Work Files](artist_tools_workfiles.md)
- [Create](artist_tools_creator.md)
- [Load](artist_tools_loader.md)
- [Manage (Inventory)](artist_tools_inventory.md)
- [Publish](artist_tools_publisher.md)


## Hiero specific tools
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_houdini_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import versions from '@site/docs/assets/json/Ayon_addons_version.json'

### Add Self Publish Button

Enabling this setting will cause Houdini creator to add a **self publish button** when creating new publish instances. More Info on how how the **self publish button** works [here](addon_houdini_artist#ayon-publishing-process)
Enabling this setting will cause Houdini creator to add a **self publish button** when creating new publish instances. More Info on how how the **self publish button** works [here](addon_houdini_artist.md#ayon-publishing-process)

![general_settings_self_publish_button](assets/houdini/admin/general_settings_self_publish_button.png)

Expand All @@ -41,7 +41,7 @@ Allows admins to have a list of vars (e.g. JOB) with (dynamic) values that will
## Color Management (ImageIO)

Allows admins to override the global color management settings, check [Host specific overrides](https://ayon.ynput.io/docs/admin_colorspace#host-specific-overrides)
Allows admins to override the global color management settings, check [Host specific overrides](admin_colorspace.md#host-specific-overrides)

![houdini-color-management](assets/houdini/admin/houdini-color-management.png)

Expand Down
16 changes: 8 additions & 8 deletions website/docs/addon_houdini_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ import versions from '@site/docs/assets/json/Ayon_addons_version.json'

## AYON global tools

- [Work Files](artist_tools_workfiles)
- [Create](artist_tools_creator)
- [Load](artist_tools_loader)
- [Manage (Inventory)](artist_tools_inventory)
- [Publish](artist_tools_publisher)
- [Library Loader](artist_tools_library_loader)
- [Work Files](artist_tools_workfiles.md)
- [Create](artist_tools_creator.md)
- [Load](artist_tools_loader.md)
- [Manage (Inventory)](artist_tools_inventory.md)
- [Publish](artist_tools_publisher.md)
- [Library Loader](artist_tools_library_loader.md)

## Ayon Menu

Expand Down Expand Up @@ -423,7 +423,7 @@ Loading is done by
![menu_load_load_library](assets/houdini/artist/menu_load_load_library.png)

Loaded stuff is by default wrapped in subnetwork node called `AVALON_CONTAINERS`.
Artist can move nodes inside `AVALON_CONTAINERS` out without losing management ability. For more info, Go to [Load](artist_tools_loader) and [Library Loader](artist_tools_library_loader)
Artist can move nodes inside `AVALON_CONTAINERS` out without losing management ability. For more info, Go to [Load](artist_tools_loader.md) and [Library Loader](artist_tools_library_loader.md)

import loader_tool_demo from './assets/houdini/artist/loader_tool_demo.mp4'

Expand All @@ -449,7 +449,7 @@ Key features:
2. Switch Asset
3. Inventory Actions

For more info, Go to [Manage (Inventory)](artist_tools_inventory)
For more info, Go to [Manage (Inventory)](artist_tools_inventory.md)

![Inventory_manage_products](assets/houdini/artist/Inventory_manage_products.png)

Expand Down
Loading

0 comments on commit d79d620

Please sign in to comment.