Skip to content

Update Launcher Docs for admins and users #324

@MustafaJafar

Description

@MustafaJafar

Is there an existing issue for this?

  • I have searched the existing issues and added correct labels.

Please describe the feature you have in mind and explain what the current shortcomings are?

AYON launcher has received many updates and current docs can lead to confusion.

Suggested implementation?

Some of the following bullet points already exist in docs. But I suggest to re-create the page instead of adding enhancements.

For admin doc:

  • About launcher/ introduction
  • Get and distribute AYON launcher: where to get the launcher, when to build it and add it to a bundle
  • Tip about mass installing the launcher on all machines.
  • Environment Variables
  • Add information about Site ID
  • Hint on Pipeline modes.

For users:

  • Basic Usage
    • About Launcher/ Introduction
    • Get and Install the launcher
    • Launcher tray menu, briefly explain each button. add a note that different addons can extend this menu.
  • Advanced Usage
    • GUI Executable Arguments
    • Headless mode commands

Describe alternatives you've considered:

No response

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions