Contributors Guide: File Structure

Overview | File Structure | Banners | Naming Standard | Comments | Parameters File Samples | ARM Templates | Documents & Diagrams

Depending on the contribution, specific files should either be either updated or added to follow the established heirarchy and structure.

Baseline

workload/arm/deploy-basline.json
workload/bicep
- modules/< functionality >
  - .bicep (contains additional module files needed for functionality)
  - deploy.bicep
- parameters
  - deploy-baseline-min-parameters-example.json
  - deploy-baseline-parameters-example.json
- deploy-baseline.bicep
- readme.md
workload/portal-ui/portal-ui-baseline.json

Custom Image Build

workload/arm/deploy-custom-image.json
workload/bicep
- modules/< functionality >
  - .bicep (contains additional module files needed for functionality)
  - deploy.bicep
- parameters
  - deploy-custom-image-min-parameters-example.json
  - deploy-custom-image-parameters-example.json
- deploy-baseline.bicep
- readme.md
workload/portal-ui/portal-ui-baseline.json

Brownfield Deployment

workload/arm/brownfield/deploy< solution >.json
workload/bicep/brownfield/< solution >
- modules
- parameters
  - < solution >.parameters.all.json
  - < solution >.parameters.min.json
- references
- deploy.bicep
- readme.md
workload/portal-ui/brownfield/portalUi< solution >.json