Skip to content

Better story for different versions/flavors of a module #273

Closed
@vors

Description

@vors

Problem

Currently, platyPS doesn't have a way to re-use content between different version or flaivors of the module. I.e. https://github.com/PowerShell/PowerShell-Docs/tree/staging/reference has different top-level folders with a bunch of duplicated content.

The same thing is applicable for different flavors of the same module, i.e. Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, and Skype for Business Online.

There is a significant overlap, so it's desirable to re-use the documentation.

Proposal

The schema would need to accommodate new meta information to support this.

  • Command level tag to indicate applicable module names and versions per cmdlet.
  • Parameter level tag for the same.

API to create and consume this functionality

  • New parameter for New-ExternalHelp that allows generating particular version out of tagged md
  • New capabilities for Update-MarkdownHelp that allows to update multi-version
  • * Maybe new cmdlet or param set for onboarding experience: easily combine existing md files for different versions into one.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions