Skip to content

Module Readmes - Update module documentation regarding param for parent resource #1247

Closed

Description

Description

When consuming child modules of a main resource type, its unclear if the name of the parent module should be provided. It gets unclear what parameters are needed and which are not.

To clear this up we should look to detail in each module that this is indeed automatically provided when called from the parent module, but is required when called as a separate module.

i.e. Storage Account - Table Services - Readme - Parameters

Activity

  1. changed the title [-]Update module documentation regarding param for parent resource[/-] [+]Module Readmes - Update module documentation regarding param for parent resource[/+] on Apr 12, 2022
  2. MariusStorhaug commented on Apr 12, 2022

    @MariusStorhaug
    ContributorAuthor

    Could this be where we can use conditional, and write in each child module a default text like Conditional. Not required when deployed via the parent module, else it is required. ?

  3. AlexanderSehr commented on May 1, 2022

    @AlexanderSehr
    Contributor

    Updated with Required if the template is used in a standalone deployment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

[cat] modulescategory: modulesdocumentationImprovements or additions to documentationenhancementNew feature or requestworkshop feedbackfeedback from internal workshop

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions