Skip to content

VPR: growing list of gsubs creates riskΒ #60

@yaauie

Description

@yaauie

In the versioned plugin reference (VPR) we generate docs for every version of every plugin, but unfortunately some plugins have broken docs in certain released versions that if left unfixed would break our docs build. We cannot modify the source of released plugins, so to address this we have a growing list of gsub expressions that are applied to find the offending substring and replace it with something valid.

These gsub replacements are applied to all plugins, and can end up with unintended side-effects (like the helpful replacement of [source] with [source,shell] for improved syntax highlighting also mucking up ECS docs referencing the [source] field [#59]).

It would be nice to be able to constrain a fix to a particular plugin, or even to specific versions of a plugin. Bonus points for being able to specify in config instead of in code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions