Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve contribution doc #1519

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Improve contribution doc #1519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
18f9955
added infos to the contributing process
ReneHezser Sep 30, 2024
363cef3
add telemetry parameter note
ReneHezser Oct 10, 2024
b851584
Merge branch 'Azure:main' into improve-contribution-doc
ReneHezser Oct 10, 2024
bed4a24
Merge branch 'Azure:main' into improve-contribution-doc
ReneHezser Oct 10, 2024
751e4c1
Update docs/content/specs-defs/specs/shared/_index.md
ReneHezser Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/content/contributing/process.md
View file
Open in desktop
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
View file
Open in desktop
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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