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

[ISSUE][DOCS] Deprecated Alias @assets@ #2636

Open
PHandradee opened this issue Jan 10, 2025 · 0 comments
Open

[ISSUE][DOCS] Deprecated Alias @assets@ #2636

PHandradee opened this issue Jan 10, 2025 · 0 comments
Labels
needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@PHandradee
Copy link

Describe the issue

I believe the documentation page File IO - List of Aliases need to be updated, particularly focusing on "The Aliasing System".
I tested the code shown on this page, and here are my findings:
Deprecated warning using @assets@

CustomReadJsonFile("@products@/assets/skillsdb.json");
...       
        AZ::IO::HandleType fileHandle = AZ::IO::InvalidHandle;
        AZ::IO::FileIOBase* fileIO = AZ::IO::FileIOBase::GetInstance();
        AZ_Printf("FileContent", "@assets@ alias path: %s", fileIO->GetAlias("@assets@"));
        AZ_Printf("FileContent", "@products@ alias path: %s", fileIO->GetAlias("@products@"));
...
<12:38:32> [Error] (FileIO) - Alias "@assets@" is deprecated. Please use alias "@products@" instead
<12:38:32> (FileContent) - @assets@ alias path: D:\O3DE-Projects\Projects\ProjectM\Cache\pc
<12:38:32> (FileContent) - @products@ alias path: D:\O3DE-Projects\Projects\ProjectM\Cache\pc

Another good addition would be::
How to get all the available Aliases?

Impacted page(s)

File IO - List of Aliases

Expected experience

Expected to have the updated information and the complete list of aliases.

@PHandradee PHandradee added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

1 participant