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

Create an OS onboarding doc #60281

Open
richlander opened this issue Feb 9, 2025 · 5 comments
Open

Create an OS onboarding doc #60281

richlander opened this issue Feb 9, 2025 · 5 comments
Assignees
Labels
area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework Docs This issue tracks updating documentation
Milestone

Comments

@richlander
Copy link
Member

richlander commented Feb 9, 2025

We should create a new OS onboarding doc. I think it will be of significant benefit.

We have been working on one for dotnet/runtime. I suspect such a doc for dotnet/aspnetcore would be significantly shorter. At the very least, we need such a doc for a native code repo and another for a managed code only one so that all other repos can use our smart thinking as guidance.

Want to work on this together @wtgodbe? I suspect it won't take very much time at all. Most of it should be codifying what we did at #60260.

Related: dotnet/runtime#112026

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Feb 9, 2025
@wtgodbe
Copy link
Member

wtgodbe commented Feb 10, 2025

Want to work on this together @wtgodbe? I suspect it won't take very much time at all. Most of it should be codifying what we did at #60260.

Sure! By onboarding, do we mean "Ensuring aspnetcore can be built for & ran on the new OS", and we just need a doc to explain the mechanical steps of doing so in aspnetcore?

@richlander
Copy link
Member Author

Right. I think (A) aspnetcore is much simpler than runtime and (B) most other repos are like aspnetcore.

@wtgodbe
Copy link
Member

wtgodbe commented Feb 10, 2025

Cool - would you be happy with something that:

  • Links to the doc in runtime for more broad context about our OS philosophy
  • Links to this doc for instructions on spinning up a docker container
  • Spells out the specific mechanical steps for adding build/test jobs on the new container in aspnetcore

? If so I can whip something up

@richlander
Copy link
Member Author

Yes.

There are two big things:

  • Which files to edit with some sample PRs (much like the runtime doc does)
  • For managed code, we cross-compile via the SDK (rids and such) and can use one container images for that (Azure Linux x64). This is in contrast to the heavy-lift cross-compiling method the runtime uses. It's so nice to just have C#!

@richlander
Copy link
Member Author

Here's the final URL to the other doc.

https://github.com/dotnet/runtime/blob/main/docs/project/os-onboarding.md

@wtgodbe wtgodbe self-assigned this Feb 10, 2025
@wtgodbe wtgodbe added Docs This issue tracks updating documentation area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework and removed area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates labels Feb 10, 2025
@wtgodbe wtgodbe added this to the 10.0-preview2 milestone Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework Docs This issue tracks updating documentation
Projects
None yet
Development

No branches or pull requests

2 participants