Skip reindexing for integration plugins index

[jrodewig]

Problem:
When adding a new integration plugin, the related plugin page in the Logstash ref links to a non-existent VPR docs landing page, causing broken links. Manually adding the landing page to the VPR docs doesn't currently work — it gets overwritten in the next VPR doc gen.

Example of this for an input plugin:

• Manually adds landing page: https://github.com/elastic/logstash-docs/pull/1021/files
• Landing page include gets overwritten: elastic/logstash-docs@1ebe826

Solution:
Update the versioned_plugins.rb to avoid overwriting the integration plugin index in the VPR docs. This lets us manually add landing pages for integration plugins to the VPR docs. However, this means we'll need to manually maintain integrations-index.asciidoc going forward.

Testing:

1. Check out the main branch locally.

2. Run versiond_plugins.rb to generate the VPR docs:

   GITHUB_TOKEN=XXXXXXXXXXXXXX bundle exec ruby versioned_plugins.rb --output-path=<YOUR_PATH> --dry-run

3. Include a landing page in the integrations-index.asciidoc file in the generated logstash-docs repo. The landing page doesn't need to exist. Example:

   ...
   include::integrations/rabbitmq-index.asciidoc[]
   
   include::integrations/just-another-index.asciidoc[]

4. Check out this PR's branch locally.

5. Rerun versiond_plugins.rb script to regenerate the VPR docs. Use the same output path.

   GITHUB_TOKEN=XXXXXXXXXXXXXX bundle exec ruby versioned_plugins.rb --output-path=<YOUR_PATH> --dry-run

6. Verify that integrations-index.asciidoc file in the generated logstash-docs repo wasn't overwritten. It should still contain your include. Example:

   ...
   include::integrations/rabbitmq-index.asciidoc[]
   
   include::integrations/just-another-index.asciidoc[]

Related issue:

Closes #89

[jrodewig]

CC @karenzone @mashhurs I don't have permissions to add reviewers or labels. Can you take care of that for me (or grant me the permissions)?

Feel free to push commits to the PR or close it. Totally fine if we decide not to go with this approach. It was a good learning experience for me regardless. Thanks!

[karenzone]

Maintaining integrations-index.asciidoc going forward isn't ideal. but wouldn't be a deal breaker because that would be a one-time thing.

We will need THESE integrations index pages updated programmatically: https://github.com/elastic/logstash-docs/blob/versioned_plugin_docs/docs/versioned-plugins/integrations/aws-index.asciidoc.

Our current workflow is a pain to set up, but after initial setup, it's maintenance-free.

[jrodewig]

Maintaining integrations-index.asciidoc going forward isn't ideal. but wouldn't be a deal breaker because that would be a one-time thing.

Agree it's not ideal.

The only alternative I could think of would be an allowlist. That's harder to implement, and there would still be an additional maintenance step(s) to update that list for new integration plugins. This seems simpler. Open to other suggestions or ideas tho.

We will need THESE integrations index pages updated programmatically: https://github.com/elastic/logstash-docs/blob/versioned_plugin_docs/docs/versioned-plugins/integrations/aws-index.asciidoc.

Our current workflow is a pain to set up, but after initial setup, it's maintenance-free.

Yep. Those pages are left as is and will still auto-gen. This only impacts integrations-index.asciisoc.

[mashhurs]

The proposed solution (skip integration type index skip) with this change helps to avoid overwrites unless we publish the plugin. If we publish the plugin type index page will be consistent.
@karenzone what if we add only plugin index (ex: docs/versioned-plugins/integrations/logstash-index.asciidoc) page and let type indexing happen after plugin publishing? As my understanding, it is because {type}s/{plugin_name}-index.asciidoc doesn't exist so we have broken links. If we create this placeholder, it seems to me problem is solved.

[jrodewig]

Closing this PR. Feel free to re-open or reuse the code if it's helpful. Thanks!