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

Fix typos/grammar #35

Merged
merged 2 commits into from
Sep 2, 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
19 changes: 10 additions & 9 deletions Docs/Ayon_Docs/Admin_Docs.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
## Introduction

> **_NOTE_**\
> this addon is currently in its Alpha stage and you will need to set some
> This addon is currently in its Alpha stage, and you will need to set some
> LakeFs keys (LakeFs is the data server we use to distribute Bin data) you can
> get those Keys on our Discord server just ask one of the Ynput staff for them.
> the settings are the following:
> `ayon+settings://ayon_usd/LakeFs_Settings/access_key_id` and
> `ayon+settings://ayon_usd/LakeFs_Settings/secret_access_key`

USD is a modern, open-source, scene description and file format developed by
Pixar Animation Studios. Its an Extensive and extendable C++Lib that is used in
3D, 2D and Games Graphics in order to allow for eficient work with Sceene data.
Pixar Animation Studios. It's an Extensive and extendable C++Lib that is used
in 3D, 2D and Games Graphics in order to allow for efficient work with scene
data.

Many might know it from SideFs Houdini Solaris or Nvidia Omniverse but it is by
now included in most other Vfx software packages.
Many might know it from SideFx Houdini Solaris or Nvidia Omniverse, but by now
it is included in most other VFX software packages.

In AYON we use it in our New **Contribution workflow** as the data backend to
allow cross Platform and Application workflows. This allows for better
integrated Teams and a more artist centric Workflow as artists can open the same
scene in different applications and work with the tools that serve them the
best.

Goal of this addon is to extend the Contirbution workflow by automaticly
Goal of this addon is to extend the Contribution workflow by automatically
distributing Usd and Ayon Libs:

- USD-Lib build for supported platforms.
Expand Down Expand Up @@ -58,10 +59,10 @@ this can be great if you want to pin your pipeline to a specific release.

**Asset Resolvers:** `ayon+settings://ayon_usd/LakeFs_Settings/asset_resolvers`\
allows you to associate a specific Application name with a specific resolver.\
we always setup all the resolvers we compile but if you have special App_Names
we always set up all the resolvers we compile but if you have special App_Names
in your Applications then you might want to add an App Alias.\
e.g if you have hou19.5.xxx setup as an variant for Houdini you can then set it
as an alias for the Hou19.5 entry because they share the same resolver.
e.g. if you have hou19.5.xxx setup as a variant for Houdini you can then set
it as an alias for the Hou19.5 entry because they share the same resolver.

#### Usd Resolver Config

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can find Admin and Developer docs under Docs/Ayon_Docs/

### Clone the Repo

> **_IMOPRTANT_**\
> **_IMPORTANT_**\
> This repository uses Git Submodules. Make sure to use the correct `git clone`\
> commands accordingly.\
> `git clone --recurse-submodules https://github.com/ynput/ayon-usd.git`\
Expand Down
8 changes: 4 additions & 4 deletions server/settings/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def logger_logging_keys_enum():

# FIX find a way to pull this from AyonCppApi (later AyonLogger)
def log_lvl_enum():
"""Return enumerator for supported log lvls."""
"""Return enumerator for supported log levels."""
return [
{"label": "Info", "value": "INFO"},
{"label": "Error", "value": "ERROR"},
Expand All @@ -37,7 +37,7 @@ def log_lvl_enum():

# FIX find a way to pull this from AyonCppApi (later AyonLogger)
def file_logger_enum():
"""Return enumerator for supported log lvls."""
"""Return enumerator for supported log levels."""
return [
{"label": "Off", "value": "OFF"},
{"label": "On", "value": "ON"},
Expand All @@ -52,7 +52,7 @@ class AppPlatformPathModel(BaseSettingsModel):
)

app_alias_list: list[str] = SettingsField(
title="Applicatoin Alias",
title="Application Alias",
description="Allows an admin to define a list of App Names that use the same resolver as the parent application",
default_factory=list,
)
Expand Down Expand Up @@ -222,7 +222,7 @@ class AyonResolverSettings(BaseSettingsModel):
"OFF",
title="AyonResolver File Logger Enabled ",
enum_resolver=file_logger_enum,
description="Allows you to enable or disalbe the AyonUsdResolver file logger, default is Off",
description="Allows you to enable or disable the AyonUsdResolver file logger, default is Off",
)
ayon_logger_logging_keys: str = SettingsField(
"",
Expand Down