-
Notifications
You must be signed in to change notification settings - Fork 167
Add a design index #190
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
Merged
Merged
Add a design index #190
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| <!-- | ||
|
|
||
| This file is auto-generated. Direct changes to it maybe lost. | ||
|
|
||
| Use update-index to regenerate it: | ||
|
|
||
| ./update-index > INDEX.md | ||
|
|
||
| --> | ||
|
|
||
| # Meta | ||
|
|
||
| | Design Name | | ||
| | ----------- | | ||
| | [Proposal Template](meta/template.md) | | ||
| | [Proposals](meta/proposals.md) | | ||
|
|
||
| # Accepted | ||
|
|
||
| | Year | Design Name | Owner | | ||
| | ---- | ----------- | ----- | | ||
| | 2018 | [.NET Core SDK Versioning](accepted/2018/sdk-version-scheme.md) | [Kathleen Dollard](https://github.com/KathleenDollard) | | ||
| | 2018 | [.NET Platform Dependent Intrinsics](accepted/2018/platform-intrinsics.md) | [Russell Hadley](https://github.com/russellhadley) | | ||
| | 2018 | [Automatic Binding Redirection By Default](accepted/2018/automatic-redirects-by-default/automatic-redirects-by-default.md) | [Immo Landwerth](https://github.com/terrajobst), [Rainer Sigwald](https://github.com/rainersigwald) | | ||
| | 2018 | [CLI Syntax Guidelines](accepted/2018/cli-syntax-guideline.md) | [Kathleen Dollard](https://github.com/KathleenDollard) | | ||
| | 2018 | [Cross-Platform Performance Monitoring Design](accepted/2018/cross-platform-performance-monitoring.md) | [Brian Robbins](https://github.com/brianrob) | | ||
| | 2018 | [Extensible File Enumeration](accepted/2018/file-enumeration.md) | [Immo Landwerth](https://github.com/terrajobst), [Jeremy Kuhne](https://github.com/jeremykuhne) | | ||
| | 2018 | [Package Information in API Reference](accepted/2018/package-doc/package-doc.md) | [Immo Landwerth](https://github.com/terrajobst), [Wes Haggard](https://github.com/weshaggard) | | ||
| | 2018 | [Performance Profiling Controller Design](accepted/2018/performance-profiling-controller.md) | [Brian Robbins](https://github.com/brianrob) | | ||
| | 2018 | [Rolling self-contained .NET Core app deployments forward to the latest patch](accepted/2018/self-contained-roll-forward.md) | [Daniel Plaisted](https://github.com/dsplaisted) | | ||
| | 2018 | [Standardized Environment Variables for CI Services](accepted/2018/build/standard-ci-env-variables.md) | [Tomáš Matoušek](https://github.com/tmat) | | ||
| | 2018 | [Windows Compatibility Pack](accepted/2018/compat-pack/compat-pack.md) | [Immo Landwerth](https://github.com/terrajobst), [Wes Haggard](https://github.com/weshaggard) | | ||
| | 2019 | [.NET Core GC Support for Docker Limits](accepted/2019/support-for-memory-limits.md) | [Rich Lander](https://github.com/richlander) | | ||
| | 2019 | [Background](accepted/2019/targeting-packs-and-runtime-packs.md) | [Rich Lander](https://github.com/richlander), [Nick Guerrera](https://github.com/nguerrera) | | ||
| | 2019 | [Runtime Binding Behavior](accepted/2019/runtime-binding.md) | [Rich Lander](https://github.com/richlander) | | ||
| | 2019 | [System.Index and System.Range](accepted/2019/system-range/system-range.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [.NET 5 Minimum OS Versioning](accepted/2020/minimum-os-version/minimum-os-version.md) | [Mikayla Hutchinson](https://github.com/mhutch) | | ||
| | 2020 | [.NET Core 3.0 AppDomain Replacement Design and Guidance](accepted/2020/AssemblyLoadContext/AppDomainReplacement.md) | [Steve MacLean](https://github.com/sdmaclea) | | ||
| | 2020 | [.NET Optional SDK Workloads](accepted/2020/workloads/workloads.md) | [Rich Lander](https://github.com/richlander) | | ||
| | 2020 | [.NET Runtime Form Factors](accepted/2020/form-factors.md) | [Rich Lander](https://github.com/richlander), [Jan Kotas](https://github.com/jkotas) | | ||
| | 2020 | [.NET SDK Workload Manifests](accepted/2020/workloads/workload-manifest.md) | [Rich Lander](https://github.com/richlander) | | ||
| | 2020 | [ASN.1 BER/CER/DER Reader & Writer](accepted/2020/asnreader/asnreader.md) | [Jeremy Barton](https://github.com/bartonjs) | | ||
| | 2020 | [Annotating APIs as unsupported on specific platforms](accepted/2020/platform-exclusion/platform-exclusion.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Annotating platform-specific APIs and detecting its use](accepted/2020/platform-checks/platform-checks.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Better Obsoletion](accepted/2020/better-obsoletion/better-obsoletion.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [BinaryFormatter Obsoletion Strategy](accepted/2020/better-obsoletion/binaryformatter-obsoletion.md) | [Levi Broderick](https://github.com/GrabYourPitchforks) | | ||
| | 2020 | [CBOR Reader & Writer](accepted/2020/cbor/cbor.md) | [Eirik Tsarpalis](https://github.com/eiriktsarpalis) | | ||
| | 2020 | [Easy Acquisition of .NET Framework Targeting Packs](accepted/2020/targeting-packs/targeting-packs.md) | [Immo Landwerth](https://github.com/terrajobst), [Daniel Plaisted](https://github.com/dsplaisted) | | ||
| | 2020 | [Feature switch](accepted/2020/feature-switch.md) | [Vitek Karas](https://github.com/vitek-karas) | | ||
| | 2020 | [Globalization Support in .NET 5](accepted/2020/mono-convergence/globalization-support-in-.net5.md) | [Steve Pfister](https://github.com/steveisok) | | ||
| | 2020 | [Improve Activity API usability and OpenTelemetry integration](accepted/2020/diagnostics/activity-improvements.md) | [Sourabh Shirhatti](https://github.com/shirhatti), [Ankit Srivastava](https://github.com/ankit-oss) [Tarek Mahmoud Sayed](https://github.com/tarekgh) | | ||
| | 2020 | [Improve Activity API usability and OpenTelemetry integration (Part 2)](accepted/2020/diagnostics/activity-improvements-2.md) | [Sourabh Shirhatti](https://github.com/shirhatti), [Tarek Mahmoud Sayed](https://github.com/tarekgh) | | ||
| | 2020 | [Install location search for .NET Core](accepted/2020/install-locations.md) | [Vitek Karas](https://github.com/vitek-karas) | | ||
| | 2020 | [JSON extension methods for HttpClient](accepted/2020/json-http-extensions/json-http-extensions.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Linking the .NET Libraries](accepted/2020/linking-libraries.md) | [Eric Erhardt](https://github.com/eerhardt) | | ||
| | 2020 | [MSBuild SDK Resolvers and optional workloads in .NET 5](accepted/2020/workloads/workload-resolvers.md) | [Rich Lander](https://github.com/richlander) | | ||
| | 2020 | [Marking APIs that are unsupported by Blazor WebAssembly](accepted/2020/blazor-unsupported-apis/blazor-unsupported-apis.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Marking Windows-only APIs](accepted/2020/windows-specific-apis/windows-specific-apis.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [OR_GREATER preprocessor symbols for TFMs](accepted/2020/or-greater-defines/or-greater-defines.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Obsoletions in .NET 5](accepted/2020/better-obsoletion/obsoletions-in-net5.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Overview and goals](accepted/2020/serializer/SerializerGoals5.0.md) | [Steve Harter](https://github.com/steveharter) | | ||
| | 2020 | [Platform Specific HttpClient Support in dotnet/runtime](accepted/2020/mono-convergence/platform-specific-httpclient.md) | [Steve Pfister](https://github.com/steveisok) | | ||
| | 2020 | [Portable PDB](accepted/2020/diagnostics/portable-pdb.md) | [Tomáš Matoušek](https://github.com/tmat) | | ||
| | 2020 | [Proposal for global.json](accepted/2020/global-json-updates.md) | [Kathleen Dollard](https://github.com/KathleenDollard) | | ||
| | 2020 | [Publishing and Consuming Symbols and Source for Debugging](accepted/2020/diagnostics/debugging-with-symbols-and-sources.md) | [Tomáš Matoušek](https://github.com/tmat) | | ||
| | 2020 | [Reproducible Build Validation](accepted/2020/reproducible-builds.md) | [Claire Novotny](https://github.com/clairernovotny), [Jared Parsons](https://github.com/jaredpar) | | ||
| | 2020 | [Single-file Publish](accepted/2020/single-file/design.md) | [Swaroop Sridhar](https://github.com/swaroop-sridhar) | | ||
| | 2020 | [Single-file Publish for .NET Core 3.0](accepted/2020/single-file/design_3_0.md) | [Swaroop Sridhar](https://github.com/swaroop-sridhar) | | ||
| | 2020 | [Source Link](accepted/2020/diagnostics/source-link.md) | [Tomáš Matoušek](https://github.com/tmat) | | ||
| | 2020 | [Target Framework Names in .NET 5](accepted/2020/net5/net5.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2020 | [Type for holding & converting binary data](accepted/2020/binary-data/binary-data.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2021 | [.NET 6.0 Target Frameworks](accepted/2021/net6.0-tfms/net6.0-tfms.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2021 | [Designs](accepted/2021/statics-in-interfaces/designs/README.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2021 | [Requirements](accepted/2021/statics-in-interfaces/requirements/README.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2021 | [Scenarios](accepted/2021/statics-in-interfaces/scenarios/README.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
| | 2021 | [Statics in Interfaces](accepted/2021/statics-in-interfaces/README.md) | [Immo Landwerth](https://github.com/terrajobst) | | ||
|
|
||
| # Proposed | ||
|
|
||
| | Design Name | Owner | | ||
| | ----------- | ----- | | ||
| | [Flexible HTTP APIs](proposed/flexible-http.md) | [Cory Nelson](https://github.com/scalablecory), [Geoff Kizer](https://github.com/geoffkizer) | | ||
| | [Readonly references in C# and IL verification.](proposed/verifiable-ref-readonly.md) | | | ||
| | [Ref returns in C# and IL verification.](proposed/verifiable-ref-returns.md) | | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
accepted/2020/better-obsoletion/binaryformatter-obsoletion.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Static in interfaces are split over multiple documents. It is not clear by looking at the index that all these 4 documents are for static in interfaces.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching this! Do you think it makes more sense to have a single entry for "Statics In Interfaces" or should we list the individual sub-designs with a prefix like "Statics In Interfaces": "Statics In Interfaces: Requirements", "Statics In Interfaces: Scenarios" and "Statics In Interfaces: Designs"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I recommend just a single entry for these design that are being spread over multiple documents--just pointing to the top-level README for them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would make sense to have just a single entry for Statics in Interfaces. The top level Statics in Interfaces doc can have links to the other ones.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would opt for a process that can be easily generated with @omajid's update script. Leaving designs out is probably harder than, say, a prefix notation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The script uses a heuristic to separate main designs from subdesigns: If the document lists a PM/Dev (soon Owner), then the document is treated as a main (or top-level) design.
For Statics In Interfaces, it sounds like the main design is
accepted/2021/statics-in-interfaces/README.mdand the rest are the components. If we removed PM/Dev from those documents, the scripts will just ignore them.(I also think it makes sense to do anyway: there aren't separate Owners for the Design vs Requirements vs Scenarios, are there?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, I can fix the script to ignore a certain level of nesting as sub-designs and only look for top-level documents.