Update docs in preparation for repo rename (#130)

baronfel · rainersigwald · web-flow · commit d5faafc7f85d · 2022-08-23T17:03:02.000-05:00
* update urls for in-repo stuff

* Documentation cleanup

* finish CHECKLIST.md

* Update DEVGUIDE.md

Co-authored-by: Rainer Sigwald &lt;raines@microsoft.com&gt;

* Update README.md

Co-authored-by: Rainer Sigwald &lt;raines@microsoft.com&gt;

Co-authored-by: Rainer Sigwald &lt;raines@microsoft.com&gt;
diff --git a/.github/workflows/publish-package.yml b/.github/workflows/publish-package.yml
@@ -24,4 +24,4 @@ jobs:
     - name: Release
       run: dotnet build --configuration release
     - name: Publish
-      run: dotnet nuget push "Microsoft.NET.Build.Containers/bin/Release/Microsoft.NET.Build.Containers.*.nupkg" --api-key ${{ secrets.FEED_UPLOAD_TOKEN }} --source "https://nuget.pkg.github.com/rainersigwald/index.json"
+      run: dotnet nuget push "Microsoft.NET.Build.Containers/bin/Release/Microsoft.NET.Build.Containers.*.nupkg" --api-key ${{ secrets.FEED_UPLOAD_TOKEN }} --source "https://nuget.pkg.github.com/dotnet/index.json"
diff --git a/CHECKLIST.md b/CHECKLIST.md
diff --git a/DEVGUIDE.md b/DEVGUIDE.md
@@ -0,0 +1,22 @@
+# Developer Guide
+
+This document contains getting-started resources for those that want to develop this tool.
+
+## Using the prerelease package from this repository
+
+The easiest way to use the prerelease package is to follow [these GitHub docs](https://docs.github.com/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry).
+
+You'll want to use a nuget.config file to
+
+* define a source for this repository
+* define credentials (username and Personal Access Token) to use when accessing this source
+
+Then, you can use `dotnet add package Microsoft.NET.Build.Containers -prerelease` to get the latest version.
+
+You can also always clone this repository, run `dotnet build`, and use the newly-generated nupkg.
+
+## References
+
+* [OCI Image Format spec](https://github.com/opencontainers/image-spec/blob/main/spec.md)
+* [Docker Registry API docs](https://docs.docker.com/registry/spec/api/)
+* [Setting up a local Docker registry](https://docs.docker.com/registry/)
diff --git a/Microsoft.NET.Build.Containers/Layer.cs b/Microsoft.NET.Build.Containers/Layer.cs
@@ -30,7 +30,7 @@ public static Layer FromFiles(IEnumerable<(string path, string containerPath)> f
         string tempTarballPath = ContentStore.GetTempFile();
         using (FileStream fs = File.Create(tempTarballPath))
         {
-            // using (GZipStream gz = new(fs, CompressionMode.Compress)) // TODO: https://github.com/rainersigwald/containers/issues/29
+            // using (GZipStream gz = new(fs, CompressionMode.Compress)) // TODO: https://github.com/dotnet/sdk-container-builds/issues/29
             using (TarWriter writer = new(fs, TarEntryFormat.Gnu, leaveOpen: true))
             {
                 foreach (var item in fileList)
diff --git a/Microsoft.NET.Build.Containers/Microsoft.NET.Build.Containers.csproj b/Microsoft.NET.Build.Containers/Microsoft.NET.Build.Containers.csproj
@@ -24,8 +24,8 @@
     <Description>Tasks and targets to natively publish .NET applications as containers.</Description>
     <Copyright></Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <PackageProjectUrl>https://github.com/rainersigwald/containers</PackageProjectUrl>
-    <RepositoryUrl>https://github.com/rainersigwald/containers</RepositoryUrl>
+    <PackageProjectUrl>https://github.com/dotnet/sdk-container-builds</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/dotnet/sdk-container-builds</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>containers;docker;Microsoft.NET.Build.Containers</PackageTags>
     <PackageReadmeFile>README.md</PackageReadmeFile>
diff --git a/README.md b/README.md
@@ -1,26 +1,29 @@
-# OCI Containers for .NET
+# .NET SDK Container Building Tools
 
-An API for creating and manipulating OCI containers, and build tasks for creating them at build time.
+This repo contains APIs and MSBuild Tasks for generating an OCI Container from a .NET project, as well as tests for the same.
 
-You can learn more about the project from the project [Documentation](docs).
+Getting started with the library in an existing project is as easy as
 
-[![.NET](https://github.com/rainersigwald/containers/actions/workflows/dotnet.yml/badge.svg)](https://github.com/rainersigwald/containers/actions/workflows/dotnet.yml)
+```shell
+dotnet add package Microsoft.NET.Build.Containers
+dotnet publish --os linux --arch x64 -c Release -p:PublishProfile=DefaultContainer
+```
 
-## Using New Repo
+You can learn more about the project from the project [Documentation](./docs).
 
-You can simply `git clone` this project to get started. It is recommended that you don't preserve history of the project (it isn't generally meaningful) for your repo, but make a copy and `git init` your project from source.
+[![.NET](https://github.com/dotnet/sdk-container-builds/actions/workflows/dotnet.yml/badge.svg)](https://github.com/dotnet/sdk-container-builds/actions/workflows/dotnet.yml)
 
-Consult [CHECKLIST.md] for helpful suggestions on preparing your repo to go public.
+## Prerequisites
 
-## Building
+In order to build the project you will need [.NET SDK 7.0.100, preview 7](https://dotnet.microsoft.com/download/dotnet/7.0) or greater installed.
+From there, you can simply `dotnet build` the repository and be good to go!
 
-You don't "build" New Repo, however, this will be meaningful for many other projects.
 
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing to this project.
 
-This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) 
+This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/)
 to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
 
 ## License
@@ -29,12 +32,12 @@ This project is licensed with the [MIT license](LICENSE).
 
 ## .NET Foundation
 
-New Repo is a [.NET Foundation project](https://dotnetfoundation.org/projects).
+sdk-container-builds is a [.NET Foundation project](https://dotnetfoundation.org/projects).
 
 ## Related Projects
 
 You should take a look at these related projects:
 
-- [.NET Core](https://github.com/dotnet/core)
-- [ASP.NET](https://github.com/aspnet)
-- [Mono](https://github.com/mono)
+- [Konet](https://github.com/lippertmarkus/konet)
+- [`dotnet build-image`](https://github.com/tmds/build-image)
+- [.NET SDK](https://github.com/dotnet/sdk)
diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES
diff --git a/docs/ContainerCustomization.md b/docs/ContainerCustomization.md
@@ -35,7 +35,7 @@ Be default, we push to the local Docker daemon (annotated by `docker://`), but f
 ```
 
 > **Note**
-> There is no authentication currently supported - that [will come in a future release](https://github.com/rainersigwald/containers/issues/70) - so make sure you're pointing to an unauthenticated registry
+> There is no authentication currently supported - that [will come in a future release](https://github.com/dotnet/sdk-container-builds/issues/70) - so make sure you're pointing to a local Docker daemon
 
 ## ContainerImageName
 
diff --git a/docs/DEMO.md b/docs/DEMO.md
diff --git a/docs/INTEGRATED-DEMO.md b/docs/INTEGRATED-DEMO.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,11 @@
 # Documents Index
 
+This directory contains the documentation for this repo.
+
+You can quickly try containerizing your applications by following the [Getting Started](./GettingStarted.md) guide.
+
+You can [Customize your container](./ContainerCustomization.md) easily as well!
+
 ## References
 
-* [OCI Image Format spec](https://github.com/opencontainers/image-spec/blob/main/spec.md)
-* [Docker Registry API docs](https://docs.docker.com/registry/spec/api/)
-* [Setting up a local Docker registry](https://docs.docker.com/registry/)
 * [Tutorial: Containerize a .NET app](https://docs.microsoft.com/dotnet/core/docker/build-container?tabs=windows)
diff --git a/docs/ZeroToContainer.md b/docs/ZeroToContainer.md
@@ -0,0 +1,29 @@
+# Using the NuGet package to do an end-to-end container build
+
+This guidance will track the most up-to-date version of the package and tasks.
+You should expect it to shrink noticeably over time!
+
+## Prerequisites
+
+* [.NET SDK 7.0.100-preview.7](https://dotnet.microsoft.com/download/dotnet/7.0) or higher
+* Docker should be installed and running
+* On Windows, Docker must be [configured for Linux containers](https://docs.microsoft.com/virtualization/windowscontainers/quick-start/quick-start-windows-10-linux)
+
+## Usage
+
+```bash
+# create a new project and move to its directory
+dotnet new web -n my-awesome-container-app
+cd my-awesome-container-app
+
+# add a reference to the package
+dotnet add package Microsoft.NET.Build.Containers
+
+# publish your project
+dotnet publish --os linux --arch x64 -p:PublishProfile=DefaultContainer
+
+# run your app
+docker run -it --rm -p 5010:80 my-awesome-container-app:1.0.0
+```
+
+Now you can go to `localhost:5010` and you should see the `Hello World!` text!

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public static Layer FromFiles(IEnumerable<(string path, string containerPath)> f`
`30`	`30`	`string tempTarballPath = ContentStore.GetTempFile();`
`31`	`31`	`using (FileStream fs = File.Create(tempTarballPath))`
`32`	`32`	`{`
`33`		`- // using (GZipStream gz = new(fs, CompressionMode.Compress)) // TODO: https://github.com/rainersigwald/containers/issues/29`
	`33`	`+ // using (GZipStream gz = new(fs, CompressionMode.Compress)) // TODO: https://github.com/dotnet/sdk-container-builds/issues/29`
`34`	`34`	`using (TarWriter writer = new(fs, TarEntryFormat.Gnu, leaveOpen: true))`
`35`	`35`	`{`
`36`	`36`	`foreach (var item in fileList)`