Skip to content

Docs for some integration plugin components aren't getting updated #80

@karenzone

Description

@karenzone

Specifics

  • Logstash Reference (LSR)
  • AWS integration 7.0.0
    • codec-cloudfront
    • codec-cloudtrail

Details

When we create a new integration plugin and "adopt" formerly stand-alone plugins, the integration and child plugins are all expected to update in tandem to the next major version (AWS 7.0.0). For the AWS integration, the version number/release date on the two codec plugins--cloudfront and cloudtrail--are not getting updated. Here's an example of an early PR where this problem presented itself: elastic/logstash-docs#1400.

Short-term remediation

As a short-term work-aound, I manually bumped the release date/version in the output files in logstash-docs.

When we run the doc generation job for affected branches, the resulting PR contains files with the old version and release date. Obviously, we don't want to introduce regressions, so I have to make manual fixes on the PR. Here's the fix we need to address this secondary problem: #79.

Other notes

  • This issue applies only to Logstash Reference (LSR) plugin generation. The Versioned Plugin Reference (VPR) plugin generation uses different tooling and is not impacted.
  • This issue could possibly be related to settings (lockfiles, skiplists, etc.) rather than a problem with docs tooling. If that's the case, we need to fix that elsewhere and/or update "Adding integration docs" internal documentation as another checklist item.
  • As with most docs-tooling issues, testing might be tricky because we'll need to bump version and publish to fully test.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions