-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Integration Assistant] [ Security GenAI] Update readme template with…
… the new integration guidelines (#187216) ## Summary Update current README.md.njk structure to match the official integration doc structure according to the [integrations doc guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html).
- Loading branch information
Showing
1 changed file
with
23 additions
and
9 deletions.
There are no files selected for viewing
32 changes: 23 additions & 9 deletions
32
x-pack/plugins/integration_assistant/server/templates/package_readme.md.njk
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,38 @@ | ||
# {{ package_name }} Integration | ||
|
||
This integration is for ingesting data from [{{ package_name }}](https://example.com/). | ||
{% for data_stream in data_streams %} | ||
- `{{ data_stream.name }}`: {{ data_stream.description }} | ||
{% endfor %} | ||
See [Link to docs](https://example.com/docs) for more information. | ||
## Overview | ||
|
||
Explain what the integration is, define the third-party product that is providing data, establish its relationship to the larger ecosystem of Elastic products, and help the reader understand how it can be used to solve a tangible problem. | ||
Check the [overview guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html#idg-docs-guidelines-overview) for more information. | ||
|
||
## Datastreams | ||
|
||
Provide a high-level overview of the kind of data that is collected by the integration. | ||
Check the [datastreams guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html#idg-docs-guidelines-datastreams) for more information. | ||
|
||
## Compatibility | ||
## Requirements | ||
|
||
Insert compatibility information here. This could for example be which versions of the product it was tested with. | ||
The requirements section helps readers to confirm that the integration will work with their systems. | ||
Check the [requirements guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html#idg-docs-guidelines-requirements) for more information. | ||
|
||
## Setup | ||
|
||
Insert how to configure the vendor side of the integration here, for example how to configure the API, create a syslog remote destination etc. | ||
Point the reader to the [Observability Getting started guide](https://www.elastic.co/guide/en/observability/master/observability-get-started.html) for generic, step-by-step instructions. Include any additional setup instructions beyond what’s included in the guide, which may include instructions to update the configuration of a third-party service. | ||
Check the [setup guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html#idg-docs-guidelines-setup) for more information. | ||
|
||
## Troubleshooting (optional) | ||
|
||
Provide information about special cases and exceptions that aren’t necessary for getting started or won’t be applicable to all users. Check the [troubleshooting guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html#idg-docs-guidelines-troubleshooting) for more information. | ||
|
||
## Reference | ||
|
||
Provide detailed information about the log or metric types we support within the integration. Check the [reference guidelines](https://www.elastic.co/guide/en/integrations-developer/current/documentation-guidelines.html#idg-docs-guidelines-reference) for more information. | ||
|
||
## Logs | ||
{% for data_stream in data_streams %} | ||
### {{ data_stream.name }} | ||
|
||
Insert a description of the data stream here. | ||
Insert a description of the datastream here. | ||
|
||
{% raw %}{{fields {% endraw %}"{{ data_stream.name }}"{% raw %}}}{% endraw %} | ||
{% endfor %} |