Skip to content

[Logstash] Logstash plugin docs tooling in Docs v3 - connect and consult #17013

Open
@karenzone

Description

@karenzone

Related:

Possible path forward

Phase 1: Initial migration

  • Most Logstash content is included in new docs IA under Reference.
    • Content migrated and added back to the logstash repo
  • Shared (or referenced) content migrated and added to the docs-content repo.
    • Troubleshooting
    • install
    • Upgrade
    • Breaking changes
    • Release notes
  • ToDo: @karenzone to spotcheck output for anomalies

Phase 2 - Implement post-docgen content migration from ADOC->MD

  • Content generated by Logstash docs tools lands in logstash-docs repo now.

Phase Next: Scope moving plugin asciidoc source and tooling support to MD

  • Logstash plugin docs tooling
  • ADOC->MD conversion plan for Logstash plugin source
    • Initial proposal:
      • Convert Tier 1 (Elastic) plugins first
      • Convert plugins that have frequent updates next
      • Plan and convert lesser used plugins. (Do we want to convert them all?)

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions