Update launcher documentation by MustafaJafar · Pull Request #350 · ynput/ayon-documentation

MustafaJafar · 2025-03-01T01:30:07Z

Changelog Description

resolve #324

Testing notes:

Go through changes and approve if they make sense.

…other tweaks

LiborBatek · 2025-03-06T14:13:28Z

I have spotted broken links on the Getting start page

Basic usage and Advanced usage links both been broken

Edited: also Admin Section link been broken too

LiborBatek · 2025-03-06T14:18:58Z

also on docs/ayon_launcher_artist_basic is broken link

MustafaJafar · 2025-03-06T21:00:42Z

@LiborBatek
Sorry, I couldn't replicate that.

2025-03-06.22-55-09.mp4

iLLiCiTiT · 2025-03-28T10:25:29Z

+
+:::
+
+## Tray Menu


Don't know if is relevant, but tray and all tools in tray are NOT defined by AYON launcher, but by ayon-core. AYON launcher only cares about server, login and distribution of addons, dep. package and other versions of AYON launcher.

Anything that happens afterwards is based on ayon-core logic.

MustafaJafar · 2025-04-04T09:51:45Z

@iLLiCiTiT

When migrtating docs to feature base, I've included the changes in the PR to featurebase.
Feel free to check it there.

Any comments here will be addressed there.

iLLiCiTiT · 2025-04-04T10:02:56Z

Like I've mentioned here #350 (comment) . You're combining AYON launcher and ayon-core functionality in the documentation.

AYON launcher does take care only about this:

connect to server and user login
distribute addons, dependency packages and different version of AYON launcher
deploy and setup shim, inluding handling of ayon-launcher:// uri scheme (related to shim)
import ayon-core and start it's main function

All the tools browser, report viewer, scripting console, tray etc. is NOT related to AYON launcher, but to ayon-core functionality. I don't know if that is the intention, but the documentation in current state may be actually confusing/misleading.

I've included the changes in the PR to featurebase.

I don't know what that is?

MustafaJafar · 2025-05-29T10:39:13Z

+| **AYON_SERVER_URL** | URL for the logged-in AYON Server. |
+| **AYON_API_KEY** | API key for the logged-in AYON Server. |
+| **AYON_DEFAULT_SETTINGS_VARIANT** | Variant used for settings. |
+


Suggested change

| **AYON_USERNAME** | Set it to override system created username. |

| **AYON_TMPDIR** | Set it to override default system temp directory. It supports `root` and `project` template keys, e.g. `{root[work]}/{project[name]}/temp`. |

AYON_USERNAME can be used only for service API key and is used only for farm publishing. I don't think it is related to AYON launcher environments, AYON launcher does not use it in any way, and does not set it.

AYON_TMPDIR is ayon-core related, AYON launcher does not use it in any way, and does not set it.

MustafaJafar · 2025-05-29T10:49:11Z

For information, Any changes related to artist and admin docs will be reverted as these pages will be removed #370 making this PR updates only the dev docs.

Changes of artist and admin docs will be moved to our new help center https://help.ayon.app/en/help

iLLiCiTiT · 2025-05-29T14:25:02Z

+| **AYON_ADDONS_DIR** | Path to AYON add-ons directory—considered deprecated. Use `AYON_LAUNCHER_STORAGE_DIR` instead. |
+| **AYON_DEPENDENCIES_DIR** | Path to AYON dependencies directory—considered deprecated. Use `AYON_LAUNCHER_STORAGE_DIR` instead. |
+| **AYON_MENU_LABEL** | Label for AYON menu. |
+| **PYBLISH_GUI** | Default Pyblish UI for use in Pyblish. |


Not used anymore.

Suggested change

| **PYBLISH_GUI** | Default Pyblish UI for use in Pyblish. |

iLLiCiTiT · 2025-05-29T14:29:34Z

+:::caution
+
+Environment variables set for backward compatibility with the openpype add-on.
+
+| Environment Variable | Description |
+|--|--|
+| **OPENPYPE_VERSION** | Alias for **AYON_VERSION**. |
+| **OPENPYPE_LOG_LEVEL** | Alias for **AYON_LOG_LEVEL**. |
+| **OPENPYPE_DEBUG** | Alias for **AYON_DEBUG**. |
+| **OPENPYPE_USE_STAGING** | Alias for **AYON_USE_STAGING**. |
+| **OPENPYPE_HEADLESS_MODE** | Alias for **AYON_HEADLESS_MODE**. |
+| **OPENPYPE_EXECUTABLE** | Alias for **AYON_EXECUTABLE**. |
+| **OPENPYPE_ROOT** | Alias for **AYON_ROOT**. |
+| **OPENPYPE_REPOS_ROOT** | Alias for **AYON_ROOT**. |
+| **AVALON_LABEL** | Alias for **AYON_MENU_LABEL**. |
+
+:::


iLLiCiTiT · 2025-05-29T14:30:32Z

 :::tip
-Environment variables **AYON_ADDONS_DIR** and **AYON_DEPENDENCIES_DIR** by default are relative to **AYON_LAUNCHER_STORAGE_DIR**.
+
+Environment variables **AYON_ADDONS_DIR** and **AYON_DEPENDENCIES_DIR** default to being relative to **AYON_LAUNCHER_STORAGE_DIR**.


We probably should rather mark thenm as deprecated than giving hints?

iLLiCiTiT · 2025-05-29T14:35:52Z

+
+<TabItem value='frozen'>
+
+First, build AYON. This will produce executables: `ayon.exe` and `ayon_console.exe` on Windows, `ayon` on Linux, and `AYON {version}.app` for macOS. For more info, check [AYON Executables](ayon_launcher_artist_advanced.md#ayon-executables).


I would recommend to download the installer from releases instead of building it on own.

MustafaJafar · 2025-06-04T18:08:04Z

Closing this PR in favor of #371
Artist and admin docs in this PR are moved to our new help center, Check:

iLLiCiTiT · 2025-06-06T07:17:47Z

NOTE: AYON launcher does not care about distribution of "third-party binaries like ffmpeg and OIIO and different versions". ayon-third-party addon cares about it.

Update launcher documentation for users

42dfc6c

MustafaJafar self-assigned this Mar 1, 2025

MustafaJafar added type: enhancement New feature or request Dev Docs Artist Docs Admin Docs labels Mar 3, 2025

MustafaJafar added 9 commits March 3, 2025 16:49

Update links and remove admin related docs

c2b1348

add example output for contextselection and add a note

eacd48e

update example output for contextselection

9b2f2bc

add note about run command

57f6bcb

Convert table in Global Executable Arguments to markdown and small …

ea95206

…other tweaks

Revamp AYON launcher admin docs

78a3ebd

Fix broken links for launcher admin

25a37c6

Tweak site ID section

2f97971

Enhance the look of dev launcher docs

27799ff

MustafaJafar requested review from BigRoy, LiborBatek, iLLiCiTiT and m-u-r-p-h-y March 5, 2025 11:11

MustafaJafar added 3 commits March 5, 2025 23:51

add some missing environment variables

ed3dab1

Add more info for site id

5b16460

add some missing parts.

3372ecb

iLLiCiTiT reviewed Mar 6, 2025

View reviewed changes

Comment thread website/docs/ayon_launcher_admin.md Outdated

update info for publish command

ed74d67

MustafaJafar changed the title ~~Update launcher documentation for users~~ Update launcher documentation Mar 11, 2025

MustafaJafar added 2 commits March 11, 2025 10:45

Merge branch 'main' into 324-update-launcher-docs-for-admins-and-users

165bda4

update note about installing launcher for all users

4a5bdf2

add note about shims

86fdd7a

MustafaJafar requested a review from iLLiCiTiT March 11, 2025 11:33

proofread launcher docs

1d56d2e

MustafaJafar commented Mar 11, 2025

View reviewed changes

Comment thread website/docs/ayon_launcher_admin.md Outdated

iLLiCiTiT reviewed Mar 17, 2025

View reviewed changes

Comment thread website/docs/ayon_launcher_admin.md Outdated

iLLiCiTiT reviewed Mar 17, 2025

View reviewed changes

Comment thread website/docs/ayon_launcher_admin.md Outdated

MustafaJafar added 2 commits March 19, 2025 15:48

update AYON Launcher Versioning Convention section

9d2bab8

update FAQ section

46b3a4e

MustafaJafar requested a review from iLLiCiTiT March 19, 2025 15:41

iLLiCiTiT reviewed Mar 28, 2025

View reviewed changes

MustafaJafar commented May 29, 2025

View reviewed changes

iLLiCiTiT reviewed May 29, 2025

View reviewed changes

Comment thread website/docs/dev_launcher.md

iLLiCiTiT reviewed May 29, 2025

View reviewed changes

MustafaJafar mentioned this pull request Jun 4, 2025

Update launcher Developer docs #371

Merged

MustafaJafar closed this Jun 4, 2025

MustafaJafar deleted the 324-update-launcher-docs-for-admins-and-users branch October 27, 2025 07:06


	\| AYON_USERNAME \| Set it to override system created username. \|
	\| AYON_TMPDIR \| Set it to override default system temp directory. It supports `root` and `project` template keys, e.g. `{root[work]}/{project[name]}/temp`. \|


		<TabItem value='frozen'>

		First, build AYON. This will produce executables: `ayon.exe` and `ayon_console.exe` on Windows, `ayon` on Linux, and `AYON {version}.app` for macOS. For more info, check [AYON Executables](ayon_launcher_artist_advanced.md#ayon-executables).

Conversation

MustafaJafar commented Mar 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog Description

Testing notes:

Uh oh!

Uh oh!

LiborBatek commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LiborBatek commented Mar 6, 2025

Uh oh!

MustafaJafar commented Mar 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iLLiCiTiT Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MustafaJafar commented Apr 4, 2025

Uh oh!

iLLiCiTiT commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MustafaJafar May 29, 2025

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MustafaJafar commented May 29, 2025

Uh oh!

iLLiCiTiT May 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iLLiCiTiT May 29, 2025

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT May 29, 2025

Choose a reason for hiding this comment

Uh oh!

MustafaJafar commented Jun 4, 2025

Uh oh!

iLLiCiTiT commented Jun 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MustafaJafar commented Mar 1, 2025 •

edited

Loading

LiborBatek commented Mar 6, 2025 •

edited

Loading

iLLiCiTiT Mar 28, 2025 •

edited

Loading

iLLiCiTiT commented Apr 4, 2025 •

edited

Loading

iLLiCiTiT May 29, 2025 •

edited

Loading

iLLiCiTiT May 29, 2025 •

edited

Loading