(DOCS) Rough draft of proposed docs outline #74
Conversation
This change adds a rough outline for the proposed docs structure for DSCv3. Submitting the YAML file to the repository for easier async discussion and collaborative editing.
|
LGTM. I'd like to help with these docs. We could either merge here and collab or I can PR to your PR? |
Co-authored-by: Michael Greene <mgreenegit@users.noreply.github.com>
|
@SteveL-MSFT, @mgreenegit - any chance we can get this merged so we can start iterating on some of the draft documents? |
| Covers using `dsc config get` with a pre-defined configuration. Best if | ||
| this can be run against a pre-defined node or used to configure a fresh | ||
| install. | ||
| - How to author a DSC configuration: | |
There was a problem hiding this comment.
This should be a priority to fill in
| - How to manage a resource with DSC: | | ||
| Covers using `dsc resource get/test/set` with a single resource, like | ||
| using `Invoke-DscResource`. | ||
| - How to write a DSC Resource Manifest: | |
| - How to write a DSC Resource in Rust: | | ||
| Covers implementing the shared example DSC Resource in Rust with | ||
| current best practices. | ||
| - How to write a DSC Resource in Go: | |
There was a problem hiding this comment.
Let's start with this one as an example
| We may need a good mock app that we can use for this and other tutorials. | ||
| - How to use assertions with DSC: | | ||
| Covers how to use assertions in a configuration and shows their use case. | ||
| - How to group DSC Resources: | |
There was a problem hiding this comment.
PowerShell resource is a group resource, so we should at least cover this concept
| - How to write a DSC Resource in Go: | | ||
| Covers implementing the shared example DSC Resource in Go with | ||
| current best practices. | ||
| - How to write a DSC Resource in PowerShell: | |
There was a problem hiding this comment.
We should have a tutorial on using existing PowerShell resources (script and/or class based) and also using PS7 vs WindowsPowerShell
| - How to write a DSC Resource in PowerShell: | | ||
| Covers implementing the shared example DSC Resource in PowerShell with | ||
| current best practices. | ||
| Concepts: |
There was a problem hiding this comment.
Will need most of these initially except Logging or Troubleshooting (Reason)
PR Summary
This change adds a rough outline for the proposed docs structure for DSCv3.
PR Context
Submitting the YAML file to the repository for easier async discussion and collaborative editing.
CC @sdwheeler