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.

Sign up for GitHub

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

Jump to bottom

Provide workflow to automatically port API docs to dotnet-api-docs #41419

Closed
jkoritzinsky opened this issue Aug 26, 2020 · 6 comments
Closed

Provide workflow to automatically port API docs to dotnet-api-docs #41419

jkoritzinsky opened this issue Aug 26, 2020 · 6 comments
Labels
area-Infrastructure-libraries
Milestone
8.0.0

Comments

@jkoritzinsky
Copy link
Member

During each release cycle we add new APIs and documentation for them. Currently, the process of moving docs over from the triple-slash comments in dotnet/runtime to the API docs on https://docs.dot.net has a number of manual steps.

I propose that we add a GitHub Action (preferable) or manually-triggered Azure DevOps Pipeline to auto-port the doc comments per-assembly to PRs opened against the dotnet/dotnet-api-docs repository.
@ghost
Copy link

ghost commented Aug 26, 2020

Tagging subscribers to this area: @ViktorHofer
See info in area-owners.md if you want to be subscribed.

@Dotnet-GitSync-Bot Dotnet-GitSync-Bot added the untriaged New issue has not been triaged by the area owner label Aug 26, 2020
@safern
Copy link
Member

safern commented Aug 26, 2020

Cc: @carlossanlop

@safern safern added this to the 6.0.0 milestone Aug 26, 2020
@safern
Copy link
Member

safern commented Aug 26, 2020

Marking as 6.0.0

@jeffschwMSFT jeffschwMSFT removed the untriaged New issue has not been triaged by the area owner label Aug 31, 2020
@ViktorHofer ViktorHofer modified the milestones: 6.0.0, 7.0.0 Aug 4, 2021
@ghost
Copy link

ghost commented Jul 29, 2022

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

During each release cycle we add new APIs and documentation for them. Currently, the process of moving docs over from the triple-slash comments in dotnet/runtime to the API docs on https://docs.dot.net has a number of manual steps.

I propose that we add a GitHub Action (preferable) or manually-triggered Azure DevOps Pipeline to auto-port the doc comments per-assembly to PRs opened against the dotnet/dotnet-api-docs repository.

Author: jkoritzinsky
Assignees: -
Labels:

area-Infrastructure-libraries
Milestone: 7.0.0

@ViktorHofer ViktorHofer modified the milestones: 7.0.0, 8.0.0 Aug 1, 2022
@ViktorHofer
Copy link
Member

cc @carlossanlop @jeffhandley

@ViktorHofer
Copy link
Member

Duplicate of #44969

@ViktorHofer ViktorHofer marked this as a duplicate of #44969 Jul 12, 2023
@ViktorHofer ViktorHofer closed this as not planned Won't fix, can't repro, duplicate, stale Jul 12, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Aug 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
area-Infrastructure-libraries
Projects
Runtime Infra
Archived in project
Milestone
8.0.0
Development

No branches or pull requests
7 participants
@agocke @carlossanlop @jkoritzinsky @ViktorHofer @jeffschwMSFT @safern @Dotnet-GitSync-Bot