Skip to content

Updates integration contribution doc #5652

Open
jmikell821 wants to merge 1 commit intomainfrom
integrations-update
Open

Updates integration contribution doc #5652
jmikell821 wants to merge 1 commit intomainfrom
integrations-update

Conversation

@jmikell821
Copy link
Member

Summary

Resolves #5628.

Generative AI disclosure

To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following:

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

@jmikell821 jmikell821 self-assigned this Mar 26, 2026
@jmikell821 jmikell821 requested a review from a team as a code owner March 26, 2026 22:28
@github-actions
Copy link
Contributor

github-actions bot commented Mar 26, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Contributor

✅ Vale Linting Results

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

Copy link
Member

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of suggestions, otherwise LGTM.

- Update `changelog.yml` with the new entry.
- Update `manifest.yml` with the new version.

If you need to make subsequent edits to your PR, save your changes, then re-run the `elastic-package build` command from the package's root folder (not the integrations root folder) before your push your commits. This ensures the `packages/{package}/docs/README.md` file is updated with your new changes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you need to make subsequent edits to your PR, save your changes, then re-run the `elastic-package build` command from the package's root folder (not the integrations root folder) before your push your commits. This ensures the `packages/{package}/docs/README.md` file is updated with your new changes.
If you need to make subsequent edits to your PR, save your changes, then re-run the `elastic-package build` command from the package's root folder (not the integrations root folder) before you push your commits. This ensures the `packages/{package}/docs/README.md` file is updated with your new changes.

3. **Check the integration-docs repository**: Look at recent automated update PRs in the integration-docs repository. If they're failing, your changes won't be pulled until the issues are resolved.

4. **Check version compatibility**: If the integration's `manifest.yml` specifies a {{kib}} version that hasn't been released yet. For example, if `^9.3.0` before 9.3 is released, the docs won't appear until that version is live.
4. **Check version compatibility**: Look to see if the integration's `manifest.yml` specifies a {{kib}} version that hasn't been released yet. For example, if `^9.3.0` before 9.3 is released, the docs won't appear until that version is live.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. **Check version compatibility**: Look to see if the integration's `manifest.yml` specifies a {{kib}} version that hasn't been released yet. For example, if `^9.3.0` before 9.3 is released, the docs won't appear until that version is live.
4. **Check version compatibility**: Check if the integration's `manifest.yml` specifies a {{kib}} version that hasn't been released yet. For example, if `^9.3.0` before 9.3 is released, the docs won't appear until that version is live.

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

Successfully merging this pull request may close these issues.

[Internal]: Add clarification for updating integration docs

2 participants