(DOCS) Rough draft of proposed docs outline#74
Merged
SteveL-MSFT merged 2 commits intoPowerShell:mainfrom Jun 14, 2023
michaeltlombardi:maint/main/docs-outline-proposal
Merged
(DOCS) Rough draft of proposed docs outline#74SteveL-MSFT merged 2 commits intoPowerShell:mainfrom michaeltlombardi:maint/main/docs-outline-proposal
SteveL-MSFT merged 2 commits intoPowerShell:mainfrom
michaeltlombardi:maint/main/docs-outline-proposal
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.
mgreenegit
reviewed
May 9, 2023
Member
|
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>
Collaborator
Author
|
@SteveL-MSFT, @mgreenegit - any chance we can get this merged so we can start iterating on some of the draft documents? |
mgreenegit
approved these changes
May 23, 2023
mgreenegit
approved these changes
May 23, 2023
SteveL-MSFT
reviewed
Jun 14, 2023
| 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: | |
Member
There was a problem hiding this comment.
This should be a priority to fill in
SteveL-MSFT
reviewed
Jun 14, 2023
| - 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: | |
SteveL-MSFT
reviewed
Jun 14, 2023
| - 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: | |
Member
There was a problem hiding this comment.
Let's start with this one as an example
SteveL-MSFT
reviewed
Jun 14, 2023
| 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: | |
Member
There was a problem hiding this comment.
PowerShell resource is a group resource, so we should at least cover this concept
SteveL-MSFT
reviewed
Jun 14, 2023
| - 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: | |
Member
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
SteveL-MSFT
reviewed
Jun 14, 2023
| - How to write a DSC Resource in PowerShell: | | ||
| Covers implementing the shared example DSC Resource in PowerShell with | ||
| current best practices. | ||
| Concepts: |
Member
There was a problem hiding this comment.
Will need most of these initially except Logging or Troubleshooting (Reason)
SteveL-MSFT
approved these changes
Jun 14, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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