Skip to content

Commit

Permalink
Add resources README.md for wiki documentation. (#605)
Browse files Browse the repository at this point in the history
  • Loading branch information
johlju authored May 29, 2022
1 parent dfa7d1f commit 334575a
Show file tree
Hide file tree
Showing 17 changed files with 185 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)
- Update the pipeline files to the latest from Sampler.
- Switched build worker from Windows Server 2016 to Windows Server 2022,
so that both Windows Server 2019 and Windows Server 2022 is now used.
- Add resources README.md for wiki documentation.
- CommonTestHelper
- Removed the helper function `Install-NewSelfSignedCertificateExScript`
as the script it used is no longer available. Switched to using the
Expand Down
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_WebApplicationHandler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `WebApplicationHandler` DSC resource is used to ...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+WebApplicationHandler).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xIIsHandler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

> Please use WebApplicationHandler resource instead. xIISHandler will be removed in future release.
## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xIisHandler).
12 changes: 12 additions & 0 deletions source/DSCResources/MSFT_xIisFeatureDelegation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Description

The `xIisFeatureDelegation` DSC resource is used to manage the IIS configuration
section locking (overrideMode) to control what configuration can be set in web.config.

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xIisFeatureDelegation).
12 changes: 12 additions & 0 deletions source/DSCResources/MSFT_xIisLogging/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Description

The `xIISLogging` DSC resource is used to set the logfile settings for **all**
websites; for individual websites use the Log options under **xWebSite**.

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xIISLogging).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xIisMimeTypeMapping/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xIisMimeTypeMapping` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xIisMimeTypeMapping).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xIisModule/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xIISModule` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xIISModule).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xSslSettings/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xSslSettings` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xSslSettings).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xWebAppPool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xWebAppPool` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebAppPool).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xWebAppPoolDefaults/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xWebAppPoolDefaults` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebAppPoolDefaults).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xWebApplication/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xWebApplication` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebApplication).
12 changes: 12 additions & 0 deletions source/DSCResources/MSFT_xWebConfigKeyValue/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Description

>NOTE: The **xWebConfigKeyValue** resource is deprecated and has been replaced by the **xWebConfigProperty** and **xWebConfigPropertyCollection** resources.
>It may be removed in a future release.
## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebConfigKeyValue).
12 changes: 12 additions & 0 deletions source/DSCResources/MSFT_xWebConfigProperty/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Description

The `xWebConfigProperty` DSC resource is used to ensure the value of an
identified property in the web.config file.

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebConfigProperty).
15 changes: 15 additions & 0 deletions source/DSCResources/MSFT_xWebConfigPropertyCollection/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Description

The `xWebConfigPropertyCollection` DSC resource is used to ensure the value of an
identified property collection item's property in the web.config file.

>Builds upon the deprecated **xWebConfigKeyValue** resource to support all web.config
>elements that contain collections of child items.
## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebConfigPropertyCollection).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xWebSite/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xWebSite` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebSite).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xWebSiteDefaults/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xWebSiteDefaults` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebSiteDefaults).
11 changes: 11 additions & 0 deletions source/DSCResources/MSFT_xWebVirtualDirectory/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Description

The `xWebVirtualDirectory` DSC resource is used to...

## Requirements

* Target machine must be running Windows Server 2012 R2 or later.

## Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/xWebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+xWebVirtualDirectory).

0 comments on commit 334575a

Please sign in to comment.