Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete sampleConfigurations folder #3994

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

18 changes: 0 additions & 18 deletions docs/sampleConfigurations/DscResources/README.md

This file was deleted.

15 changes: 12 additions & 3 deletions docs/sampleConfigurations/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Sample configurations

Sample configurations are available in the [winget-dsc](https://github.com/microsoft/winget-dsc/tree/main/samples) repository.

## Using the sample configurations

Download the *.dsc.yaml files to your local system. They can be executed in Dev Home via the "Machine configuration" section. They can also be executed by running `winget configure <path to configuration file>`.

Several DSC resources may require running in administrator mode. If the configuration is leveraging the [WinGet DSC resource](https://www.powershellgallery.com/packages/Microsoft.WinGet.DSC) to install packages, there are also limitations in some cases specific to the installers that may either require or prohibit installation in administrative context.

### GitHub projects (Repositories)
Sample configurations have been provided for various GitHub repositories. These configurations ideally should be placed in a `.configurations` folder in the root of the project directory. Some DSC resources may have parameters that allow you to pass in a relative file path. The reserved variable `$(WinGetConfigRoot)` can be used to specify the full path of the configuration file. An example of how to use that variable with a relative file path is shown below:

Sample configurations have been provided for various GitHub repositories in the [Repositories](https://github.com/microsoft/winget-dsc/tree/main/samples/Repositories) directory. These configurations ideally should be placed in a `.configurations` folder in the root of the project directory. Some DSC resources may have parameters that allow you to pass in a relative file path. The reserved variable `$(WinGetConfigRoot)` can be used to specify the full path of the configuration file. An example of how to use that variable with a relative file path is shown below:

```yaml
- resource: Microsoft.VisualStudio.DSC/VSComponents
Expand All @@ -19,10 +25,13 @@ Sample configurations have been provided for various GitHub repositories. These
```

### Learn to Code (Templates)
Sample configurations in this directory are directly related to the [Windows development paths](https://learn.microsoft.com/windows/dev-environment/#development-paths). These configurations will allow you to automatically set up your device and begin developing in your preferred language quickly.

Sample configurations in [Templates](https://github.com/microsoft/winget-dsc/tree/main/samples/Templates) directory at winget-dsc repo are directly related to the [Windows development paths](https://learn.microsoft.com/windows/dev-environment/#development-paths). These configurations will allow you to automatically set up your device and begin developing in your preferred language quickly.

### Sample DSC Resources (DscResources)
Examples for a few specific DSC Resources are under the [DscResources](./DscResources/) directory.

Examples for a few specific DSC Resources are under the [DscResources](https://github.com/microsoft/winget-dsc/tree/main/samples/DscResources) directory at winget-dsc repository.

### Create your own

Writing YAML is a pain. To help you get started creating your own, there is a [sample tool](https://github.com/microsoft/winget-create/blob/main/Tools/WingetCreateMakeDSC.ps1) for authoring in the winget-create repo. It currently only supports adding apps, but give it a try and contribute to make it better!

This file was deleted.

Loading
Loading