Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
179 changes: 90 additions & 89 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,89 +1,90 @@
name: "Bug report \U0001F41B"
description: Report errors or unexpected behaviour
title: "Bug: "
labels: ['Needs: Triage :mag:','bug']
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a bug report.
If you are not running the latest version of this module, please try to reproduce your bug with the latest version before opening an issue.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: dropdown
attributes:
label: Infrastrcuture as Code Type? (Required)
description: Are you using Bicep or Terraform?
multiple: false
options:
- bicep
- terraform
validations:
required: true
- type: textarea
id: versions
attributes:
label: Module Versions (Required)
description: Please provide relevant module versions.
value: |
ALZ PowerShell Module: x.x.x
Accelerator Bootstrap Modules: x.x.x
Terraform Starter Modules: x.x.x
Bicep Starter Modules: x.x.x
validations:
required: true
- type: textarea
id: inputs
attributes:
label: Input arguments of the ALZ-PowerShell-Module (Optional)
description: Please provide any relevant input arguments of the ALZ PowerShell Module that can reproduce the issue.
validations:
required: false
- type: textarea
id: debug
attributes:
label: Debug Output/Panic Output (Optional)
description: |
For long debug logs please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist.
To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html).
render: shell
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected Behaviour (Required)
description: What should have happened?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behaviour (Required)
description: What actually happened?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce (Optional)
description: |
Please list the steps required to reproduce the issue, e.g.
- type: textarea
id: facts
attributes:
label: Important Factoids (Optional)
description: |
Are there anything atypical about your accounts that we should know? For example: Running in a Azure China/Germany/Government?
- type: textarea
id: references
attributes:
label: References (Optional)
description: |
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Such as vendor documentation?
---
name: "Bug report \U0001F41B"
description: Report errors or unexpected behaviour
title: "Bug: "
labels: ['Needs: Triage :mag:', 'Type: Bug :beetle:']
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a bug report.
If you are not running the latest version of this module, please try to reproduce your bug with the latest version before opening an issue.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: dropdown
attributes:
label: Infrastrcuture as Code Type? (Required)
description: Are you using Bicep or Terraform?
multiple: false
options:
- bicep
- terraform
validations:
required: true
- type: textarea
id: versions
attributes:
label: Module Versions (Required)
description: Please provide relevant module versions.
value: |
ALZ PowerShell Module: x.x.x
Accelerator Bootstrap Modules: x.x.x
Terraform Starter Modules: x.x.x
Bicep Starter Modules: x.x.x
validations:
required: true
- type: textarea
id: inputs
attributes:
label: Input arguments of the ALZ-PowerShell-Module (Optional)
description: Please provide any relevant input arguments of the ALZ PowerShell Module that can reproduce the issue.
validations:
required: false
- type: textarea
id: debug
attributes:
label: Debug Output/Panic Output (Optional)
description: |
For long debug logs please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist.
To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html).
render: shell
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected Behaviour (Required)
description: What should have happened?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behaviour (Required)
description: What actually happened?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce (Optional)
description: |
Please list the steps required to reproduce the issue, e.g.
- type: textarea
id: facts
attributes:
label: Important Factoids (Optional)
description: |
Are there anything atypical about your accounts that we should know? For example: Running in a Azure China/Germany/Government?
- type: textarea
id: references
attributes:
label: References (Optional)
description: |
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Such as vendor documentation?
107 changes: 54 additions & 53 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,53 +1,54 @@
name: "Feature request \U0001F680"
description: Suggest an idea for this project
title: 'Feature Request: '
labels: ['Needs: Triage :mag:','enhancement']
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a feature request.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the proposed feature.
options:
- label: I have searched the existing issues
required: true
- type: dropdown
attributes:
label: Infrastrcuture as Code Type? (Required)
description: Are you using Bicep or Terraform?
multiple: false
options:
- bicep
- terraform
validations:
required: true
- type: textarea
id: usecase
attributes:
label: Use Case (Required)
description: Describe the use case for this feature?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution (Required)
description: Describe how this feature could be implemented?
validations:
required: true
- type: textarea
id: facts
attributes:
label: Important Factoids (Optional)
description: |
Are there anything atypical about your accounts that we should know? For example: Running in a Azure China/Germany/Government?
- type: textarea
id: references
attributes:
label: References (Optional)
description: |
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Such as vendor documentation?
---
name: "Feature request \U0001F680"
description: Suggest an idea for this project
title: 'Feature Request: '
labels: ['Needs: Triage :mag:', 'Type: Enhancement :sparkles:']
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a feature request.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the proposed feature.
options:
- label: I have searched the existing issues
required: true
- type: dropdown
attributes:
label: Infrastrcuture as Code Type? (Required)
description: Are you using Bicep or Terraform?
multiple: false
options:
- bicep
- terraform
validations:
required: true
- type: textarea
id: usecase
attributes:
label: Use Case (Required)
description: Describe the use case for this feature?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution (Required)
description: Describe how this feature could be implemented?
validations:
required: true
- type: textarea
id: facts
attributes:
label: Important Factoids (Optional)
description: |
Are there anything atypical about your accounts that we should know? For example: Running in a Azure China/Germany/Government?
- type: textarea
id: references
attributes:
label: References (Optional)
description: |
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Such as vendor documentation?
13 changes: 9 additions & 4 deletions docs/wiki/[User-Guide]-Quick-Start-Phase-2-Azure-DevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
┗ 📂output
```

1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from [inputs-azure-devops-bicep.yaml][example_powershell_inputs_azure_devops_bicep] into that file.
1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from [inputs-azure-devops-bicep-complete.yaml][example_powershell_inputs_azure_devops_bicep_complete] into that file.
1. Check through the file and update each input as required. It is mandatory to update items with placeholders surrounded by angle brackets `<>`:

| Input | Placeholder | Description |
Expand Down Expand Up @@ -106,7 +106,10 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
┗ 📂output
```

