From 3f2ac8ff386aa39216c12b06999ae5b42d6e89e0 Mon Sep 17 00:00:00 2001 From: Zlatko Knezevic Date: Wed, 17 Jun 2015 07:53:44 -0700 Subject: [PATCH] Add folders to CoreFX Documentation Align to the way CoreCLR is handling its Documentation folder in the repo. Add folders. Changed README.md in root, Documentation as well as CONTRIBUTING.md with new links. Commit migrated from https://github.com/dotnet/corefx/commit/06a5ba78cf8129605261fe8d2b1eb45069d53d68 --- docs/libraries/README.md | 60 ++++++++++--------- .../libraries/{ => building}/code-coverage.md | 0 .../{ => building}/unix-instructions.md | 0 .../{ => building}/windows-instructions.md | 0 .../breaking-change-definitions.md | 0 .../breaking-change-rules.md | 0 .../breaking-changes.md | 0 .../{ => coding-guidelines}/coding-style.md | 0 .../cross-platform-guidelines.md | 0 .../framework-design-guidelines-digest.md | 0 .../interop-guidelines.md | 0 .../performance-guidelines.md | 2 +- .../{ => project-docs}/api-review-process.md | 2 +- .../{ => project-docs}/branching-guide.md | 0 .../{ => project-docs}/contributing.md | 4 +- .../{ => project-docs}/developer-guide.md | 0 .../{ => project-docs}/issue-guide.md | 0 .../{ => project-docs}/oss-signing.md | 0 .../{ => project-docs}/repo-organization.md | 0 .../{ => project-docs}/strong-name-signing.md | 0 .../support-dotnet-core-instructions.md | 10 ++-- 21 files changed, 41 insertions(+), 37 deletions(-) rename docs/libraries/{ => building}/code-coverage.md (100%) rename docs/libraries/{ => building}/unix-instructions.md (100%) rename docs/libraries/{ => building}/windows-instructions.md (100%) rename docs/libraries/{ => coding-guidelines}/breaking-change-definitions.md (100%) rename docs/libraries/{ => coding-guidelines}/breaking-change-rules.md (100%) rename docs/libraries/{ => coding-guidelines}/breaking-changes.md (100%) rename docs/libraries/{ => coding-guidelines}/coding-style.md (100%) rename docs/libraries/{ => coding-guidelines}/cross-platform-guidelines.md (100%) rename docs/libraries/{ => coding-guidelines}/framework-design-guidelines-digest.md (100%) rename docs/libraries/{ => coding-guidelines}/interop-guidelines.md (100%) rename docs/libraries/{ => coding-guidelines}/performance-guidelines.md (94%) rename docs/libraries/{ => project-docs}/api-review-process.md (99%) rename docs/libraries/{ => project-docs}/branching-guide.md (100%) rename docs/libraries/{ => project-docs}/contributing.md (82%) rename docs/libraries/{ => project-docs}/developer-guide.md (100%) rename docs/libraries/{ => project-docs}/issue-guide.md (100%) rename docs/libraries/{ => project-docs}/oss-signing.md (100%) rename docs/libraries/{ => project-docs}/repo-organization.md (100%) rename docs/libraries/{ => project-docs}/strong-name-signing.md (100%) rename docs/libraries/{ => project-docs}/support-dotnet-core-instructions.md (92%) diff --git a/docs/libraries/README.md b/docs/libraries/README.md index 7e3248f23bc..cda8094b2b3 100644 --- a/docs/libraries/README.md +++ b/docs/libraries/README.md @@ -1,58 +1,62 @@ Documents Index =============== +Intro to .NET Core +================== + +.NET Core is a self-contained .NET runtime and framework that implements ECMA 335. It can be (and has been) ported to multiple architectures and platforms. It support a variety of installation options, having no specific deployment requirements itself. + Learn about .NET Core ==================== -- [Brief Intro to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/dotnetcore-intro.md) - [[WIP] Official .NET Core Docs](http://dotnet.readthedocs.org) Get .NET Core ============= -- [Get .NET Core DNX SDK on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-dnx-windows.md) -- [Get .NET Core DNX SDK on OS X](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-dnx-osx.md) -- [Get .NET Core DNX SDK on Linux](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-dnx-linux.md) -- [Get .NET Core (Raw) on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/get-dotnetcore-windows.md) +- [Get .NET Core DNX SDK on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-dnx-windows.md) +- [Get .NET Core DNX SDK on OS X](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-dnx-osx.md) +- [Get .NET Core DNX SDK on Linux](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-dnx-linux.md) +- [Get .NET Core (Raw) on Windows](https://github.com/dotnet/coreclr/blob/master/Documentation/install/get-dotnetcore-windows.md) Project Docs ============ -- [Developer Guide](developer-guide.md) -- [Project priorities](https://github.com/dotnet/coreclr/blob/master/Documentation/project-priorities.md) -- [Contributing to CoreFX](contributing.md) -- [Contributing to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/contributing.md) -- [Contributing Workflow](https://github.com/dotnet/coreclr/blob/master/Documentation/contributing-workflow.md) -- [Issue Guide](issue-guide.md) -- [Branching Guide](branching-guide.md) -- [API Review Process](api-review-process.md) -- [Strong Name Signing](strong-name-signing.md) -- [Open Source Signing](oss-signing.md) -- [Repo Organization](repo-organization.md) +- [Developer Guide](project-docs/developer-guide.md) +- [Project priorities](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/project-priorities.md) +- [Contributing to CoreFX](project-docs/contributing.md) +- [Contributing to .NET Core](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md) +- [Contributing Workflow](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing-workflow.md) +- [Issue Guide](project-docs/issue-guide.md) +- [Branching Guide](project-docs/branching-guide.md) +- [API Review Process](project-docs/api-review-process.md) +- [Strong Name Signing](project-docs/strong-name-signing.md) +- [Open Source Signing](project-docs/oss-signing.md) +- [Repo Organization](project-docs/repo-organization.md) Coding Guidelines ================= -- [C# coding style](coding-style.md) -- [Framework Design Guidelines](framework-design-guidelines-digest.md) -- [Cross-Platform Guidelines](cross-platform-guidelines.md) -- [Performance Guidelines](performance-guidelines.md) -- [Interop Guidelines](interop-guidelines.md) -- [Breaking Changes](breaking-changes.md) -- [Breaking Change Definitions](breaking-change-definitions.md) -- [Breaking Change Rules](breaking-change-rules.md) +- [C# coding style](coding-guidelines/coding-style.md) +- [Framework Design Guidelines](coding-guidelines/framework-design-guidelines-digest.md) +- [Cross-Platform Guidelines](coding-guidelines/cross-platform-guidelines.md) +- [Performance Guidelines](coding-guidelines/performance-guidelines.md) +- [Interop Guidelines](coding-guidelines/interop-guidelines.md) +- [Breaking Changes](coding-guidelines/breaking-changes.md) +- [Breaking Change Definitions](coding-guidelines/breaking-change-definitions.md) +- [Breaking Change Rules](coding-guidelines/breaking-change-rules.md) Building from Source ==================== -- [Building CoreFX on FreeBSD, Linux and OS X](unix-instructions.md) -- [Code Coverage](code-coverage.md) +- [Building CoreFX on FreeBSD, Linux and OS X](building/unix-instructions.md) +- [Code Coverage](building/code-coverage.md) Other Information ================= - [CoreCLR Repo documentation](https://github.com/dotnet/coreclr/tree/master/Documentation) -- [Porting to .NET Core](support-dotnet-core-instructions.md) -- [.NET Standards (Ecma)](https://github.com/dotnet/coreclr/blob/master/Documentation/dotnet-standards.md) +- [Porting to .NET Core](project-docs/support-dotnet-core-instructions.md) +- [.NET Standards (Ecma)](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/dotnet-standards.md) - [MSDN Entry for the CLR](http://msdn.microsoft.com/library/8bs2ecf4.aspx) - [Wikipedia Entry for the CLR](http://en.wikipedia.org/wiki/Common_Language_Runtime) diff --git a/docs/libraries/code-coverage.md b/docs/libraries/building/code-coverage.md similarity index 100% rename from docs/libraries/code-coverage.md rename to docs/libraries/building/code-coverage.md diff --git a/docs/libraries/unix-instructions.md b/docs/libraries/building/unix-instructions.md similarity index 100% rename from docs/libraries/unix-instructions.md rename to docs/libraries/building/unix-instructions.md diff --git a/docs/libraries/windows-instructions.md b/docs/libraries/building/windows-instructions.md similarity index 100% rename from docs/libraries/windows-instructions.md rename to docs/libraries/building/windows-instructions.md diff --git a/docs/libraries/breaking-change-definitions.md b/docs/libraries/coding-guidelines/breaking-change-definitions.md similarity index 100% rename from docs/libraries/breaking-change-definitions.md rename to docs/libraries/coding-guidelines/breaking-change-definitions.md diff --git a/docs/libraries/breaking-change-rules.md b/docs/libraries/coding-guidelines/breaking-change-rules.md similarity index 100% rename from docs/libraries/breaking-change-rules.md rename to docs/libraries/coding-guidelines/breaking-change-rules.md diff --git a/docs/libraries/breaking-changes.md b/docs/libraries/coding-guidelines/breaking-changes.md similarity index 100% rename from docs/libraries/breaking-changes.md rename to docs/libraries/coding-guidelines/breaking-changes.md diff --git a/docs/libraries/coding-style.md b/docs/libraries/coding-guidelines/coding-style.md similarity index 100% rename from docs/libraries/coding-style.md rename to docs/libraries/coding-guidelines/coding-style.md diff --git a/docs/libraries/cross-platform-guidelines.md b/docs/libraries/coding-guidelines/cross-platform-guidelines.md similarity index 100% rename from docs/libraries/cross-platform-guidelines.md rename to docs/libraries/coding-guidelines/cross-platform-guidelines.md diff --git a/docs/libraries/framework-design-guidelines-digest.md b/docs/libraries/coding-guidelines/framework-design-guidelines-digest.md similarity index 100% rename from docs/libraries/framework-design-guidelines-digest.md rename to docs/libraries/coding-guidelines/framework-design-guidelines-digest.md diff --git a/docs/libraries/interop-guidelines.md b/docs/libraries/coding-guidelines/interop-guidelines.md similarity index 100% rename from docs/libraries/interop-guidelines.md rename to docs/libraries/coding-guidelines/interop-guidelines.md diff --git a/docs/libraries/performance-guidelines.md b/docs/libraries/coding-guidelines/performance-guidelines.md similarity index 94% rename from docs/libraries/performance-guidelines.md rename to docs/libraries/coding-guidelines/performance-guidelines.md index 477c8a9e6a0..a991a0ad301 100644 --- a/docs/libraries/performance-guidelines.md +++ b/docs/libraries/coding-guidelines/performance-guidelines.md @@ -5,7 +5,7 @@ Different applications have different needs when it comes to performance. For l Much has been written about writing high-performance code in C#. This page provides links to some of that material and will expand over time as additional resources are found and identified as being relevant and useful. -You can read [CoreCLR Performance Requirements](https://github.com/master/coreclr/blob/master/Documentation/performance-requirements.md) to learn more. +You can read [CoreCLR Performance Requirements](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/performance-guidelines.md) to learn more. # Memory Management diff --git a/docs/libraries/api-review-process.md b/docs/libraries/project-docs/api-review-process.md similarity index 99% rename from docs/libraries/api-review-process.md rename to docs/libraries/project-docs/api-review-process.md index 3bc69917715..0b6319092c5 100644 --- a/docs/libraries/api-review-process.md +++ b/docs/libraries/project-docs/api-review-process.md @@ -21,7 +21,7 @@ For trivial code changes, such as typo fixes, we want folks to directly submit a For work that involves adding new APIs we'd like the issue to contain what we call a *speclet*. The speclet should provide a rough sketch of how the APIs are intended to be used, with sample code that shows typical scenarios. The goal isn't to be complete but rather to illustrate the direction so that readers can judge whether the proposal is sound. Here is [a good example](https://github.com/dotnet/corefx/issues/271). -![API Review Process](images/api-review-process.png) +![API Review Process](../images/api-review-process.png) ## Steps diff --git a/docs/libraries/branching-guide.md b/docs/libraries/project-docs/branching-guide.md similarity index 100% rename from docs/libraries/branching-guide.md rename to docs/libraries/project-docs/branching-guide.md diff --git a/docs/libraries/contributing.md b/docs/libraries/project-docs/contributing.md similarity index 82% rename from docs/libraries/contributing.md rename to docs/libraries/project-docs/contributing.md index 25ded4a1a20..b9ebc674747 100644 --- a/docs/libraries/contributing.md +++ b/docs/libraries/project-docs/contributing.md @@ -1,14 +1,14 @@ Contributing to CoreFX ====================== -This document describes contribution guidelines that are specific to CoreFX. Please read [.NET Core Guidelines](https://github.com/dotnet/coreclr/blob/master/Documentation/contributing.md) for more general .NET Core contribution guidelines. +This document describes contribution guidelines that are specific to CoreFX. Please read [.NET Core Guidelines](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/contributing.md) for more general .NET Core contribution guidelines. Coding Style Changes -------------------- We intend to bring dotnet/corefx in to full conformance with the style guidelines described in [Coding Style](coding-style.md). We plan to do that with tooling, in a holistic way. In the meantime, please: -* **DO NOT** send PRs for style changes. +* **DO NOT** send PRs for style changes. * **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. API Changes diff --git a/docs/libraries/developer-guide.md b/docs/libraries/project-docs/developer-guide.md similarity index 100% rename from docs/libraries/developer-guide.md rename to docs/libraries/project-docs/developer-guide.md diff --git a/docs/libraries/issue-guide.md b/docs/libraries/project-docs/issue-guide.md similarity index 100% rename from docs/libraries/issue-guide.md rename to docs/libraries/project-docs/issue-guide.md diff --git a/docs/libraries/oss-signing.md b/docs/libraries/project-docs/oss-signing.md similarity index 100% rename from docs/libraries/oss-signing.md rename to docs/libraries/project-docs/oss-signing.md diff --git a/docs/libraries/repo-organization.md b/docs/libraries/project-docs/repo-organization.md similarity index 100% rename from docs/libraries/repo-organization.md rename to docs/libraries/project-docs/repo-organization.md diff --git a/docs/libraries/strong-name-signing.md b/docs/libraries/project-docs/strong-name-signing.md similarity index 100% rename from docs/libraries/strong-name-signing.md rename to docs/libraries/project-docs/strong-name-signing.md diff --git a/docs/libraries/support-dotnet-core-instructions.md b/docs/libraries/project-docs/support-dotnet-core-instructions.md similarity index 92% rename from docs/libraries/support-dotnet-core-instructions.md rename to docs/libraries/project-docs/support-dotnet-core-instructions.md index 494f9458e95..ea3b9485451 100644 --- a/docs/libraries/support-dotnet-core-instructions.md +++ b/docs/libraries/project-docs/support-dotnet-core-instructions.md @@ -12,21 +12,21 @@ Want to make your libraries multi-platform? Want to see how much work is require To begin using the .NET Portability Analyzer, download the extension from the Visual Studio Gallery. You can configure it in Visual Studio via *Tools* >> *Options* >> *.NET Portability Analyzer* and select your Target Platforms. For now, please use ASP.NET 5 as a proxy for all .NET Core 5-based platforms (e.g. [Windows 10 .NET UAP apps](http://blogs.windows.com/buildingapps/2015/03/02/a-first-look-at-the-windows-10-universal-app-platform/)). -![](images/portability_screenshot.png) +![](../images/portability_screenshot.png) To analyze your entire project, right-click on your project in the Solution Explorer and select *Analyze* >> *Analyze Assembly Portability*. Otherwise, go to the Analyze menu and select *Analyze Assembly Portability*. From there, select your project's executable or .dll. -![](images/portability_solution_explorer.png) +![](../images/portability_solution_explorer.png) After running the analysis, you will see your .NET Portability Report. Only types that are unsupported by a target platform will appear in the list and you can review recommendations in the **Messages** tab in the **Error List**. You can also jump to problem areas directly from the **Messages** tab. -![](images/portability_report.png) +![](../images/portability_report.png) Don't want to use Visual Studio? You can also use the Portability Analyzer from the Command Prompt. Download the command-line analyzer [here](http://www.microsoft.com/en-us/download/details.aspx?id=42678). - Type the following command to analyze the current directory: ```\...\ApiPort.exe . ``` -- To analyze a specific list of .dlls type the following command: ```\...\ApiPort.exe first.dll second.dll third.dll ``` +- To analyze a specific list of .dlls type the following command: ```\...\ApiPort.exe first.dll second.dll third.dll ``` Your .NET Portability Report will be saved as an Excel .xlsx file in your current directory. The **Details** tab in the Excel Workbook will contain more info. -For more info on the .NET Portability Analyzer, read [this article](http://blogs.msdn.com/b/dotnet/archive/2014/08/06/leveraging-existing-code-across-net-platforms.aspx). +For more info on the .NET Portability Analyzer, read [this article](http://blogs.msdn.com/b/dotnet/archive/2014/08/06/leveraging-existing-code-across-net-platforms.aspx).