diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md index 3e3319618..48b7f4c07 100644 --- a/docs/contributing/contributing.md +++ b/docs/contributing/contributing.md @@ -6,9 +6,9 @@ title: Contributing XSOAR Content This article describes the contribution process for Cortex XSOAR content. Contributing allows clients and partners who created new content, or modified existing content (enhancements, bug-fixes, etc.), to share their work with the community by making it publicly available in [Cortex XSOAR Marketplace](https://cortex.marketplace.pan.dev/marketplace/). -Content can be Cortex XSOAR, partner, or community supported, and can be either [free or paid](../partners/premium-packs#pricing). +Content can be Cortex XSOAR, partner, or community supported. -All content (except for paid content packs) is open source, and is hosted on the [Cortex XSOAR Content GitHub Repository](https://github.com/demisto/content), licensed under the [MIT license](https://github.com/demisto/content/blob/master/LICENSE). +All content is open source, and is hosted on the [Cortex XSOAR Content GitHub Repository](https://github.com/demisto/content), licensed under the [MIT license](https://github.com/demisto/content/blob/master/LICENSE). **If you have any questions or need support, reach out to us on the `#demisto-developers` channel on our [Slack DFIR Community](https://start.paloaltonetworks.com/join-our-slack-community).** :::note @@ -74,10 +74,6 @@ Contributing from Marketplace has several limitations: Because of these limitations, we do not recommend using this method for large contributions, especially for XSOAR-supported packs. ::: -### 3. A Private GitHub Repository (Premium Packs) -Contributing from a private GitHub repository is required only when the contribution is for a **Premium** (paid) content pack. -The requirements are the same as supported packs, and the contribution process of premium packs is described in [the following dedicated article](../packs/premium_packs). - --- :::note @@ -115,7 +111,8 @@ Carefully review the following guidelines, as they will greatly enhance the like Once these steps are completed, you should be ready to submit your contribution and open a Pull Request. :::tip -The [Hello World content pack](https://github.com/demisto/content/tree/master/Packs/HelloWorld) is a good example that implements all of the above guidelines and can be used as a reference (alongside the [Hello World Design Document](https://docs.google.com/document/d/1wETtBEKg37PHNU8tYeB56M1LE314ux086z3HFeF_cX0)). +The [Hello World content pack](https://github.com/demisto/content/tree/master/Packs/HelloWorld) is a good example that implements all of the above guidelines and can be used as a reference (alongside the [Hello World Design Document](https://github.com/demisto/content-docs/files/14121809/Cortex.XSOAR.Content.Pack.Design.Document.-.Hello.World.V1.pdf)). + ::: :::note diff --git a/docs/documentation/readme_file.md b/docs/documentation/readme_file.md index a9200d6e9..ebe314a22 100644 --- a/docs/documentation/readme_file.md +++ b/docs/documentation/readme_file.md @@ -67,7 +67,7 @@ Images can be added to your documentation files. For information, see [Images i A video can provide a great addition to the documentation either as a demo video or tutorial. The preferred video format is `mp4`. ### Videos Stored in GitHub -Because of their size and in order to keep our main Content repo small, we store large media files in a separate repository: "documentation/images_in_documentation_files". +Because of their size and in order to keep our main Content repo small, we store large media files in a separate repository. To add the video file, open a pull request with the video file at [content-assets](https://github.com/demisto/content-assets/pulls) repository. The file should be placed in the directory: `Assets//`. diff --git a/docs/integrations/unit-testing.md b/docs/integrations/unit-testing.md index 426836eee..6f5982555 100644 --- a/docs/integrations/unit-testing.md +++ b/docs/integrations/unit-testing.md @@ -28,7 +28,7 @@ For more information, see [visual studio code extension documentation](https://x * **Install the Cortex XSOAR Plugin**: Install with-in PyCharm by navigating to `Preferences.. -> Plugins`. Or download and install from [here](https://plugins.jetbrains.com/plugin/12093-demisto-add-on-for-pycharm) * **Open Pycharm**: Open PyCharm where the root folder is the folder you wish to develop within. -* **Choose Interpreter**: Choose the poetry environment interpreter (with all dependencies we setup in the previous step). See: +* **Choose Interpreter**: Choose the poetry environment interpreter. See: * **Enable PyTest**: We run our unit tests with `pytest`. See the following on how to enable PyTest: ## Use `main` in Integration/Automation diff --git a/docs/packs/premium_packs.md b/docs/packs/premium_packs.md deleted file mode 100644 index 0ef702f7b..000000000 --- a/docs/packs/premium_packs.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: premium_packs -title: Premium Packs Setup ---- - -In this document we explain step-by-step how to develop paid content for the XSOAR Marketplace. Learn about [paid packs overview](/docs/partners/premium-packs) and the [business process required](/docs/partners/premium-packs-process). - -1. Duplicate the [demisto/content-external-template](https://github.com/demisto/content-external-template) repository by clicking **Use this template** and select to create it as a private repository under your user. - -2. To get your pack in the template repository, follow the [guidelines](https://github.com/demisto/content-external-template#getting-started) provided in the template repository. Make sure you choose your pricing for the pack. -3. Next you will need to **open your pull request**: - - Make sure your work is done on a designated branch (not Master). This will help us conduct a proper review of the pack. - - After you finish the work on your pack you should invite the `xsoar-bot` user as a collaborator to your repository so that we will be able to review your contribution and add it to our build system. For more information, see [how to invite collaborators to a personal repo](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository). - - In your private repository [open a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) from the created branch → to the repo's Master/Main branch. - - When the pull request is ready for review, put `xsoar-bot` as assignee and add the label `ready-for-review`. At this point we might ask you to invite and assign someone from the XSOAR content team members to review the pull request. -4. After we receive your pack, it enters the ***Review Phase***, in which we review your pull request and provide feedback/comments. In parallel to the review, we perform an internal validation process for your pack. In order to approve your pull request, the following criteria must be satisfied: - - Pull request build must pass. - - Implement all feedback/comments that we provide in the pull request. - - Internal validation process must pass. If the validation process fails, we will update you and explain why it failed. -5. After we approve your pull request, you can merge the pull request. -The pack is now officially available to download in Cortex XSOAR Marketplace! diff --git a/docs/partners/adopt.md b/docs/partners/adopt.md index fd00e2a3c..82964a2c7 100644 --- a/docs/partners/adopt.md +++ b/docs/partners/adopt.md @@ -166,38 +166,29 @@ Follow the steps below to adopt using the a text editor or IDE. For additional g Make sure you change the `MONTH`, `DAY`, and `YEAR` to the appropriate date that is 90 days from your submission date. - - -2. Next, open the `pack_metadata.json` file and update the following sections: - - - `support` - must say `partner` - - `author` - must say your company name - - `url` - must be changed to your company’s support site - - `email` - must be your company's support email. - -3. Once everything is updated, save your changes and run the `demisto-sdk update-release-notes -i -f`. The command output will instruct you to open the newly-created release note. Find the file and open it. +2. Once everything is updated, save your changes and run the `demisto-sdk update-release-notes -i -f`. The command output will instruct you to open the newly-created release note. Find the file and open it. -4. Replace the `%%RN%%` placeholder with the following text: +3. Replace the `%%RN%%` placeholder with the following text: ``` - Started adoption process. ``` -5. Go to _Source Control_ tab and commit the changes. Click on the _Publish Branch_ button. This will open a Pull Request. +4. Go to _Source Control_ tab and commit the changes. Click on the _Publish Branch_ button. This will open a Pull Request. -6. Fill out the pull request details and create the pull request. +5. Fill out the pull request details and create the pull request. **After 90 days** Please follow the steps below to complete the adoption process: -7. Open the `README.md` file and update the top of the file with the following: +6. Open the `README.md` file and update the top of the file with the following: ``` Note: Support for this Pack moved to the partner on MONTH, DAY, YEAR. Please contact the partner directly via the support link on the right. ``` -8. Open the `pack_metadata.json` file and update the following sections: +7. Open the `pack_metadata.json` file and update the following sections: - `support` - must say “partner” @@ -209,7 +200,7 @@ Follow the steps below to adopt using the a text editor or IDE. For additional g - Also, update your Author image using the [Author image instructions](https://xsoar.pan.dev/docs/packs/packs-format#author_imagepng). -9. Repeat step 3 through 6 in the previous section. Replace the `%%RN%%` placeholder with the following text: +9. Repeat step 3 in the previous section. Replace the `%%RN%%` placeholder with the following text: ``` - Completed adoption process. @@ -344,4 +335,4 @@ Follow the below steps to complete the adoption process:
-Once the Cortex XSOAR engineering team merges your Pull Request, you will have successfully adopted your pack! \ No newline at end of file +Once the Cortex XSOAR engineering team merges your Pull Request, you will have successfully adopted your pack!