1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from [inputs-azure-devops-terraform.yaml][example_powershell_inputs_azure_devops_terraform] into that file.
1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from the relevant input file for your chosen starter module:
1. Basic - [inputs-azure-devops-terraform-basic.yaml][example_powershell_inputs_azure_devops_terraform_basic]
1. Hub Networking - [inputs-azure-devops-terraform-hubnetworking.yaml][example_powershell_inputs_azure_devops_terraform_hubnetworking]
1. Complete - [inputs-azure-devops-terraform-complete.yaml][example_powershell_inputs_azure_devops_terraform_complete]
1. Check through the file and update each input as required. It is mandatory to update items with placeholders surrounded by angle brackets `<>`:

| Input | Placeholder | Description |
Expand Down Expand Up @@ -172,5 +175,7 @@ Now head to [Phase 3][wiki_quick_start_phase_3].
[wiki_starter_module_terraform_hubnetworking]: %5BUser-Guide%5D-Starter-Module-Terraform-HubNetworking "Wiki - Start Modules - Terraform Hub Networking"
[wiki_starter_module_terraform_complete]: %5BUser-Guide%5D-Starter-Module-Terraform-Complete "Wiki - Starter Modules - Terraform Complete"
[wiki_quick_start_phase_3]: %5BUser-Guide%5D-Quick-Start-Phase-3 "Wiki - Quick Start - Phase 3"
[example_powershell_inputs_azure_devops_bicep]: examples/powershell-inputs/inputs-azure-devops-bicep.yaml "Example - PowerShell Inputs - Azure DevOps - Bicep"
[example_powershell_inputs_azure_devops_terraform]: examples/powershell-inputs/inputs-azure-devops-terraform.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform"
[example_powershell_inputs_azure_devops_bicep_complete]: examples/powershell-inputs/inputs-azure-devops-bicep-complete.yaml "Example - PowerShell Inputs - Azure DevOps - Bicep - Complete"
[example_powershell_inputs_azure_devops_terraform_basic]: examples/powershell-inputs/inputs-azure-devops-terraform-basic.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Basic"
[example_powershell_inputs_azure_devops_terraform_hubnetworking]: examples/powershell-inputs/inputs-azure-devops-terraform-hubnetworking.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Hub Networking"
[example_powershell_inputs_azure_devops_terraform_complete]: examples/powershell-inputs/inputs-azure-devops-terraform-complete.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform - Complete"
13 changes: 9 additions & 4 deletions docs/wiki/[User-Guide]-Quick-Start-Phase-2-GitHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
┗ 📂output
```

1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from [inputs-github-bicep.yaml][example_powershell_inputs_github_bicep] into that file.
1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from [inputs-github-bicep-complete.yaml][example_powershell_inputs_github_bicep_complete] into that file.
1. Check through the file and update each input as required. It is mandatory to update items with placeholders surrounded by angle brackets `<>`:

| Input | Placeholder | Description |
Expand Down Expand Up @@ -96,7 +96,10 @@ Although you can just run `Deploy-Accelerator` and fill out the prompted inputs,
┗ 📂output
```

1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from [inputs-github-terraform.yaml][example_powershell_inputs_github_terraform] into that file.
1. Open your `inputs.yaml` file in Visual Studio Code (or your preferred editor) and copy the content from the relevant input file for your chosen starter module:
1. Basic - [inputs-github-terraform-basic.yaml][example_powershell_inputs_github_terraform_basic]
1. Hub Networking - [inputs-github-terraform-hubnetworking.yaml][example_powershell_inputs_github_terraform_hubnetworking]
1. Complete - [inputs-github-terraform-complete.yaml][example_powershell_inputs_github_terraform_complete]
1. Check through the file and update each input as required. It is mandatory to update items with placeholders surrounded by angle brackets `<>`:

| Input | Placeholder | Description |
Expand Down Expand Up @@ -157,5 +160,7 @@ Now head to [Phase 3][wiki_quick_start_phase_3].
[wiki_starter_module_terraform_hubnetworking]: %5BUser-Guide%5D-Starter-Module-Terraform-HubNetworking "Wiki - Start Modules - Terraform Hub Networking"
[wiki_starter_module_terraform_complete]: %5BUser-Guide%5D-Starter-Module-Terraform-Complete "Wiki - Starter Modules - Terraform Complete"
[wiki_quick_start_phase_3]: %5BUser-Guide%5D-Quick-Start-Phase-3 "Wiki - Quick Start - Phase 3"
[example_powershell_inputs_github_bicep]: examples/powershell-inputs/inputs-github-bicep.yaml "Example - PowerShell Inputs - GitHub - Bicep"
[example_powershell_inputs_github_terraform]: examples/powershell-inputs/inputs-github-terraform.yaml "Example - PowerShell Inputs - GitHub - Terraform"
[example_powershell_inputs_github_bicep_complete]: examples/powershell-inputs/inputs-github-bicep-complete.yaml "Example - PowerShell Inputs - GitHub - Bicep - Complete"
[example_powershell_inputs_github_terraform_basic]: examples/powershell-inputs/inputs-github-terraform-basic.yaml "Example - PowerShell Inputs - GitHub - Terraform - Basic"
[example_powershell_inputs_github_terraform_hubnetworking]: examples/powershell-inputs/inputs-github-terraform-hubnetworking.yaml "Example - PowerShell Inputs - GitHub - Terraform - Hub Networking"
[example_powershell_inputs_github_terraform_complete]: examples/powershell-inputs/inputs-github-terraform-complete.yaml "Example - PowerShell Inputs - GitHub - Terraform - Complete"
Loading
Loading