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

VPR: growing list of gsubs creates risk #60

Open
yaauie opened this issue Jul 12, 2021 · 0 comments
Open

VPR: growing list of gsubs creates risk #60

yaauie opened this issue Jul 12, 2021 · 0 comments

Comments

@yaauie
Copy link
Member

yaauie commented Jul 12, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant