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

Service Level Overview pages should not have parens in the filenames #5433

Closed
danieljurek opened this issue Feb 13, 2023 · 3 comments · Fixed by #9177
Closed

Service Level Overview pages should not have parens in the filenames #5433

danieljurek opened this issue Feb 13, 2023 · 3 comments · Fixed by #9177
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs

Comments

@danieljurek
Copy link
Member

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

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Feb 13, 2023
@kurtzeborn kurtzeborn added Docs Central-EngSys This issue is owned by the Engineering System team. and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Apr 3, 2023
@danieljurek
Copy link
Member Author

danieljurek commented Sep 13, 2024

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

image

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?

@nickwalkmsft
Copy link

@danieljurek Yes, in !INCLUDE links you need to backslash-escape the close paren character, like \).

@nickwalkmsft
Copy link

The content for service-level readmes appears to be generated here:

$content = "## Packages - $moniker`r`n"
$content += "[!INCLUDE [packages]($indexTableLink)]"

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 \).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs
Projects
Status: 🎊 Closed
Development

Successfully merging a pull request may close this issue.

3 participants