A doc generator implementation for aliased plugin.

[mashhurs]

A doc generator for alias plugins.

Description

This change automates manual job to create a doc for aliased plugins such as beats. We don't see the potential use cases to generate versioned docs for alias plugins, so lgic will be integrated into reference doc generator.

Usage

Install the bundle
bundle install --path=vendor/bundle
Run generator
bundle exec ruby plugindocs.rb --output-path ../logstash-docs ../logstash/plugins_version_docs.json
Note that, I have locally pulled logstash repo and run plugins_version_docs.json generator gradle job before running this command.

Test

• Update beats.asciidoc, run following command and see if it generates elastic_agent.asciidoc file.
  bundle exec ruby plugindocs.rb --output-path ../logstash-docs ../logstash/plugins_version_docs.json
• In case I have also run the versioned_plugins.rb script to make sure this change does not block existing jobs.
  bundle exec ruby versioned_plugins.rb --repair --skip-existing --dry-run --output-path=../
  (don't forget setting your GITHUB_TOKEN in env if running multiple times)

[mashhurs]

I will update this PR once dependant PR is merged: dependant PR

[yaauie]

Hey @mashhurs fantastic work.

I've left a couple nitpicks, a suggestion to pull some of the reindexing up into the new Alias utility, and some thoughts about simplifying the intermediate alias definition index format so that we didn't have to deal with so many complexities of nesting.

[yaauie]

Certainly getting close. Everything I have left is pretty minor:

My comments fit into 5 categories:

• alias plugin equivalence
• copy/paste artifacts from wrapped plugin implementation remain in alias plugin
• failing early by using Hash#fetch for required values
• ruby-ism: avoiding explicit return (except in guard clauses)
• ruby-ism: module methods

[yaauie]

LGTM 🎉