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.
almaleksia · Jun 23, 2015 · 06a5ba7 · 06a5ba7
1 parent 61c837a
commit 06a5ba7
Show file tree

Hide file tree

Showing 23 changed files with 51 additions and 45 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
 # Contributing
 
-See [Contributing](Documentation/contributing.md) for information about coding styles, source structure, making pull requests, and more.
+See [Contributing](Documentation/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more.
 
 # Developers
 
-See the [Developer Guide](Documentation/developer-guide.md) for details about developing in this repo.
+See the [Developer Guide](Documentation/project-docs/developer-guide.md) for details about developing in this repo.
diff --git a/Documentation/README.md b/Documentation/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/Documentation/code-coverage.md → Documentation/building/code-coverage.md b/Documentation/code-coverage.md → Documentation/building/code-coverage.md
diff --git a/Documentation/unix-instructions.md → Documentation/building/unix-instructions.md b/Documentation/unix-instructions.md → Documentation/building/unix-instructions.md
diff --git a/Documentation/windows-instructions.md → ...entation/building/windows-instructions.md b/Documentation/windows-instructions.md → ...entation/building/windows-instructions.md
diff --git a/Documentation/breaking-change-definitions.md → ...guidelines/breaking-change-definitions.md b/Documentation/breaking-change-definitions.md → ...guidelines/breaking-change-definitions.md
diff --git a/Documentation/breaking-change-rules.md → ...oding-guidelines/breaking-change-rules.md b/Documentation/breaking-change-rules.md → ...oding-guidelines/breaking-change-rules.md
diff --git a/Documentation/breaking-changes.md → ...ion/coding-guidelines/breaking-changes.md b/Documentation/breaking-changes.md → ...ion/coding-guidelines/breaking-changes.md
diff --git a/Documentation/coding-style.md → ...ntation/coding-guidelines/coding-style.md b/Documentation/coding-style.md → ...ntation/coding-guidelines/coding-style.md
diff --git a/Documentation/cross-platform-guidelines.md → ...g-guidelines/cross-platform-guidelines.md b/Documentation/cross-platform-guidelines.md → ...g-guidelines/cross-platform-guidelines.md
diff --git a/...ion/framework-design-guidelines-digest.md → ...nes/framework-design-guidelines-digest.md b/...ion/framework-design-guidelines-digest.md → ...nes/framework-design-guidelines-digest.md
diff --git a/Documentation/interop-guidelines.md → ...n/coding-guidelines/interop-guidelines.md b/Documentation/interop-guidelines.md → ...n/coding-guidelines/interop-guidelines.md
diff --git a/Documentation/performance-guidelines.md → ...ding-guidelines/performance-guidelines.md b/Documentation/performance-guidelines.md → ...ding-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/Documentation/api-review-process.md → ...tation/project-docs/api-review-process.md b/Documentation/api-review-process.md → ...tation/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/Documentation/branching-guide.md → ...mentation/project-docs/branching-guide.md b/Documentation/branching-guide.md → ...mentation/project-docs/branching-guide.md
diff --git a/Documentation/contributing.md → Documentation/project-docs/contributing.md b/Documentation/contributing.md → Documentation/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/Documentation/developer-guide.md → ...mentation/project-docs/developer-guide.md b/Documentation/developer-guide.md → ...mentation/project-docs/developer-guide.md
diff --git a/Documentation/issue-guide.md → Documentation/project-docs/issue-guide.md b/Documentation/issue-guide.md → Documentation/project-docs/issue-guide.md
diff --git a/Documentation/oss-signing.md → Documentation/project-docs/oss-signing.md b/Documentation/oss-signing.md → Documentation/project-docs/oss-signing.md
diff --git a/Documentation/repo-organization.md → ...ntation/project-docs/repo-organization.md b/Documentation/repo-organization.md → ...ntation/project-docs/repo-organization.md
diff --git a/Documentation/strong-name-signing.md → ...ation/project-docs/strong-name-signing.md b/Documentation/strong-name-signing.md → ...ation/project-docs/strong-name-signing.md
diff --git a/...ation/support-dotnet-core-instructions.md → ...-docs/support-dotnet-core-instructions.md b/...ation/support-dotnet-core-instructions.md → ...-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).
diff --git a/README.md b/README.md
@@ -8,9 +8,11 @@
 
 The corefx repo contains the library implementation (called "CoreFX") for [.NET Core](http://github.com/dotnet/core). It includes System.Collections, System.IO, System.Xml and many other components. It builds and runs on Windows. You can ['watch'](https://github.com/dotnet/corefx/subscription) the repo to see Linux and Mac support being added over the next few months.
 
-.NET Core is a modular implementation of .NET that can be used as the base stack for a wide variety of scenarios, today scaling from console utilities to web apps in the cloud.  You can learn more about .NET Core and how and where you can use it in the [.NET Core is open source][.NET Core oss] and [Introducing .NET Core][Introducing .NET Core] blog posts. 
+You can also see more information in the [Documentation README](Documentation/README.md). 
 
-The [.NET Core Runtime repo](https://github.com/dotnet/coreclr) contains the  runtime implementation (called "CoreCLR") for .NET Core. It includes RyuJIT, the .NET GC, native interop and many other components. 
+.NET Core is a modular implementation of .NET that can be used as the base stack for a wide variety of scenarios, today scaling from console utilities to web apps in the cloud.  You can learn more about .NET Core and how and where you can use it in the [.NET Core is open source][.NET Core oss] and [Introducing .NET Core][Introducing .NET Core] blog posts.
+
+The [.NET Core Runtime repo](https://github.com/dotnet/coreclr) contains the  runtime implementation (called "CoreCLR") for .NET Core. It includes RyuJIT, the .NET GC, native interop and many other components.
 
 Runtime-specific library code - namely [mscorlib][mscorlib] - lives in the CoreCLR repo. It needs to be built and versioned in tandem with the runtime. The rest of CoreFX is agnostic of runtime-implementation and can be run on any compatible .NET runtime. These characteristics were the primary motivation for the 2-repo structure.
 
@@ -20,17 +22,17 @@ Runtime-specific library code - namely [mscorlib][mscorlib] - lives in the CoreC
 
 ## How to Engage, Contribute and Provide Feedback
 
-Some of the best ways to contribute are to try things out, file bugs, and join in design conversations. 
+Some of the best ways to contribute are to try things out, file bugs, and join in design conversations.
 
 Want to get more familiar with what's going on in the code?
 * [Pull requests](https://github.com/dotnet/corefx/pulls): [Open](https://github.com/dotnet/corefx/pulls?q=is%3Aopen+is%3Apr)/[Closed](https://github.com/dotnet/corefx/pulls?q=is%3Apr+is%3Aclosed)
 * [![Backlog](https://cloud.githubusercontent.com/assets/1302850/6260412/38987b1e-b793-11e4-9ade-d3fef4c6bf48.png)](https://github.com/dotnet/corefx/issues?q=is%3Aopen+is%3Aissue+label%3A%220+-+Backlog%22), [![Up Next](https://cloud.githubusercontent.com/assets/1302850/6260418/4c2c7a54-b793-11e4-8ce1-a27ff5378d08.png)](https://github.com/dotnet/corefx/issues?q=is%3Aopen+is%3Aissue+label%3A%221+-+Up+Next%22) and [![In Progress](https://cloud.githubusercontent.com/assets/1302850/6260414/41b0fc30-b793-11e4-9d50-d09563cd138a.png)](https://github.com/dotnet/corefx/issues?q=is%3Aopen+is%3Aissue+label%3A%222+-+In+Progress%22) changes
 
 Looking for something to work on? The list of [up-for-grabs issues](https://github.com/dotnet/corefx/labels/up%20for%20grabs) is a great place to start or for larger items see the list of [feature approved](https://github.com/dotnet/corefx/labels/feature%20approved). See some of our guides for more details:
 
-* [Contributing Guide](Documentation/contributing.md)
-* [Developer Guide](Documentation/developer-guide.md)
-* [Issue Guide](Documentation/issue-guide.md)
+* [Contributing Guide](Documentation/project-docs/contributing.md)
+* [Developer Guide](Documentation/project-docs/developer-guide.md)
+* [Issue Guide](Documentation/project-docs/issue-guide.md)
 
 You are also encouraged to start a discussion by filing an issue or creating a
 gist.