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

Prepare migration plan for module docs #262

Closed
mtojek opened this issue Mar 13, 2020 · 3 comments
Closed

Prepare migration plan for module docs #262

mtojek opened this issue Mar 13, 2020 · 3 comments

Comments

@mtojek
Copy link
Contributor

mtojek commented Mar 13, 2020

The PR #261 introduces basic stub for README.md . The goal of this task is to assemble a list of actions to build/rewrite existing Beats docs for packages.

Existing Beats docs refer to either metricbeat (metrics) or filebeat (logs). It's hard to combine them automatically without preserving the original division (into beats). Also, some of beats modules already contain README.md, mainly for developers/contributors.

Issue: #221

/cc @ruflin

@mtojek mtojek changed the title Prepare migration plan for package docs Prepare migration plan for module docs Mar 13, 2020
@mtojek
Copy link
Contributor Author

mtojek commented Mar 13, 2020

There are a couple of options:

  1. Parse output HTML code that is published online, merge metricbeat and filebeat sections.

  2. Convert .asciidoc to docbook, and then to Markdown, but the migration quality will be poor, also merge metricbeat and filebeat sections.

  3. Manually rewrite docs per integration. We can define a common template for .md files (e.g. README.md).

@ruflin
Copy link
Contributor

ruflin commented Mar 16, 2020

I think our path forward here is option 3 as too many changes are need. One thing that would be still nice to have is that all the content is copied over already to the README.md file from the existing docs. This will help review and reorganise all the content.

@mtojek
Copy link
Contributor Author

mtojek commented May 13, 2020

I think, this one can be closed. Further plans are discussed in: elastic/integrations#20

@mtojek mtojek closed this as completed May 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants