Skip to content

More API docs #27538

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

Closed
21 tasks done
JunTaoLuo opened this issue Nov 5, 2020 · 9 comments · Fixed by #40106
Closed
21 tasks done

More API docs #27538

JunTaoLuo opened this issue Nov 5, 2020 · 9 comments · Fixed by #40106
Assignees
Labels
affected-few This issue impacts only small number of customers area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions Docs This issue tracks updating documentation feature-json-patch severity-nice-to-have This label is used by an internal tool

Comments

@JunTaoLuo
Copy link
Contributor

JunTaoLuo commented Nov 5, 2020

Looks like there are more API docs that need to be added for the following:

  • Azure
  • Caching
    • Microsoft.Extensions.Caching.StackExchangeRedis @JunTaoLuo
    • Microsoft.Extensions.Caching.SqlServer @JunTaoLuo
  • DataProtection:
    • Microsoft.AspNetCore.DataProtection @pranavkm
  • Features
  • Http
  • JSInterop
  • ObjectPool
  • Razor
  • Security
    • Microsoft.AspNetCore.Authentication.Twitter @HaoK
  • Server
    • Microsoft.AspNetCore.Connections.Abstractions @halter73
    • Microsoft.AspNetCore.Server.Kestrel.Core @sebastienros
    • Microsoft.AspNetCore.Server.Kestrel.Transport.Experimental.Quic @sebastienros
    • Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets @sebastienros
  • SignalR
  • WebEncoders
@JunTaoLuo JunTaoLuo added Docs This issue tracks updating documentation feature-platform Deprecated: Cross-cutting issues related to ASP.NET Core as a platform labels Nov 5, 2020
@JunTaoLuo
Copy link
Contributor Author

We'll need to divide this up fyi @pranavkm

@dougbu
Copy link
Contributor

dougbu commented Nov 18, 2020

@JunTaoLuo please check if #27285 already lists the problem areas you mentioned above. If not, please mention this issue in the description.

@JunTaoLuo JunTaoLuo added affected-few This issue impacts only small number of customers severity-nice-to-have This label is used by an internal tool labels Dec 23, 2020
@JunTaoLuo
Copy link
Contributor Author

Hey folks. I took a look at the rest of the projects missing API docs and divided up the work. I've tried to assign folks with areas they are familiar with but let me know if they need to be reassigned.

@BrennanConroy BrennanConroy removed their assignment Jan 6, 2021
@JunTaoLuo JunTaoLuo removed their assignment Jan 8, 2021
@HaoK HaoK removed their assignment Jan 21, 2021
@JamesNK JamesNK removed their assignment Jan 21, 2021
@BrennanConroy BrennanConroy added area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates and removed feature-platform Deprecated: Cross-cutting issues related to ASP.NET Core as a platform labels Jan 29, 2021
@BrennanConroy BrennanConroy added this to the Next sprint planning milestone Jan 29, 2021
@ghost
Copy link

ghost commented Jan 29, 2021

Thanks for contacting us.
We're moving this issue to the Next sprint planning milestone for future evaluation / consideration. We will evaluate the request when we are planning the work for the next milestone. To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

TanayParikh added a commit to dotnet/AspNetApiDocs that referenced this issue Jan 29, 2021
@TanayParikh TanayParikh removed their assignment Jan 29, 2021
TanayParikh added a commit to dotnet/AspNetApiDocs that referenced this issue Jan 30, 2021
* Add Docs for Microsoft.AspNetCore.Razor

For dotnet/aspnetcore#27538

* Update aspnet-core/xml/ns-Microsoft.AspNetCore.Razor.xml

Co-authored-by: N. Taylor Mullen <[email protected]>

Co-authored-by: N. Taylor Mullen <[email protected]>
@sebastienros
Copy link
Member

I checked the remaining boxes to be ticked and couldn't find any namespace without doc. Can someone validate?

@sebastienros sebastienros removed their assignment Sep 8, 2021
@BrennanConroy
Copy link
Member

We want to remove most of the CS1591 warning skips, there are still a few left (Kestrel has some)
https://github.com/dotnet/aspnetcore/search?q=CS1591

@mkArtakMSFT mkArtakMSFT modified the milestones: 6.0.0, 6.0-docs-infra Oct 19, 2021
@SteveSandersonMS SteveSandersonMS removed their assignment Oct 21, 2021
@pranavkm pranavkm removed this from the 7.0-preview1 milestone Feb 7, 2022
@rafikiassumani-msft rafikiassumani-msft added this to the .NET 7 Planning milestone Feb 9, 2022
@ghost
Copy link

ghost commented Feb 9, 2022

Thanks for contacting us.

We're moving this issue to the .NET 7 Planning milestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s).
If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues.
To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

@wtgodbe
Copy link
Member

wtgodbe commented Feb 9, 2022

@SteveSandersonMS @TanayParikh @pranavkm @halter73 looks like there are still some missing doc comments for JsonPatch, Razor, and Connections.Abstractions. I removed the other CS1591s in #40104

@wtgodbe
Copy link
Member

wtgodbe commented Feb 9, 2022

Actually all of the CS1591's are still active, there are a bunch of doc comments to add in Kestrel too.

pranavkm added a commit that referenced this issue Feb 10, 2022
* Fix nearly all CS1591

Fixes #27538
@ghost ghost locked as resolved and limited conversation to collaborators Mar 12, 2022
@amcasey amcasey added area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions and removed area-runtime labels Jun 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affected-few This issue impacts only small number of customers area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions Docs This issue tracks updating documentation feature-json-patch severity-nice-to-have This label is used by an internal tool
Projects
None yet
Development

Successfully merging a pull request may close this issue.