From 496bfa99cba0649199decaf8da7c6bee00ac6029 Mon Sep 17 00:00:00 2001 From: Ankit Asthana Date: Tue, 8 May 2018 23:54:16 -0700 Subject: [PATCH 1/4] Changing name "Documentation" to "docs" for consistency in the repo. Fixing as a result all broken links for MDs in the following files: Readme.md: "The current release is 0.1. Check out the [release notes](docs/release-notes/0.1/ release-0.1.md)." "To build ML.NET from source please visit our [developers guide](docs/project-docs/developer-guide.md)." --- CONTRIBUTING.md | 4 ++-- Microsoft.ML.sln | 13 +++++++------ README.md | 4 ++-- {Documentation => docs}/README.md | 5 +++-- .../building/unix-instructions.md | 0 .../building/windows-instructions.md | 0 .../project-docs/contributing.md | 0 .../project-docs/developer-guide.md | 0 .../release-notes/0.1/release-0.1.md | 0 {Documentation => docs}/specs/mvp.md | 0 10 files changed, 14 insertions(+), 12 deletions(-) rename {Documentation => docs}/README.md (94%) rename {Documentation => docs}/building/unix-instructions.md (100%) rename {Documentation => docs}/building/windows-instructions.md (100%) rename {Documentation => docs}/project-docs/contributing.md (100%) rename {Documentation => docs}/project-docs/developer-guide.md (100%) rename {Documentation => docs}/release-notes/0.1/release-0.1.md (100%) rename {Documentation => docs}/specs/mvp.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6339bc8102..da15d0493f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,8 @@ All commits in a pull request will be squashed to a single commit with the origi # Contributing -See [Contributing](Documentation/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more. +See [Contributing](docs/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more. # Developers -See the [Developer Guide](Documentation/project-docs/developer-guide.md) for details about developing in this repo. +See the [Developer Guide](docs/project-docs/developer-guide.md) for details about developing in this repo. diff --git a/Microsoft.ML.sln b/Microsoft.ML.sln index 631f75088e..3606e012b8 100644 --- a/Microsoft.ML.sln +++ b/Microsoft.ML.sln @@ -58,13 +58,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.ML.Sweeper", "src EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E20AF96D-3F66-4065-8A89-BEE479D74536}" ProjectSection(SolutionItems) = preProject - Documentation\README.md = Documentation\README.md + docs\README.md = docs\README.md + docs\release-notes\0.1\release-0.1.md = docs\release-notes\0.1\release-0.1.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project-docs", "project-docs", "{52794B40-AB8A-41AF-9EF7-799C80D6E0BC}" ProjectSection(SolutionItems) = preProject - Documentation\project-docs\contributing.md = Documentation\project-docs\contributing.md - Documentation\project-docs\developer-guide.md = Documentation\project-docs\developer-guide.md + docs\project-docs\contributing.md = docs\project-docs\contributing.md + docs\project-docs\developer-guide.md = docs\project-docs\developer-guide.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{76F579E4-B9D2-4A0C-A511-EEFA4B2B829F}" @@ -76,13 +77,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "building", "building", "{DB751004-5D49-4B88-B78F-29CA9887087D}" ProjectSection(SolutionItems) = preProject - Documentation\building\unix-instructions.md = Documentation\building\unix-instructions.md - Documentation\building\windows-instructions.md = Documentation\building\windows-instructions.md + docs\building\unix-instructions.md = docs\building\unix-instructions.md + docs\building\windows-instructions.md = docs\building\windows-instructions.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "specs", "specs", "{2DEFC784-F2B5-44EA-ABBB-0DCF3E689DAC}" ProjectSection(SolutionItems) = preProject - Documentation\specs\mvp.md = Documentation\specs\mvp.md + docs\specs\mvp.md = docs\specs\mvp.md EndProjectSection EndProject Global diff --git a/README.md b/README.md index eb96b1488b..d631ed218c 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Along with these ML capabilities this first release of ML.NET also brings the fi ML.NET runs on Windows, Linux, and macOS - any platform where 64 bit [.NET Core](https://github.com/dotnet/core) or later is available. -The current release is 0.1. Check out the [release notes](Documentation/release-notes/0.1/release-0.1.md). +The current release is 0.1. Check out the [release notes](docs/release-notes/0.1/release-0.1.md). First ensure you have installed [.NET Core 2.0](https://www.microsoft.com/net/learn/get-started) or later. ML.NET also works on the .NET Framework. Note that ML.NET currently must run in a 64 bit process. @@ -34,7 +34,7 @@ Or alternatively you can add the Microsoft.ML package from within Visual Studio' ## Building -To build ML.NET from source please visit our [developers guide](Documentation/project-docs/developer-guide.md). +To build ML.NET from source please visit our [developers guide](docs/project-docs/developer-guide.md). | | x64 Debug | x64 Release | |:---|----------------:|------------------:| diff --git a/Documentation/README.md b/docs/README.md similarity index 94% rename from Documentation/README.md rename to docs/README.md index 79b97b9ec9..c5d73f773c 100644 --- a/Documentation/README.md +++ b/docs/README.md @@ -11,10 +11,11 @@ Project Docs - [Developer Guide](project-docs/developer-guide.md) - [Contributing to ML.NET](project-docs/contributing.md) -- [Strong Name Signing](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/strong-name-signing.md) +- [Strong Name Signing](https://github.com/dotnet/corefx/blob/master/ +/project-docs/strong-name-signing.md) - [Public Signing](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/public-signing.md) - [Project NuGet Dependencies](https://github.com/dotnet/buildtools/blob/master/Documentation/project-nuget-dependencies.md) - += Building from Source ==================== diff --git a/Documentation/building/unix-instructions.md b/docs/building/unix-instructions.md similarity index 100% rename from Documentation/building/unix-instructions.md rename to docs/building/unix-instructions.md diff --git a/Documentation/building/windows-instructions.md b/docs/building/windows-instructions.md similarity index 100% rename from Documentation/building/windows-instructions.md rename to docs/building/windows-instructions.md diff --git a/Documentation/project-docs/contributing.md b/docs/project-docs/contributing.md similarity index 100% rename from Documentation/project-docs/contributing.md rename to docs/project-docs/contributing.md diff --git a/Documentation/project-docs/developer-guide.md b/docs/project-docs/developer-guide.md similarity index 100% rename from Documentation/project-docs/developer-guide.md rename to docs/project-docs/developer-guide.md diff --git a/Documentation/release-notes/0.1/release-0.1.md b/docs/release-notes/0.1/release-0.1.md similarity index 100% rename from Documentation/release-notes/0.1/release-0.1.md rename to docs/release-notes/0.1/release-0.1.md diff --git a/Documentation/specs/mvp.md b/docs/specs/mvp.md similarity index 100% rename from Documentation/specs/mvp.md rename to docs/specs/mvp.md From f1d93dcc613d6bd0a6323980ff970f28139ce3c9 Mon Sep 17 00:00:00 2001 From: Ankit Asthana Date: Wed, 9 May 2018 00:01:34 -0700 Subject: [PATCH 2/4] Revert "Changing name "Documentation" to "docs" for consistency in the repo." This reverts commit 496bfa99cba0649199decaf8da7c6bee00ac6029. --- CONTRIBUTING.md | 4 ++-- {docs => Documentation}/README.md | 5 ++--- .../building/unix-instructions.md | 0 .../building/windows-instructions.md | 0 .../project-docs/contributing.md | 0 .../project-docs/developer-guide.md | 0 .../release-notes/0.1/release-0.1.md | 0 {docs => Documentation}/specs/mvp.md | 0 Microsoft.ML.sln | 13 ++++++------- README.md | 4 ++-- 10 files changed, 12 insertions(+), 14 deletions(-) rename {docs => Documentation}/README.md (94%) rename {docs => Documentation}/building/unix-instructions.md (100%) rename {docs => Documentation}/building/windows-instructions.md (100%) rename {docs => Documentation}/project-docs/contributing.md (100%) rename {docs => Documentation}/project-docs/developer-guide.md (100%) rename {docs => Documentation}/release-notes/0.1/release-0.1.md (100%) rename {docs => Documentation}/specs/mvp.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da15d0493f..6339bc8102 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,8 @@ All commits in a pull request will be squashed to a single commit with the origi # Contributing -See [Contributing](docs/project-docs/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](docs/project-docs/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/docs/README.md b/Documentation/README.md similarity index 94% rename from docs/README.md rename to Documentation/README.md index c5d73f773c..79b97b9ec9 100644 --- a/docs/README.md +++ b/Documentation/README.md @@ -11,11 +11,10 @@ Project Docs - [Developer Guide](project-docs/developer-guide.md) - [Contributing to ML.NET](project-docs/contributing.md) -- [Strong Name Signing](https://github.com/dotnet/corefx/blob/master/ -/project-docs/strong-name-signing.md) +- [Strong Name Signing](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/strong-name-signing.md) - [Public Signing](https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/public-signing.md) - [Project NuGet Dependencies](https://github.com/dotnet/buildtools/blob/master/Documentation/project-nuget-dependencies.md) -= + Building from Source ==================== diff --git a/docs/building/unix-instructions.md b/Documentation/building/unix-instructions.md similarity index 100% rename from docs/building/unix-instructions.md rename to Documentation/building/unix-instructions.md diff --git a/docs/building/windows-instructions.md b/Documentation/building/windows-instructions.md similarity index 100% rename from docs/building/windows-instructions.md rename to Documentation/building/windows-instructions.md diff --git a/docs/project-docs/contributing.md b/Documentation/project-docs/contributing.md similarity index 100% rename from docs/project-docs/contributing.md rename to Documentation/project-docs/contributing.md diff --git a/docs/project-docs/developer-guide.md b/Documentation/project-docs/developer-guide.md similarity index 100% rename from docs/project-docs/developer-guide.md rename to Documentation/project-docs/developer-guide.md diff --git a/docs/release-notes/0.1/release-0.1.md b/Documentation/release-notes/0.1/release-0.1.md similarity index 100% rename from docs/release-notes/0.1/release-0.1.md rename to Documentation/release-notes/0.1/release-0.1.md diff --git a/docs/specs/mvp.md b/Documentation/specs/mvp.md similarity index 100% rename from docs/specs/mvp.md rename to Documentation/specs/mvp.md diff --git a/Microsoft.ML.sln b/Microsoft.ML.sln index 3606e012b8..631f75088e 100644 --- a/Microsoft.ML.sln +++ b/Microsoft.ML.sln @@ -58,14 +58,13 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.ML.Sweeper", "src EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E20AF96D-3F66-4065-8A89-BEE479D74536}" ProjectSection(SolutionItems) = preProject - docs\README.md = docs\README.md - docs\release-notes\0.1\release-0.1.md = docs\release-notes\0.1\release-0.1.md + Documentation\README.md = Documentation\README.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project-docs", "project-docs", "{52794B40-AB8A-41AF-9EF7-799C80D6E0BC}" ProjectSection(SolutionItems) = preProject - docs\project-docs\contributing.md = docs\project-docs\contributing.md - docs\project-docs\developer-guide.md = docs\project-docs\developer-guide.md + Documentation\project-docs\contributing.md = Documentation\project-docs\contributing.md + Documentation\project-docs\developer-guide.md = Documentation\project-docs\developer-guide.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{76F579E4-B9D2-4A0C-A511-EEFA4B2B829F}" @@ -77,13 +76,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "building", "building", "{DB751004-5D49-4B88-B78F-29CA9887087D}" ProjectSection(SolutionItems) = preProject - docs\building\unix-instructions.md = docs\building\unix-instructions.md - docs\building\windows-instructions.md = docs\building\windows-instructions.md + Documentation\building\unix-instructions.md = Documentation\building\unix-instructions.md + Documentation\building\windows-instructions.md = Documentation\building\windows-instructions.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "specs", "specs", "{2DEFC784-F2B5-44EA-ABBB-0DCF3E689DAC}" ProjectSection(SolutionItems) = preProject - docs\specs\mvp.md = docs\specs\mvp.md + Documentation\specs\mvp.md = Documentation\specs\mvp.md EndProjectSection EndProject Global diff --git a/README.md b/README.md index d631ed218c..eb96b1488b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Along with these ML capabilities this first release of ML.NET also brings the fi ML.NET runs on Windows, Linux, and macOS - any platform where 64 bit [.NET Core](https://github.com/dotnet/core) or later is available. -The current release is 0.1. Check out the [release notes](docs/release-notes/0.1/release-0.1.md). +The current release is 0.1. Check out the [release notes](Documentation/release-notes/0.1/release-0.1.md). First ensure you have installed [.NET Core 2.0](https://www.microsoft.com/net/learn/get-started) or later. ML.NET also works on the .NET Framework. Note that ML.NET currently must run in a 64 bit process. @@ -34,7 +34,7 @@ Or alternatively you can add the Microsoft.ML package from within Visual Studio' ## Building -To build ML.NET from source please visit our [developers guide](docs/project-docs/developer-guide.md). +To build ML.NET from source please visit our [developers guide](Documentation/project-docs/developer-guide.md). | | x64 Debug | x64 Release | |:---|----------------:|------------------:| From 71bab414d326e5ce872885035365ab8206e612b5 Mon Sep 17 00:00:00 2001 From: Ankit Asthana Date: Wed, 9 May 2018 00:10:22 -0700 Subject: [PATCH 3/4] Changing name "Documentation" to "docs" for consistency in the repo. Fixing as a result all broken links for MDs in the following files: Readme.md: "The current release is 0.1. Check out the [release notes](docs/release-notes/0.1/ release-0.1.md)." "To build ML.NET from source please visit our [developers guide](docs/project-docs/developer-guide.md)." --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6339bc8102..da15d0493f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,8 @@ All commits in a pull request will be squashed to a single commit with the origi # Contributing -See [Contributing](Documentation/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more. +See [Contributing](docs/project-docs/contributing.md) for information about coding styles, source structure, making pull requests, and more. # Developers -See the [Developer Guide](Documentation/project-docs/developer-guide.md) for details about developing in this repo. +See the [Developer Guide](docs/project-docs/developer-guide.md) for details about developing in this repo. diff --git a/README.md b/README.md index eb96b1488b..d631ed218c 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Along with these ML capabilities this first release of ML.NET also brings the fi ML.NET runs on Windows, Linux, and macOS - any platform where 64 bit [.NET Core](https://github.com/dotnet/core) or later is available. -The current release is 0.1. Check out the [release notes](Documentation/release-notes/0.1/release-0.1.md). +The current release is 0.1. Check out the [release notes](docs/release-notes/0.1/release-0.1.md). First ensure you have installed [.NET Core 2.0](https://www.microsoft.com/net/learn/get-started) or later. ML.NET also works on the .NET Framework. Note that ML.NET currently must run in a 64 bit process. @@ -34,7 +34,7 @@ Or alternatively you can add the Microsoft.ML package from within Visual Studio' ## Building -To build ML.NET from source please visit our [developers guide](Documentation/project-docs/developer-guide.md). +To build ML.NET from source please visit our [developers guide](docs/project-docs/developer-guide.md). | | x64 Debug | x64 Release | |:---|----------------:|------------------:| From 263569bbbfadea4b2d63e999a8d97ee6de15fc9d Mon Sep 17 00:00:00 2001 From: Ankit Asthana Date: Sun, 13 May 2018 07:35:40 -0700 Subject: [PATCH 4/4] rename folder from 'documentation' to 'docs' --- Microsoft.ML.sln | 11 ++++++----- {Documentation => docs}/README.md | 0 {Documentation => docs}/building/unix-instructions.md | 0 .../building/windows-instructions.md | 0 {Documentation => docs}/project-docs/contributing.md | 0 .../project-docs/developer-guide.md | 0 .../release-notes/0.1/release-0.1.md | 2 +- {Documentation => docs}/specs/mvp.md | 0 8 files changed, 7 insertions(+), 6 deletions(-) rename {Documentation => docs}/README.md (100%) rename {Documentation => docs}/building/unix-instructions.md (100%) rename {Documentation => docs}/building/windows-instructions.md (100%) rename {Documentation => docs}/project-docs/contributing.md (100%) rename {Documentation => docs}/project-docs/developer-guide.md (100%) rename {Documentation => docs}/release-notes/0.1/release-0.1.md (98%) rename {Documentation => docs}/specs/mvp.md (100%) diff --git a/Microsoft.ML.sln b/Microsoft.ML.sln index 631f75088e..7d94c3b40c 100644 --- a/Microsoft.ML.sln +++ b/Microsoft.ML.sln @@ -58,13 +58,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.ML.Sweeper", "src EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E20AF96D-3F66-4065-8A89-BEE479D74536}" ProjectSection(SolutionItems) = preProject - Documentation\README.md = Documentation\README.md + docs\README.md = docs\README.md + docs\release-notes\0.1\release-0.1.md = docs\release-notes\0.1\release-0.1.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project-docs", "project-docs", "{52794B40-AB8A-41AF-9EF7-799C80D6E0BC}" ProjectSection(SolutionItems) = preProject - Documentation\project-docs\contributing.md = Documentation\project-docs\contributing.md - Documentation\project-docs\developer-guide.md = Documentation\project-docs\developer-guide.md + docs\project-docs\contributing.md = docs\project-docs\contributing.md + docs\project-docs\developer-guide.md = docs\project-docs\developer-guide.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{76F579E4-B9D2-4A0C-A511-EEFA4B2B829F}" @@ -76,8 +77,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "building", "building", "{DB751004-5D49-4B88-B78F-29CA9887087D}" ProjectSection(SolutionItems) = preProject - Documentation\building\unix-instructions.md = Documentation\building\unix-instructions.md - Documentation\building\windows-instructions.md = Documentation\building\windows-instructions.md + docs\building\unix-instructions.md = docs\building\unix-instructions.md + docs\building\windows-instructions.md = docs\building\windows-instructions.md EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "specs", "specs", "{2DEFC784-F2B5-44EA-ABBB-0DCF3E689DAC}" diff --git a/Documentation/README.md b/docs/README.md similarity index 100% rename from Documentation/README.md rename to docs/README.md diff --git a/Documentation/building/unix-instructions.md b/docs/building/unix-instructions.md similarity index 100% rename from Documentation/building/unix-instructions.md rename to docs/building/unix-instructions.md diff --git a/Documentation/building/windows-instructions.md b/docs/building/windows-instructions.md similarity index 100% rename from Documentation/building/windows-instructions.md rename to docs/building/windows-instructions.md diff --git a/Documentation/project-docs/contributing.md b/docs/project-docs/contributing.md similarity index 100% rename from Documentation/project-docs/contributing.md rename to docs/project-docs/contributing.md diff --git a/Documentation/project-docs/developer-guide.md b/docs/project-docs/developer-guide.md similarity index 100% rename from Documentation/project-docs/developer-guide.md rename to docs/project-docs/developer-guide.md diff --git a/Documentation/release-notes/0.1/release-0.1.md b/docs/release-notes/0.1/release-0.1.md similarity index 98% rename from Documentation/release-notes/0.1/release-0.1.md rename to docs/release-notes/0.1/release-0.1.md index a36055527a..def4723a31 100644 --- a/Documentation/release-notes/0.1/release-0.1.md +++ b/docs/release-notes/0.1/release-0.1.md @@ -13,7 +13,7 @@ dotnet add package Microsoft.ML From package manager: ``` -Install-Package Microsoft.ML +Install-Package Microsoft.ML ``` Or from within Visual Studio's NuGet package manager. diff --git a/Documentation/specs/mvp.md b/docs/specs/mvp.md similarity index 100% rename from Documentation/specs/mvp.md rename to docs/specs/mvp.md