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

Refactor and Update Main Workflow Documentation #76896

Closed
5 tasks
ivdiazsa opened this issue Oct 11, 2022 · 2 comments · Fixed by #107415
Closed
5 tasks

Refactor and Update Main Workflow Documentation #76896

ivdiazsa opened this issue Oct 11, 2022 · 2 comments · Fixed by #107415
Assignees
Labels
area-Infrastructure-coreclr documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Milestone

Comments

@ivdiazsa
Copy link
Member

This is a tracking issue for an active ongoing effort to improve the dotnet/runtime repo's docs. It started as a QW with its milestone achieved in PR #75569. After receiving feedback from several experts, there are more areas of opportunity to improve our docs, which this issue aims to keep track of.

The current list of pending items:

  • Move/refactor the instructions docs within docs/workflow/building/coreclr to a more general level, since a handful of the instructions defined in those docs apply to the whole repo. Rewrite as needed, so that it's all clear and add specific subset docs as needed (if any).
  • Update FreeBSD instructions and requirements.
  • Universalize Markdown formatting throughout the docs.
  • Ensure there is at least one path to every doc in the repo.
  • Pass through files untouched by the aforementioned PR and add whatever work items are found to this template.

Setting the milestone to .NET 8 to help keep this issue relevant and not forgotten :)

@ivdiazsa ivdiazsa added the documentation Documentation bug or enhancement, does not impact product or test code label Oct 11, 2022
@ivdiazsa ivdiazsa added this to the 8.0.0 milestone Oct 11, 2022
@ivdiazsa ivdiazsa self-assigned this Oct 11, 2022
@dotnet-issue-labeler
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@ghost
Copy link

ghost commented Oct 12, 2022

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

Issue Details

This is a tracking issue for an active ongoing effort to improve the dotnet/runtime repo's docs. It started as a QW with its milestone achieved in PR #75569. After receiving feedback from several experts, there are more areas of opportunity to improve our docs, which this issue aims to keep track of.

The current list of pending items:

  • Move/refactor the instructions docs within docs/workflow/building/coreclr to a more general level, since a handful of the instructions defined in those docs apply to the whole repo. Rewrite as needed, so that it's all clear and add specific subset docs as needed (if any).
  • Update FreeBSD instructions and requirements.
  • Universalize Markdown formatting throughout the docs.
  • Ensure there is at least one path to every doc in the repo.
  • Pass through files untouched by the aforementioned PR and add whatever work items are found to this template.

Setting the milestone to .NET 8 to help keep this issue relevant and not forgotten :)

Author: ivdiazsa
Assignees: ivdiazsa
Labels:

documentation, area-Infrastructure-coreclr

Milestone: 8.0.0

@ivdiazsa ivdiazsa modified the milestones: 8.0.0, 9.0.0 Aug 9, 2023
@ivdiazsa ivdiazsa modified the milestones: 9.0.0, Future Jan 23, 2024
@ivdiazsa ivdiazsa linked a pull request Sep 16, 2024 that will close this issue
@dotnet-policy-service dotnet-policy-service bot added the in-pr There is an active PR which will close this issue when it is merged label Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Infrastructure-coreclr documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants