elastic / elastic/docs-tools

Versioned Plugin Reference docgen periodically pruned

Open
#109 1 comment 0 reactions 0 assignees View on GitHub
VPR
Dominant language
Ruby
Stars
4
Forks
12
PR merge metrics
No merged PRs in 30d

Description

For reasons I don't yet understand sometimes output-elasticsearch plugin versions/files are pruned:
* https://github.com/elastic/logstash-docs/pull/1686

And then sometimes, they get added back... again for reasons I don't understand:
* https://github.com/elastic/logstash-docs/pull/1728

Output-elasticsearch has the most published versions, so that could be why (so far) this is the only plugin affected.

### Update
Input-beats has joined the party: https://github.com/elastic/logstash-docs/pull/1808/files

### Update v2
Truncations are becoming more frequent (memory considerations maybe?) and creating unnecessary busy work.

Here's a [GitHub query](https://github.com/elastic/logstash-docs/pulls?q=is%3Apr+truncations) that will turn up quite a few. Probably not all because I haven't been 100% consistent with my renaming.

The best way I've found to handle these is to merge truncations or additions as they come in, and delete the branch. Otherwise, we'll get the same changes again and again, which wastes even more time.

### Update 2025-1204
Truncations (or truncations readded) are happening on almost every VPR run.
Query to see how common these situations are relative to all plugin docs PRs: https://github.com/elastic/logstash-docs/pulls?q=is%3Apr+is%3Aclosed

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.