Idea: Move 'description' to metadata.yml (and switch from json -> yml for multiline value support)

dciborow commented 2 years ago

Currently, the description must be set in the Readm.md, while the rest of the values are set in metadata.json.

I wonder if this is because the description is expected to be multi-line, and that JSON has poor support for this.

Current metadata.json

{
  "$schema": "https://aka.ms/bicep-registry-module-metadata-file-schema-v2#",
  "name": "Azure Game Developer VMSS",
  "summary": "Bicep Module to simplify deployment of the Azure Game Developer VMSS",
  "owner": "dciborow"
}

Proposed metadata.yml

# yaml-language-server: $schema=https://aka.ms/bicep-registry-module-metadata-file-schema-v3
name: Azure Game Developer VMSS,
summary: Bicep Module to simplify deployment of the Azure Game Developer VMSS,
owner: dciborow
description: |
The Game Development Virtual Machine is a customizable development workstation or build server in Azure, pre-installed with common game development tooling for game creators to build their games in the cloud.
Microsoft partnered with the top game development partners to pre-install Visual Studio, Unreal Engine, Perforce Helix Core, Parsec, Teradici, Incredibuild, Blender, DirectX/GDK/PlayFab SDKs and more in a customizable Azure workstation to make deploying your game creation environment simple, seamless, and secure.
No additional costs are added above base Azure VM pricing for leveraging this VM, though Solutions like Incredibuild, Parsec and Teradici require you to Bring Your Own License (BYOL) when leveraging those products, and passing in licensing details is configurable on deployment.
The Game Development Virtual Machine currently supports Windows Server 2019 and Windows 10 operating systems.

See our [documentation](https://docs.microsoft.com/en-us/gaming/azure/game-dev-virtual-machine/) for more information.

dciborow commented 2 years ago

@shenglol , let me know what you think about this, and if its something you would consider I can put together the PR.

shenglol commented 1 year ago

Missed this one…yaml files provide better editing experience, but my concern is the JSON schema validation library the brm tool uses won't work with yaml files. Also, users will have to install the YAML VS Code extension and add a comment to associate the metadata file schema to get validations and IntelliSense.

ChrisSidebotham commented 6 months ago

Dear @dciborow, Azure Verified Modules (AVM) will become the single Microsoft standard for Bicep modules. Transitioning to AVM, requests for new features or bug fixes will need to be submitted against the appropriate AVM module via AVM Module Issues.

As part of this transition, the new AVM CI environment is replacing the existing CI formerly leveraged within the Bicep Registry Modules (BRM) repository. As a result of this, issues and features related to the existing BRM CI will be closed. If you think your issue still needs addressing, please raise a new issue related to the AVM CI, here.

See this informational notice for more details on the upcoming changes.

Thank you for your understanding!

Azure / bicep-registry-modules

Idea: Move 'description' to metadata.yml (and switch from json -> yml for multiline value support) #150