-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New topic in Pan Dev - Images in Doc Files
- Loading branch information
1 parent
6cec5af
commit b1e49f7
Showing
1 changed file
with
88 additions
and
0 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| id: images_in_documentation_files | ||
| title: Images in Documentation Files | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| Images in documentation markdown files are divided into 2 different types: | ||
| - Images that appear in integration/script/playbook readmes. These images only appear in https://xsoar.pan.dev/. They do not appear in the Cortex XSOAR/XSIAM product UI. | ||
| - Images that appear in pack readmes and integration description files. These images appear in both https://xsoar.pan.dev/ and in the Cortex XSOAR/XSIAM product UI. | ||
|
|
||
| ## Integration/Script/Playbook Readme Images | ||
|
|
||
| When creating markdown `README` documents for playbooks, integrations, or scripts that appear in https://xsoar.pan.dev/ only, you can use a relative or absolute URL. | ||
|
|
||
| ### Relative Image URLs for Integration/Script/Playbook Readmes | ||
| You can use relative URLs to documentation images stored in the `doc_files` or `doc_imgs` directories. To use relative URLs simply link the image using a relative path such as: | ||
| ``` | ||
|  | ||
| ``` | ||
|
|
||
| Make sure to view the `README.md` file in GitHub's web interface and validate that the images display properly. | ||
|
|
||
| **Documentation with Relative URL examples:** | ||
| * Google Calendar: https://github.com/demisto/content/blob/master/Packs/GoogleCalendar/Integrations/GoogleCalendar/README.md | ||
| * G Suite Admin: https://github.com/demisto/content/blob/master/Packs/GSuiteAdmin/Integrations/GSuiteAdmin/README.md | ||
|
|
||
| ### Absolute Image URLs for Integration/Script/Playbook Readmes | ||
|
|
||
| To obtain an absolute URL to an image from GitHub: | ||
|
|
||
| * Commit the image and push to GitHub. | ||
| * View the file in the GitHub web interface. | ||
| * Copy the URL from the `Download` button. | ||
| * Make sure the URL you are copying is not referring to a branch which will be deleted after the PR is merged. The URL should refer to a commit hash or the `master` branch. | ||
| * Note: if you click the `Download` button, GitHub will perform a redirect and the url in the browser will point to the domain: `raw.githubusercontent.com`. You may also use this URL as the absolute URL. | ||
|
|
||
|
|
||
| Embed the image in the README.md using a Markdown Image Link, such as: | ||
| ``` | ||
|  | ||
| ``` | ||
| If you want more control on the image (for example setting width dimension) you can use the HTML `<img>` tag, such as: | ||
|
|
||
| ``` | ||
| <img width="500" src="https://github.com/demisto/content/raw/2d6e082cfb181f823e5b1446ae71e10537591ea6/Packs/AutoFocus/doc_files/AutoFocusPolling.png" /> | ||
| ``` | ||
| **Screenshot of `Download` button:** | ||
|  | ||
|
|
||
| **Absolute Image URL Examples:** | ||
| * URL to commit hash: https://github.com/demisto/content/raw/2d6e082cfb181f823e5b1446ae71e10537591ea6/Packs/AutoFocus/doc_files/AutoFocusPolling.png | ||
| * URL to `master` branch: https://github.com/demisto/content/raw/master/Packs/AutoFocus/doc_files/AutoFocusPolling.png | ||
| * URL after redirection (also valid): https://raw.githubusercontent.com/demisto/content/master/Packs/AutoFocus/doc_files/AutoFocusPolling.png | ||
|
|
||
| :::note | ||
| To keep our main Content repo small we limit images to 2MB. For larger images, follow the instructions for [Videos](#videos) on how to store large media files in our [content-assets](https://github.com/demisto/content-assets) repository. | ||
| ::: | ||
|
|
||
| ## Pack Readmes and Integration Description Files Images | ||
|
|
||
| When creating a markdown pack `README` or an integration description file for XSOAR/XSIAM entities you must use an absolute URL. | ||
|
|
||
| To obtain an absolute URL to an image from GitHub: | ||
|
|
||
| * Commit the image and push to GitHub. | ||
| * View the file in the GitHub web interface. | ||
| * Copy the URL from the `Download` button. | ||
| * Make sure the URL you are copying is not referring to a branch which will be deleted after the PR is merged. The URL should refer to a commit hash or the `master` branch. | ||
| * Note: if you click the `Download` button, GitHub will perform a redirect and the url in the browser will point to the domain: `raw.githubusercontent.com`. You may also use this URL as the absolute URL. | ||
|
|
||
|
|
||
| Embed the image in the README.md using a Markdown Image Link, such as: | ||
| ``` | ||
|  | ||
| ``` | ||
|
|
||
| **Screenshot of `Download` button:** | ||
|  | ||
|
|
||
| **Absolute Image URL Examples:** | ||
| * URL to commit hash: https://github.com/demisto/content/raw/2d6e082cfb181f823e5b1446ae71e10537591ea6/Packs/AutoFocus/doc_files/AutoFocusPolling.png | ||
| * URL to `master` branch: https://github.com/demisto/content/raw/master/Packs/AutoFocus/doc_files/AutoFocusPolling.png | ||
| * URL after redirection (also valid): https://raw.githubusercontent.com/demisto/content/master/Packs/AutoFocus/doc_files/AutoFocusPolling.png | ||
|
|
||
| :::note | ||
| To keep our main Content repo small we limit images to 2MB. For larger images, follow the instructions for [Videos](#videos) on how to store large media files in our [content-assets](https://github.com/demisto/content-assets) repository. | ||
| ::: |