-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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
ApiCatalog build infrastructure should be updated #996
Comments
cc: @danmosemsft |
Quick thoughts on how this can work:
|
Here is the plan @safern and I came up with:
|
Merge from dotnet/runtime
@carlossanlop should this issue be closed now? |
The docs team needs the following assets from repositories:
Instead of having an orchestration point (currently apicatalog-infra repo) that bundles all the assets together from different repositories and which is a completely manually process today, we could design a push model. Any repository that needs/wants to participate in the docs team process, would generate their own transport package. Example name pattern:
|
Contributes to #996. Add a nuget package that contains all the reference assemblies and source-of-truth API docs XML files for the current release.
…89312) * Create docs ref+xml transport package Contributes to #996. Add a nuget package that contains all the reference assemblies and source-of-truth API docs XML files for the current release. * Turn on source of truth for Microsoft.Extensions.* Make the source of truth for API docs for the Microsoft.Extensions.* libraries dotnet/runtime instead of the intellisense package. Disable the few projects that aren't yet documented. Same for libraries that are already effectively source-of-truth in runtime but which aren't documented. * Add missing triple slash docs in Primitives * Fill in missing keyed DI doc comments. * Add memory cache triple slash docs * Add more missing docs * Add more missing docs * More missing docs * More docs * More * Add Microsoft.Extensions.Logging.Console docs * Microsoft.Extensions.Hosting docs * Exclude Microsoft.Bcl.* * Update src/libraries/Microsoft.Internal.Runtime.DotNetApiDocs.Transport/src/Microsoft.Internal.Runtime.DotNetApiDocs.Transport.proj Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --------- Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com> Co-authored-by: Aditya Mandaleeka <adityam@microsoft.com> Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
The ApiCatalog build should just run after the official build and use its artfacts to restore. Also, it should be shared to generate the docs layout that we use for the docs team. I already have some targets to generate the docs layout that I should tweak for this to work for both scenarios.
safern/corefx@099258b
cc: @ahsonkhan @ericstj @carlossanlop
The text was updated successfully, but these errors were encountered: