Merge pull request #6 from michaeltlombardi/maint/main/readme

(MAINT) Draft readme

Author: michaeltlombardi

.build.ps1

@@ -1,8 +1,5 @@
-#!/usr/bin/env pwsh
-#
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
-#
 #requires -Version 7.2
 #requires -Module InvokeBuild
 

.devcontainer/Dockerfile

@@ -1,3 +1,5 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 FROM mcr.microsoft.com/devcontainers/base:ubuntu
 RUN wget https://github.com/errata-ai/vale/releases/download/v2.26.0/vale_2.26.0_Linux_64-bit.tar.gz && \
     tar -xvzf vale_2.26.0_Linux_64-bit.tar.gz -C bin && \

.github/workflows/publish.site.yml

@@ -31,22 +31,22 @@ jobs:
         with:
           hugo-version: latest
           extended:     true
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: latest
-          cache:        npm
-          # The action defaults to search for the dependency file (package-lock.json,
-          # npm-shrinkwrap.json or yarn.lock) in the repository root, and uses its
-          # hash as a part of the cache key.
-          # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-data
-          cache-dependency-path: '**/package-lock.json'
-      - name: Install PostCSS
-        run: |
-          cd ./Site
-          npm ci
-          npm ls
-          cd ..
+      # - name: Setup Node
+      #   uses: actions/setup-node@v3
+      #   with:
+      #     node-version: latest
+      #     cache:        npm
+      #     # The action defaults to search for the dependency file (package-lock.json,
+      #     # npm-shrinkwrap.json or yarn.lock) in the repository root, and uses its
+      #     # hash as a part of the cache key.
+      #     # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-data
+      #     cache-dependency-path: '**/package-lock.json'
+      # - name: Install PostCSS
+      #   run: |
+      #     cd ./Site
+      #     npm ci
+      #     npm ls
+      #     cd ..
       - name: Setup PowerShell module cache
         id: cacher
         uses: actions/cache@v3
@@ -67,18 +67,18 @@ jobs:
         run: |
           Invoke-Build -Task BuildSite -SiteBaseUrl https://powershell.github.io/DSC-Samples/
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v2
         with:
           path: ./.site/public
   # Deployment job
-  # deploy:
-  #   if: github.ref == 'refs/heads/main'
-  #   environment:
-  #     name: github-pages
-  #     url: ${{ steps.deployment.outputs.page_url }}
-  #   runs-on: ubuntu-latest
-  #   needs: build
-  #   steps:
-  #     - name: Deploy to GitHub Pages
-  #       id: deployment
-  #       uses: actions/deploy-pages@v2
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/rules.github.yaml

@@ -11,7 +11,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Analyze repository
-        uses: microsoft/ps-rule@v2.8.1
+        uses: microsoft/ps-rule@v2.9.0
         with:
           modules: "PSRule.Rules.GitHub"
   analyze_msft_oss:
@@ -21,7 +21,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Run PSRule analysis
-        uses: Microsoft/ps-rule@main
+        uses: microsoft/ps-rule@v2.9.0
         with:
           modules: "PSRule.Rules.MSFT.OSS"
           prerelease: true

README.md

@@ -1,5 +1,61 @@
 # DSC-Samples
 
-This repository includes code samples for DSC v3.
+This repository includes code samples and accompanying tutorial for DSC v3. All code in this
+repository is for non-production samples used in the DSC documentation and is designed to be used
+for learning and experimentation purposes.
 
-<!-- Todo: Actual readme -->
+For more information about DSC v3, see [the DSC v3 repository][00].
+
+## Contributing
+
+<!-- vale off -->
+
+This project welcomes contributions and suggestions. Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the
+instructions provided by the bot. You will only need to do this once across all repos using our
+CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct][01]. For more information see
+the [Code of Conduct FAQ][02] or contact [[email protected]][03] with any additional questions
+or comments.
+
+The [Contribution Guide][04] includes in-depth information and guidance for contributing to this
+project.
+
+<!-- vale on -->
+
+## Legal Notices
+
+<!-- vale off -->
+
+Microsoft and any contributors grant you a license to the Microsoft documentation and other content
+in this repository under the [Creative Commons Attribution 4.0 International Public License][05],
+see the [LICENSE][06] file, and grant you a license to any code in the repository under the
+[MIT License][07], see the [LICENSE-CODE][08] file.
+
+Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the
+documentation may be either trademarks or registered trademarks of Microsoft in the United States
+and/or other countries. The licenses for this project do not grant you rights to use any Microsoft
+names, logos, or trademarks. Microsoft's general trademark guidelines can be found at
+http://go.microsoft.com/fwlink/?LinkID=254653.
+
+Privacy information can be found at https://privacy.microsoft.com/en-us/.
+
+Microsoft and any contributors reserve all other rights, whether under their respective copyrights,
+patents, or trademarks, whether by implication, estoppel or otherwise.
+
+<!-- vale on -->
+
+[00]: https://github.com/PowerShell/DSC/
+[01]: https://opensource.microsoft.com/codeofconduct/
+[02]: https://opensource.microsoft.com/codeofconduct/faq/
+[03]: mailto:[email protected]
+[04]: https://powershell.github.io/DSC-Samples/contributing
+[05]: https://creativecommons.org/licenses/by/4.0/legalcode
+[06]: LICENSE
+[07]: https://opensource.org/licenses/MIT
+[08]: LICENSE-CODE

SUPPORT.md

@@ -0,0 +1,20 @@
+# Support
+
+You can get help with the code samples and tutorials in this repository by filing an issue for the
+team or community to review and address.
+
+<!-- vale off -->
+
+This sample code is not supported under any Microsoft standard support program or service.
+
+This sample code is provided AS IS without warranty of any kind. Microsoft disclaims all implied
+warranties including, without limitation, any implied warranties of merchantability or of fitness
+for a particular purpose. The entire risk arising out of the use or performance of the sample code
+and documentation remains with you. In no event shall Microsoft, its authors, or anyone else
+involved in the creation, production, or delivery of the scripts be liable for any damages
+whatsoever (including, without limitation, damages for loss of business profits, business
+interruption, loss of business information, or other pecuniary loss) arising out of the use of or
+inability to use the sample scripts or documentation, even if Microsoft has been advised of the
+possibility of such damages.
+
+<!-- vale on -->

app/build.ps1

@@ -1,4 +1,5 @@
-#!/usr/bin/env pwsh
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 [CmdletBinding()]
 param (

samples/go/resources/first/build.ps1

@@ -1,4 +1,3 @@
-#!/usr/bin/env pwsh
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.