Content documentation best practices for content pack metadata files, release notes, README files, and documentation contributions.
Content pack documentation includes:
pack_metadata.json
Contains the pack description, pack keywords, tags, use-cases, and categories
Content Pack README.md
Packs that provide at least one end-to-end use case should contain a detailed README file that will be displayed in the Details tab of the pack in Marketplace. The README file can contain external images and videos, as needed.
README.md files for integrations, scripts, and playbooks.
Release notes
Track changes made in specific content entities, such as integrations or playbooks.
integrationname_description.md
Describes how to set up an integration.
Integrations, scripts, and playbooks and their components (i.e., integration command arguments and outputs) have descriptions that show up both within the product and in the Reference section of xsoar.pan.dev.
While designing your contribution, we recommend reviewing the design best practices and documentation best practices.