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

Ref Docs for Storage Blob - page doesn't display correctly #11723

Closed
diberry opened this issue Oct 8, 2020 · 4 comments
Closed

Ref Docs for Storage Blob - page doesn't display correctly #11723

diberry opened this issue Oct 8, 2020 · 4 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs

Comments

@diberry
Copy link
Contributor

diberry commented Oct 8, 2020

Ref doc page - https://docs.microsoft.com/en-us/javascript/api/@azure/storage-blob/blobserviceclient?view=azure-node-latest

Issue is with string Creates a <xref:ContainerClient> object where the xref should instead be translated into a link.

image

I would like to know if this is localized to this package or in general across all packages.

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 8, 2020
@diberry
Copy link
Contributor Author

diberry commented Oct 8, 2020

Another one -
image

@diberry
Copy link
Contributor Author

diberry commented Oct 8, 2020

image

@ramya-rao-a
Copy link
Contributor

Hey @diberry

This is a known issue with the rendering system used by docs.microsoft.com for reference docs that we reported more than a year ago.
In the source code, these are @link tags pointing to other classes in the same package.

What would your recommendation here be?
Our hope was that the docs rendering system would catch up and have these fixed rather than lose out a chance to have inter linking in our docs

@ramya-rao-a ramya-rao-a added Client This issue points to a problem in the data-plane of the library. Docs labels Oct 8, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 8, 2020
@ramya-rao-a ramya-rao-a self-assigned this Oct 8, 2020
@ramya-rao-a ramya-rao-a added this to the Backlog milestone Oct 8, 2020
@diberry
Copy link
Contributor Author

diberry commented Dec 15, 2020

Closed because it is tracking in ref working group.

@diberry diberry closed this as completed Dec 15, 2020
@xirzec xirzec removed this from the Backlog milestone May 17, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs
Projects
None yet
Development

No branches or pull requests

3 participants