Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
5 tasks
karenzone opened this issue Feb 3, 2025 · 0 comments
Open
5 tasks
Assignees
Labels

Comments

@karenzone
Copy link
Contributor

karenzone commented Feb 3, 2025

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?)
@karenzone karenzone added the docs label Feb 3, 2025
@karenzone karenzone self-assigned this Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant