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.

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

Add YAML metadata to front matter to identify preview modules #564

Open
theJasonHelmick opened this issue Apr 11, 2022 · 2 comments
Open
Labels
Area-Yaml Issue concerns conversion to Yaml Issue-Enhancement Issue is more of a feature request than a bug

Comments

@theJasonHelmick
Copy link
Collaborator

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 theJasonHelmick added Area-Yaml Issue concerns conversion to Yaml Issue-Enhancement Issue is more of a feature request than a bug labels Apr 11, 2022
@theJasonHelmick theJasonHelmick added this to the 2.0-Preview3 milestone Apr 11, 2022
@sdwheeler
Copy link
Collaborator

sdwheeler commented Nov 14, 2022

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
Copy link
Collaborator

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Yaml Issue concerns conversion to Yaml Issue-Enhancement Issue is more of a feature request than a bug
Projects
None yet
Development

No branches or pull requests

2 participants