platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Add YAML metadata to front matter to identify preview modules

Open theJasonHelmick opened this issue 3 years ago • 2 comments
trafficstars

Summary of the new feature / enhancement

In reference to: https://dev.azure.com/ceapex/Engineering/_workitems/edit/404408

We need to define a meta data key that PlatyPS can render to yaml -- perhaps maml. Then OPS would use this information to render the appropriate preview disclaimers on the web pages.

Proposed technical implementation details (optional)

No response

theJasonHelmick avatar Apr 11 '22 16:04 theJasonHelmick

How do you want PlatyPS to determine that the module is prerelease (-AsPreview switch, 0.x version, sematic version with prerelease)? Which files should have the metadata (cmdlets, module, both)? What should the metadata be (eg ispreview: true|false)? Separate cmdlet to add arbitrary metadata? What should OPS do with this metadata when rendering?

sdwheeler avatar Nov 14 '22 18:11 sdwheeler

@mikefrobbins We need to talk with Damien about how this will be used, where the metadata belongs (cmdlet, module, etc), and how it should be rendered on the Docs site.

@adityapatwardhan we need to settle on a schema for this feature.

sdwheeler avatar Feb 22 '23 01:02 sdwheeler