Document dependsOn update
#185
Merged
Conversation
This file contains 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
SteveL-MSFT
reviewed
Sep 1, 2023
SteveL-MSFT
reviewed
Sep 1, 2023
SteveL-MSFT
reviewed
Sep 1, 2023
| > provider or group instance. | ||
| > | ||
| > If a top-level instance depends on a nested instance, use the `resourceId()` function to lookup | ||
| > the instance of the provider or group containing the dependency instance instead. |
There was a problem hiding this comment.
Does it make sense to say that if there is a need to depend on something deeply nested, you can use grouping to achieve the same effect. An example would probably be best.
There was a problem hiding this comment.
Can you share a pseudo-example of what you mean? I can convert this into a full example afterward, though that may better belong in the eventual conceptual article for managing dependencies in configuration documents.
Prior to this change, the schema for the `dependsOn` keyword used the PSDSC syntax and the schema for instance names allowed arbitrary strings. This change: - Updates the schema and documentation for instance names to clarify that they must be non-empty strings containing only letters, numbers, and spaces. - Updates the schema and documentation for the `dependsOn` property to use the new `resourceId()` function syntax as added in PowerShell#175. For now, this change does not define new reference documentation for the configuration functions. When more configuration functions are added, we can define a separate set of reference documentation for those functions.
This change regenerates the canonical schemas based on the changes to the schemas for the `dependsOn` keyword and instance names.
This change updates the formatting for the YAML metadata blocks in the reference documentation to match the formatting used on Learn. The prior formatting rendered incorrectly on the platform. The updated formatting renders correctly and adheres to the developing style guidance for using YAML metadata in this way.
michaeltlombardi
force-pushed
the
maint/main/document-dependsOn-update
branch
from
a43beb8
to
467bc33
Compare
michaeltlombardi
changed the title
dependsOn update
SteveL-MSFT
approved these changes
Sep 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
dependsOnproperty to use the newresourceId()function syntax as added in Dependson #175.2023/08PR Context
Prior to this change, the schema for the
dependsOnkeyword used the PSDSC syntax and the schema for instance names allowed arbitrary strings.For now, this change does not define new reference documentation for the configuration functions. When more configuration functions are added, we can define a separate set of reference documentation for those functions.