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

Use "elastic-package build" to render README.md files. #410

Merged
merged 5 commits into from
Nov 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.DS_Store

.idea
build
/build

dev/packages
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ what's been already fixed, as the script has overridden part of it).
4. Write README template file for the integration.

The README template is used to render the final README file including exported fields. The template should be placed
in the `dev/import-beats-resources/<integration-name>/docs/README.md`.
in the `package/<integration-name>/_dev/build/docs/README.md`. If the directory doesn't exist, please create it.

Review the MySQL docs template to see how to use template functions (e.g. `{{fields "dataset-name"}}`).
If the same dataset name is used in both metrics and logs, please add `-metrics` and `-logs` in the template. For example, `elb` is a dataset for log and also a dataset for metrics. In README.md template, `{{fields "elb_logs"}}` and `{{fields "elb_metrics"}}` are used to separate them.
Expand Down Expand Up @@ -251,7 +251,7 @@ what's been already fixed, as the script has overridden part of it).
11. Update docs template with sample events.

The events collected by the agent slightly differ from original, Metricbeat's and Filebeat's, ones. Adjust the event
content manually basing on already migrated integrations (e.g. [MySQL integration](https://github.com/elastic/integrations/blob/master/dev/import-beats-resources/mysql/docs/README.md))
content manually basing on already migrated integrations (e.g. [MySQL integration](https://github.com/elastic/integrations/blob/master/packages/mysql/_dev/build/docs/README.md))
or copy them once managed to run whole setup with real agent.

12. Kibana: use `stream.dataset` field instead of `event.dataset`.
Expand Down
19 changes: 0 additions & 19 deletions dev/generate-docs/README.md

This file was deleted.

58 changes: 0 additions & 58 deletions dev/generate-docs/doc_template.go

This file was deleted.

157 changes: 0 additions & 157 deletions dev/generate-docs/exported_fields.go

This file was deleted.

68 changes: 0 additions & 68 deletions dev/generate-docs/main.go

This file was deleted.

30 changes: 0 additions & 30 deletions dev/generate-docs/packages.go

This file was deleted.

Loading