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

Update Launcher Docs for admins and users #324

Open
1 task done
MustafaJafar opened this issue Jan 16, 2025 · 0 comments
Open
1 task done

Update Launcher Docs for admins and users #324

MustafaJafar opened this issue Jan 16, 2025 · 0 comments
Assignees
Labels
type: enhancement New feature or request

Comments

@MustafaJafar
Copy link
Contributor

MustafaJafar commented Jan 16, 2025

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

@MustafaJafar MustafaJafar added the type: enhancement New feature or request label Jan 16, 2025
@MustafaJafar MustafaJafar self-assigned this Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant