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

AddQuickGridEntityFrameworkAdapter is missing from API docs #55136

Closed
1 task done
guardrex opened this issue Apr 15, 2024 · 14 comments
Closed
1 task done

AddQuickGridEntityFrameworkAdapter is missing from API docs #55136

guardrex opened this issue Apr 15, 2024 · 14 comments
Assignees
Labels
area-blazor Includes: Blazor, Razor Components Docs This issue tracks updating documentation
Milestone

Comments

@guardrex
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

Working on the QuickGrid docs and noticed that AddQuickGridEntityFrameworkAdapter is missing from API docs, so our article can't cross-link ...

https://learn.microsoft.com/dotnet/api/?term=AddQuickGridEntityFrameworkAdapter

API: https://github.com/dotnet/aspnetcore/blob/main/src/Components/QuickGrid/Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter/src/EntityFrameworkAdapterServiceCollectionExtensions.cs#L18

Expected Behavior

N/A

Steps To Reproduce

N/A

Exceptions (if any)

N/A

.NET Version

8.0

Anything else?

No response

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-blazor Includes: Blazor, Razor Components label Apr 15, 2024
@mkArtakMSFT mkArtakMSFT added the Docs This issue tracks updating documentation label Apr 16, 2024
@mkArtakMSFT mkArtakMSFT self-assigned this Apr 16, 2024
@mkArtakMSFT mkArtakMSFT added this to the 9.0-preview4 milestone Apr 16, 2024
@mkArtakMSFT
Copy link
Member

@Rick-Anderson do you know who can help with this?

@Rick-Anderson
Copy link
Contributor

@guardrex we could schedule an API build but why don't you just link to the source ?
cc @tdykstra

@guardrex
Copy link
Contributor Author

guardrex commented Apr 16, 2024

The public API should be in the API docs AFAIK, and linking to source isn't best for versioning the API, given that we link to the main branch. Also, that ugly NOTE has to be placed telling readers how to get to the right repo branch.

I thought that there was just a simple internal form/process that gets it consumed for API docs. We just went through this for QuickGrid ...

#52466

Did @v-alje help with that?

@mkArtakMSFT
Copy link
Member

@v-alje is this something you can help with?

@v-alje
Copy link

v-alje commented Apr 25, 2024

@mkArtakMSFT What is the NuGet package for this?

@guardrex
Copy link
Contributor Author

@guardrex
Copy link
Contributor Author

BTW @v-alje ... If I come across additional missing API in the API docs, are you the person to reach out to? If so, what's the best way to file an issue like this for you?

@v-alje
Copy link

v-alje commented Apr 26, 2024

@guardrex Yes. Please file requests using this template: https://dev.azure.com/msft-skilling/Content/_workitems/create/User%20Story?templateId=39fb91e3-64a2-4c8a-83db-b2bdf3603dd3&ownerId=c4a28f90-17ae-4384-b514-7273392b082b and specify which NuGet package is missing in the source section.

@guardrex
Copy link
Contributor Author

guardrex commented Apr 26, 2024

Sorry, I'm unable to directly do that myself (no access). In the future, I'll ask Rick or one of the FTE MS docs folks to do it for me. Thanks for the link! This happens about once or twice a year around here.

@mkArtakMSFT
Copy link
Member

Hi @v-alje, @guardrex. Do you want me to file the request or was it already filed ?

@guardrex
Copy link
Contributor Author

guardrex commented May 1, 2024

Yes, please do. I can't reach that form.

@v-alje
Copy link

v-alje commented May 1, 2024

@mkArtakMSFT You can use: https://dev.azure.com/msft-skilling/Content/_workitems/edit/248694 The preview is up on the review site

@mkArtakMSFT
Copy link
Member

@v-alje this can be closed now, correct?

@v-alje
Copy link

v-alje commented May 6, 2024

Yes. The Changed from processing https://www.nuget.org/packages/Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter/ has been published.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-blazor Includes: Blazor, Razor Components Docs This issue tracks updating documentation
Projects
None yet
Development

No branches or pull requests

4 participants