Skip to content

Commit e0e7870

Browse files
authored
Move some links to other doc (#112574)
1 parent cc2019b commit e0e7870

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

docs/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,11 @@ Coding Guidelines
6161
Project Docs
6262
=================
6363

64-
To be added. Visit the [project docs folder](project/) directly meanwhile.
64+
- [Breaking change process](./project/breaking-change-process.md)
65+
- [Copyright](./project/copyright.md)
66+
- [Linux build methodology](./project/linux-build-methodology.md)
67+
- [Onboarding Guide for New Operating System Versions](./project/os-onboarding.md)
68+
- [Project docs folder](./project/)
6569

6670
Other Information
6771
=================

docs/project/os-onboarding.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,14 @@ This witticism is the underlying philosophy of our approach. By actively maintai
88

99
> Users are best served when we act _quickly_ not _exhaustively_.
1010
11-
1211
This double meaning is instructing us to be boldly pragmatic. Each new OS release brings a certain risk of breakage. The risk is far from uniform across the various repos and components that we maintain. Users are best served when we've developed 80% confidence and to leave the remaining (potential) 20% to bug reports. Exhaustive testing serves no one. We've also found that our users do a great job finding corner cases and enthusiastically participate in the process by opening issues in the appropriate repo.
1312

14-
1513
Continuing with the idea of pragmatism, if you only read this far, you've got the basic idea. The rest of the doc describes more context and mechanics.
1614

1715
References:
1816

17+
- [New Operating System Version Onboarding Guide](https://github.com/dotnet/dnceng/blob/main/Documentation/ProjectDocs/OS%20Onboarding/Guidance.md)
1918
- [.NET OS Support Tracking](https://github.com/dotnet/core/issues/9638)
20-
- [.NET Support](https://github.com/dotnet/core/blob/main/support.md)
21-
- [Prereq container image lifecycle](https://github.com/dotnet/dotnet-buildtools-prereqs-docker/blob/main/lifecycle.md)
22-
- [Support for Linux Distros](https://dev.azure.com/dnceng/internal/_wiki/wikis/DNCEng%20Services%20Wiki/940/Support-for-Linux-Distros) (MS internal)
23-
- [Support for Apple Operating Systems](https://dev.azure.com/dnceng/internal/_wiki/wikis/DNCEng%20Services%20Wiki/933/Support-for-Apple-Operating-Systems-(macOS-iOS-and-tvOS)) (MS internal)
24-
- [Support for Windows Operating Systems](https://dev.azure.com/dnceng/internal/_wiki/wikis/DNCEng%20Services%20Wiki/939/Support-for-Windows-Operating-Systems) (MS internal)
2519

2620
## Context
2721

@@ -33,7 +27,7 @@ Nearly all the APIs that touch native code (networking, cryptography) and deal w
3327

3428
Our rule is that we declare support (for all [supported .NET releases](https://github.com/dotnet/core/blob/main/releases.md)) for a new OS version after it is validated in dotnet/runtime `main`. We will only hold support on additional testing in special cases (which are uncommon).
3529

36-
We aim to have "day of" support for about half the OSes we support, including Azure Linux, Ubuntu LTS, and Windows. This means we need to perform ahead-of-time signoff on non-final builds.
30+
We aim to have "day of" support for about half the OSes we support, including Azure Linux, Ubuntu LTS, and Windows. This means we need to perform ahead-of-time signoff on [non-final builds](https://github.com/dotnet/runtime/pull/111768#issuecomment-2617229139).
3731

3832
Our testing philosophy is based on perceived risk and past experience. The effective test matrix is huge, the product of OSes \* supported versions \* architectures. We try to make smart choices to **skip testing most of the matrix** while retaining much of the **practical coverage**. We also know where we tend to get bitten most when we don't pay sufficient attention. For example, our bug risk across Linux, macOS, and Windows is not uniform.
3933

0 commit comments

Comments
 (0)