Open danieljurek opened 1 year ago
In the case of the above link, the service name has changed and now there are no more parentheses in the name. Files with parentheses in their names in this state (no longer referenced in a metadata CSV file) can be removed.
We should probably remove service-level overviews and package indexes when service names change.
Another example of this same behavior happening today live: https://learn.microsoft.com/en-us/dotnet/api/overview/azure/pool-management-service-(pmaas)?view=azure-dotnet
In this case, the [!INCLUDE
section is attempting to include a filename with parentheses in the name: https://github.com/Azure/azure-docs-sdk-dotnet/blob/main/api/overview/azure/latest/pool-management-service-(pmaas).md?plain=1#L11C1-L11C64 pool-management-service-(pmaas)-index.md
and this fails though the file does exist.
Is this behavior of the docs system by design for files that have parentheses in their filenames?
@danieljurek Yes, in !INCLUDE links you need to backslash-escape the close paren character, like \)
.
The content for service-level readmes appears to be generated here:
If $indexTableLink has a )
character in it, it breaks parsing of the !INCLUDE statement on the Docs platform side, and the statement itself ends up in the rendered content instead of the contents of the included file.
The fix is to replace )
with \)
.
It looks like the docs site doesn't support including those pages -- https://learn.microsoft.com/en-us/dotnet/api/overview/azure/data-lake-storage-(gen-1)?view=azure-dotnet