From 35dbea3b64235d8510a167a4fc84fb9a33caca66 Mon Sep 17 00:00:00 2001 From: Drew Brasher Date: Tue, 1 Mar 2022 06:39:33 -0600 Subject: [PATCH 1/4] Added documentation for using Orchard Core from a local NuGet package feed. --- mkdocs.yml | 1 + .../getting-started/local-package-source.md | 34 +++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 src/docs/getting-started/local-package-source.md diff --git a/mkdocs.yml b/mkdocs.yml index 9b169116c48..a0037e35342 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,6 +83,7 @@ nav: - Getting started: - Create a CMS Web application: docs/getting-started/README.md - Configure Preview package source: docs/getting-started/preview-package-source.md + - Using local package source: docs/getting-started/local-package-source.md - Recipes and Starter Themes: docs/getting-started/starter-recipes.md - Code Generation Templates: docs/getting-started/templates/README.md - Create a Theme: docs/getting-started/theme.md diff --git a/src/docs/getting-started/local-package-source.md b/src/docs/getting-started/local-package-source.md new file mode 100644 index 00000000000..e2140cfa2b0 --- /dev/null +++ b/src/docs/getting-started/local-package-source.md @@ -0,0 +1,34 @@ +# Using a local copy of Orchard Core source code as nuget packages + +In this article, we are going to create our own local nuget feed from our copy of the Orchard Core source code and add a new package source pointing to the local packages. + +## Create NuGet packages from your local source code. + +For more information on dotnet pack see: +* From the command line, go to the root folder of your fork/branch of the Orchard Core source code. +* Pack all of the NuGet packages to one output folder of your choice. +Example: `dotnet pack -c Release -o c:\OrchardCoreNuget` + +## Publish to your NuGet feed +For this example, we are going to use the Local Feed method. For more information on this see: +* Create a folder for your NuGet Feed. For this example we are using `\\{YourServer}\NuGetServer` +* Add the NuGet packages to your local feed. +Example: `nuget init c:\OrchardCoreNuget \\{YourServer}\NuGetServer` + + +## Update your project to use your NuGet feed + +* Update your nuget.config file so it points to your local feed. +https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#packagesources +```xml + + + + + + + + + +``` +* Make sure all of your projects are referencing the OrchardCore version in your local feed. \ No newline at end of file From 34d5ddff1e4b2d1939442ef4f1d67e56f499f54d Mon Sep 17 00:00:00 2001 From: Drew Brasher Date: Tue, 1 Mar 2022 15:04:38 -0600 Subject: [PATCH 2/4] Put the local feed first in the nuget.config example --- src/docs/getting-started/local-package-source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/getting-started/local-package-source.md b/src/docs/getting-started/local-package-source.md index e2140cfa2b0..acd641b7520 100644 --- a/src/docs/getting-started/local-package-source.md +++ b/src/docs/getting-started/local-package-source.md @@ -25,8 +25,8 @@ https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#packagesource - + From ca8ec0684634cac9bb1f11eb902a2298e3790e28 Mon Sep 17 00:00:00 2001 From: Drew Brasher Date: Wed, 2 Mar 2022 13:28:40 -0600 Subject: [PATCH 3/4] Moved the Using Local NuGet Packages doc to the Key Topics section --- mkdocs.yml | 2 +- .../local-nuget-packages/README.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename src/docs/{getting-started/local-package-source.md => topics/local-nuget-packages/README.md} (100%) diff --git a/mkdocs.yml b/mkdocs.yml index a0037e35342..88bfac0dc00 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,7 +83,6 @@ nav: - Getting started: - Create a CMS Web application: docs/getting-started/README.md - Configure Preview package source: docs/getting-started/preview-package-source.md - - Using local package source: docs/getting-started/local-package-source.md - Recipes and Starter Themes: docs/getting-started/starter-recipes.md - Code Generation Templates: docs/getting-started/templates/README.md - Create a Theme: docs/getting-started/theme.md @@ -121,6 +120,7 @@ nav: - Contributing to the docs: docs/topics/docs-contributions/README.md - Publishing a new release: docs/topics/publishing-releases/README.md - Using Docker: docs/topics/docker/README.md + - Using local NuGet packages: docs/topics/local-nuget-packages/README.md - Reference: - docs/reference/README.md - CMS Modules: diff --git a/src/docs/getting-started/local-package-source.md b/src/docs/topics/local-nuget-packages/README.md similarity index 100% rename from src/docs/getting-started/local-package-source.md rename to src/docs/topics/local-nuget-packages/README.md From 412effc66d3f1a79873905b72a147a49eca08d55 Mon Sep 17 00:00:00 2001 From: Drew Brasher Date: Wed, 2 Mar 2022 14:47:57 -0600 Subject: [PATCH 4/4] Changed markdown list indicator to match other documentation --- src/docs/topics/local-nuget-packages/README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/docs/topics/local-nuget-packages/README.md b/src/docs/topics/local-nuget-packages/README.md index acd641b7520..41918e9c86d 100644 --- a/src/docs/topics/local-nuget-packages/README.md +++ b/src/docs/topics/local-nuget-packages/README.md @@ -5,20 +5,22 @@ In this article, we are going to create our own local nuget feed from our copy o ## Create NuGet packages from your local source code. For more information on dotnet pack see: -* From the command line, go to the root folder of your fork/branch of the Orchard Core source code. -* Pack all of the NuGet packages to one output folder of your choice. + +- From the command line, go to the root folder of your fork/branch of the Orchard Core source code. +- Pack all of the NuGet packages to one output folder of your choice. Example: `dotnet pack -c Release -o c:\OrchardCoreNuget` ## Publish to your NuGet feed For this example, we are going to use the Local Feed method. For more information on this see: -* Create a folder for your NuGet Feed. For this example we are using `\\{YourServer}\NuGetServer` -* Add the NuGet packages to your local feed. -Example: `nuget init c:\OrchardCoreNuget \\{YourServer}\NuGetServer` +- Create a folder for your NuGet Feed. +For this example we are using `\\{YourServer}\NuGetServer` +- Add the NuGet packages to your local feed. +Example: `nuget init c:\OrchardCoreNuget \\{YourServer}\NuGetServer` ## Update your project to use your NuGet feed -* Update your nuget.config file so it points to your local feed. +- Update your nuget.config file so it points to your local feed. https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#packagesources ```xml @@ -31,4 +33,4 @@ https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#packagesource ``` -* Make sure all of your projects are referencing the OrchardCore version in your local feed. \ No newline at end of file +- Make sure all of your projects are referencing the OrchardCore version in your local feed. \ No newline at end of file