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

Bugfix/fix dead links and add a missing feature type #136

Merged
merged 4 commits into from
Feb 28, 2024
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
4 changes: 2 additions & 2 deletions website/docs/addon_deadline_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ For [AWS Thinkbox Deadline](https://www.awsthinkbox.com/deadline) support you ne

1. Deploy AYON executable to all nodes of Deadline farm. See [Install & Run](admin_launcher_distribute.md)

2. Enable Deadline Module in the [AYON Admin Settings](admin_settings_system.md#deadline).
2. Create a new AYON Bundle with Deadline Addon version.

3. Set up *Deadline Web API service*. For more details on how to do it, see [here](https://docs.thinkboxsoftware.com/products/deadline/10.1/1_User%20Manual/manual/web-service.html).

4. Point AYON to your deadline webservice URL in the [AYON Admin Settings](admin_settings_system.md#deadline).
4. Point AYON to your deadline webservice URL in the Deadline settings `ayon+settings://deadline/deadline_urls/0/value`.

![Webservice url](assets/deadline_webserver_config.png)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_ftrack_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Ftrack is currently the main project management option for AYON. This documentat
## Prepare Ftrack for AYON

### Server URL
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.
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 have Ftrack enabled in your AYON bundle, 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](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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_maya_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ That will create video file, pass it to another extractor creating burnins in it
and finally uploading this video to ftrack with your model (or other type) published
version. All parts of this process - like what burnins, what type of video file,
settings for Maya playblast - can be customized by your TDs. For more information
about customizing review process refer to [admin section](project_settings/project_settings_core.md/#publish-plugins).
about customizing review process refer to [admin section](addon_core_settings#publish-plugins).

If you don't move `modelMain` into `reviewMain`, review will be generated but it will
be published as separate entity.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_nuke_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ If you choose to publish on the farm, you will render and do reviews on the farm

So far there is no option for using existing frames (from your local / check render) and just do the review on the farm.

More info about [configuring reviews](project_settings/project_settings_core.md#extractreview).
More info about [configuring reviews](addon_core_settings#extract-review).

:::tip Admin Tip - Configuring Reviews
You can configure reviewsin **Studio Settings → Project → Global → Publish plugins → ExtractReview / ExtractBurnin**
Expand Down
4 changes: 2 additions & 2 deletions website/docs/dev_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Requirements
sidebar_label: Requirements
---

AYON is a modular project, the AYON server lies at the core of it, so to develop for AYON we need an instance of it either in the localhost or in a remote server, refer to the [Admin Server Installation](admin_server_installation.md) for more.
AYON is a modular project, the AYON server lies at the core of it, so to develop for AYON we need an instance of it either in the localhost or in a remote server, refer to the [Admin Server Deployment](admin_server_deployment.md) for more.

AYON is written in [**Python 3 (3.9.x)**](#python) and addheres to the versions defined in the [VFX Reference Platform](https://vfxplatform.com/).

Expand All @@ -16,7 +16,7 @@ The main requirements needed to run and build AYON are:
- PowerShell 5.0+ (Windows)
- Bash (Linux and macOs)
- [**Python 3.9.x**](#python)
- [**Ayon Server**](admin_server_installation.md)
- [**Ayon Server**](admin_server_deployment.md)


## Supported Operating Systems
Expand Down
2 changes: 1 addition & 1 deletion website/src/data/features/data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ const features: { [type in FeatureType]: Feature } = {
description:
"Service for monitoring the user activity to start, stop and synchronise time tracking.",
docs: {
admin: "admin_settings_system#timers-manager",
},
github: "https://github.com/ynput/ayon-core/tree/develop/client/ayon_core/modules/timers_manager"
},
farmRendering: {
title: "Farm rendering",
Expand Down
4 changes: 3 additions & 1 deletion website/src/data/features/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export type Feature = {
description: string;
preview?: string;
docs?: { [type in DocType]?: String };
github?: string;
id?: string;
};

Expand All @@ -29,4 +30,5 @@ export type FeatureType =
| "sceneBuilder"
| "nodePresets"
| "burnins"
| "bakingColorspacePresets";
| "bakingColorspacePresets"
| "scriptBuilding";
Loading