Documentation Contributions - Developer Guide - Cortex XSIAM - Cortex - Security Operations

Cortex XSIAM Developer Guide
Product
Cortex XSIAM
Creation date
2023-05-01
Last date published
2024-06-04
Category
Developer Guide
Abstract

Edit an xsoar.pan.dev doc page or report an issue.

Our developer docs and reference content docs are open source and hosted on GitHub. The editing experience is integrated via GitHub directly into the pan.dev doc site to make it easy to contribute and suggest improvements.

Edit an Existing Document

To fix small errors and omissions in existing documents we recommend editing the document directly via a pull request (PR). While you can create an issue to report the error, it is often faster and easier to edit the document with the suggested fix via a pull request.

Create a pull request to fix a documentation error

  1. Most pages include the edit-this-page.png option at the bottom of the page.

    Note

    If the Edit this page option is not available, it means the page is not open for public contribution. You can still report an issue, but you can not create a pull request with edits.

  2. Once the Edit this page link is clicked, a new GitHub window opens. The window contains the page in markdown view with an option to edit the page. Click the pencil icon to start editing the page.

    xsiam-docs-github-edit.png

    Note

    If the pencil icon is grayed out, you need to log in to your GitHub account or if necessary create an account.

  3. Edit the page with your changes. Use the Preview changes tab to check the formatting of your changes.

  4. Once editing is completed, scroll to the bottom of the page. Enter a title and description for your proposed change and click Propose changes.

    docs-propose-change.png

  5. After clicking on Propose changes you are taken to a new page: Comparing changes. On this page you can compare your changes and create a pull request. Click the Create pull request button.

    docs-compare-changes.png

  6. You are taken to a new page: Open a pull request. Edit the title for the pull request and fill out the description of the PR. Click Create pull request.

    docs-create-pr.png

  7. You've created a pull request. A team member will review and merge your PR. If you've made larger changes, you may get feedback or questions via the comments on the PR.

Reporting a Documentation Issue

If you've found an issue with one of our docs and you are not sure how to fix it via a pull request or the edit option is not available, report an issue. Reporting issues helps improve the documentation.

  1. You can report an issue for a specific document by clicking the report-an-issue.png button at the bottom of the page.

  2. Once the Report an issue button is clicked, a new window from GitHub opens. The window contains GitHub's issue form. Fill out the issue template with a clear and concise description. If applicable, include screenshots to help explain the issue you encountered. Click Submit new issue.