Skip to content

Commit

Permalink
Improve contribution doc (#1519)
Browse files Browse the repository at this point in the history
Co-authored-by: Alexander Sehr <[email protected]>
Co-authored-by: Máté Barabás <[email protected]>
  • Loading branch information
3 people authored Oct 28, 2024
1 parent 09c8435 commit 7faf9f3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/content/contributing/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ Each AVM module **MUST** have a [Module Proposal](https://aka.ms/AVM/ModulePropo

{{< /hint >}}

{{< hint type=tip >}}

Some nodes of the above Flowchart are links that point to more information. You can identify them by the ">" and "<" chars around the node-text.

{{< /hint >}}

<!-- markdownlint-disable -->
{{< mermaid class="text-center" >}}
flowchart TD
Expand Down Expand Up @@ -60,6 +66,14 @@ flowchart TD
click P "/Azure-Verified-Modules/help-support/module-support/"
{{< /mermaid >}}
<!-- markdownlint-enable -->

### Provide details for module proposals

When proposing a module, please include the information in the description that is mentioned for the triage process here:

- [Module Proposals](/Azure-Verified-Modules/help-support/issue-triage/avm-issue-triage/#module-proposal-triage)
- [Pattern modules](/Azure-Verified-Modules/help-support/issue-triage/avm-issue-triage/#triaging-pattern-modules)

## AVM Preview Notice

{{< hint type=important >}}
Expand Down
6 changes: 6 additions & 0 deletions docs/content/specs-defs/specs/shared/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,12 @@ The telemetry enablement **MUST** be on/enabled by default, however this **MUST*
- Bicep: `enableTelemetry`
- Terraform: `enable_telemetry`

{{< hint type=note >}}

Whenever a module references AVM modules that implement the telemetry parameter (e.g., a pattern module that uses AVM resource modules), the telemetry parameter value **MUST** be passed through to these modules. This is necessary to ensure a consumer can reliably enable & disable the telemetry feature for all used modules.

{{< /hint >}}

<br>

---
Expand Down

0 comments on commit 7faf9f3

Please sign in to comment.