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: Revisit allowing a non-standard landing page (use case: new integrations) #89

Open
karenzone opened this issue Jul 26, 2023 · 1 comment
Assignees
Labels

Comments

@karenzone
Copy link
Contributor

In #53, I requested the ability to add a non-standard landing page to the Logstash Versioned Plugin Reference. We addressed the immediate need at the time--to support aliased plugins--with #54.

TL;DR from #53 (comment): "The ability to easily add a manual landing page and not have it stomped has broader use cases."

Implementing docs for new plugin integrations might be that use case.

Related:

@karenzone
Copy link
Contributor Author

One possible implementation:
I'm picturing a file in which we can enter the name of a new plugin landing page. After the plugin generation runs, it checks this override file. If it found an entry for a manually generated landing page in the override file, it would leave the landing page file alone. This would ensure that we have a VPR landing page to link to for a new integration. and eliminate the manual steps to outsmart the process.

@yaauie indicated in a comment to the original issue, that the overwrite happens here:

$stderr.puts("REINDEXING TYPES... #{}\n")
plugin_names_by_type.each do |type, names|
$stderr.puts("[type:#{type}] reindexing\n")
write_type_index(type, names.sort)
end

When the integration docs are in place and docs are being generated automatically, versioned_plugins.rb could verify that the override entry is not needed, and clear it to remove the cruft.

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

Successfully merging a pull request may close this issue.

1 participant