chore: README and related files update

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -107,7 +107,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
@@ -128,5 +128,4 @@ For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
 https://www.contributor-covenant.org/translations.
 
-
----
+---

README.md

@@ -5,19 +5,44 @@
 The Triage with MITRE Attack sample Foundry app is a community-driven, open source project which serves as an example of an app which can be built using CrowdStrike's Foundry ecosystem.
 `foundry-sample-mitre` is not a formal CrowdStrike project and is maintained by the open source developer community.
 
-# CrowdStrike Triage with MITRE ATT&CK
+This app is one of several App Templates included in Foundry that you can use to jumpstart your development.
+It comes complete with a set of preconfigured capabilities aligned to its business purpose.
 
-This folder contains all the projects and the configuration for the `mitre` sample app (vue).
-In here you can find, **collections**, **ui** and the apps' `manifest.yml`.
+## Description
 
-**collections** are used for some components inside the extension and main app, the projects are stored inside `ui`
+The CrowdStrike Triage for MITRE ATT&CK app provides SOC analysts with a focused, MITRE-prioritized view of their XDR detections and enables both automated and manual remediation actions.
 
-In `ui` you can find:
+This app provides a filtered dashboard for the existing Falcon console Detections page, helping users focus on a manageable set of detections.
 
-- **extensions**: contains `remediations` app
-- **pages**: contains `chart-vue` which is the Mitre's chart page done with vue
+You can use this app to configure automated and manual actions for specific tactics and techniques.
 
-_while `remediations` and `chart-vue` are **vue projects**, all related with one another, it's **worth noticing** that you can add other projects with other technologies, completely un-related with the forementioned._
+## Basic information
+
+### Dependencies
+
+- Foundry CLI
+- Go v1.21+ (needed if modifying functions). See https://go.dev/learn/ for instructions to install.
+- YARN (needed if modifying UI). See https://yarnpkg.com/getting-started for instructions to install.
+
+### Foundry capabilities used
+
+- **Collections.** Used by the app to store JIRA configuration for response actions and the history of issues created from the app.
+- **UI navigation.** Adds the app to the Falcon navigation for easy access.
+- **UI pages.** Custom UI pages to display results and manage the app.
+- **UI extensions.** UI extension that is configured to run in a socket on the Detections page of the Falcon console.
+
+### Languages and frameworks used
+
+- UI
+  - HTML, CSS
+  - Typescript, Vue
+
+### Directory structure
+
+- `collections`. Schemas used in the collections used by this app.
+- `ui/pages/chart-vue`. Single Page Application which serves as the frontend of the app.
+- `ui/extensions/remediations`. Single Page Application which serves as the extension mounted in the Detections page of the Falcon console.
+- `shared/mitre-vue`. Utility code and components shared between the `ui/pages/chart-vue` and `ui/extensions/remediations`.
 
 ## Development
 
@@ -33,21 +58,36 @@ With the following, you should be able to start and develop all of the projects
 3. Concurrently, run `foundry ui run`.
 4. now you are ready to test your changes with local code (remember to turn on "development mode"
 
-### If you are developing a page
+## Deploying and installing the app
+
+For detailed info about deploying and installing this app in your CID, see the Falcon Foundry product documentation:
 
-1. Search the page id id in the `manifest.yml`, copy it.
-2. Go to `foundry/page/{{page-id}}` (**note**: replace `{{page-id}}` with the one you find in the manifest.)
-3. be sure that the **development** mode is active, or you will be seeing the current "deployed" page
+- Deploy an app
+  - US-1: [Deploy an app](https://falcon.crowdstrike.com/documentation/page/ofd46a1c/deploy-an-app)
+  - US-2: [Deploy an app](https://falcon.us-2.crowdstrike.com/documentation/page/ofd46a1c/deploy-an-app)
+  - EU-1: [Deploy an app](https://falcon.eu-1.crowdstrike.com/documentation/page/ofd46a1c/deploy-an-app)
+- Create a new app using this app as template
+  - US-1: [Create an app from a template](https://falcon.crowdstrike.com/documentation/page/l159717b/create-an-app#c4378b86)
+  - US-2: [Create an app from a template](https://falcon.us-2.crowdstrike.com/documentation/page/l159717b/create-an-app#c4378b86)
+  - EU-1: [Create an app from a template](https://falcon.eu-1.crowdstrike.com/documentation/page/l159717b/create-an-app#c4378b86)
+- Run this app in development mode after deployment
+  - US-1: [Iterate in development mode](https://falcon.crowdstrike.com/documentation/page/fb88e442/view-and-manage-apps#d5175ae2)
+  - US-2: [Iterate in development mode](https://falcon.us-2.crowdstrike.com/documentation/page/fb88e442/view-and-manage-apps#d5175ae2)
+  - EU-1: [Iterate in development mode](https://falcon.eu-1.crowdstrike.com/documentation/page/fb88e442/view-and-manage-apps#d5175ae2)
+- Work with the Foundry capabilities of this app
+  - US-1: [App capabilities](https://falcon.crowdstrike.com/documentation/category/u0daabab/app-capabilities)
+  - US-2: [App capabilities](https://falcon.us-2.crowdstrike.com/documentation/category/u0daabab/app-capabilities)
+  - EU-1: [App capabilities](https://falcon.eu-1.crowdstrike.com/documentation/category/u0daabab/app-capabilities)
 
-### If you are developing an extension
+## Foundry resources
 
-1. Go to the page where your extension is mounted.
-2. be sure that the **development** mode is active, or you will be seeing the current "deployed" extension
+See our product documentation:
 
-## Hands-on projects
+- US-1: [Falcon Foundry](https://falcon.crowdstrike.com/documentation/category/c3d64B8e/falcon-foundry)
+- US-2: [Falcon Foundry](https://falcon.us-2.crowdstrike.com/documentation/category/c3d64B8e/falcon-foundry)
+- EU-1: [Falcon Foundry](https://falcon.eu-1.crowdstrike.com/documentation/category/c3d64B8e/falcon-foundry)
 
-You can find more about the specific projects and libraries with the following links:
+---
 
-- [Mitre chart (vue)](./ui//pages/chart-vue/README.md)
-- [Auto remediation extension](./ui/extensions/remediations/README.md)
-- [Mitre's shared vue logic](./ui/shared/mitre-vue/README.md)
+<p align="center"><img src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo-footer.png"><BR/><img width="300px" src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-goblin-panda.png"></P>
+<h3><P align="center">WE STOP BREACHES</P></h3>

SECURITY.md

@@ -11,17 +11,12 @@ As mentioned in [SUPPORT](https://github.com/CrowdStrike/foundry-sample-mitre/bl
 
 Please report suspected security vulnerabilities by:
 
-+ Submitting
+- Submitting
   a [bug](https://github.com/CrowdStrike/foundry-sample-mitre/issues/new?assignees=&labels=bug+%3Abug%3A&template=bug_report.md&title=%5B+BUG+%5D+...).
-+ Starting a new [discussion](https://github.com/CrowdStrike/foundry-sample-mitre/discussions).
-+ Submitting a [pull request](https://github.com/CrowdStrike/foundry-sample-mitre/pulls) to potentially resolve the issue. (New
+- Submitting a [pull request](https://github.com/CrowdStrike/foundry-sample-mitre/pulls) to potentially resolve the issue. (New
   contributors: please review the content
   located [here](https://github.com/CrowdStrike/foundry-sample-mitre/blob/main/CONTRIBUTING.md).)
-+ Sending an email to __[email protected]__.
-
-## Disclosure and mitigation process
-
-TODO !!!
+- Sending an email to __[email protected]__.
 
 ---
 

SUPPORT.md

@@ -16,29 +16,24 @@ Whenever possible, please try to format issues and questions in the [**M**inimal
 MCVE formatted code examples provided within issues or questions should be:
 
 - _**Minimal**_: Provide as little as code as possible to produce the problem.
-    - Only provide the [statements required](https://matthewrocklin.com/minimal-bug-reports#see-how-small-you-can-make-things) to create an example of the issue.
-    - Use simple, descriptive names for functions and variables. Don't just copy your existing code.
-    - [Do not include real data](https://matthewrocklin.com/minimal-bug-reports#don-t-post-data). [Mock data examples](https://matthewrocklin.com/minimal-bug-reports#actually-don-t-include-your-data-at-all) to describe the format used, but do not provide real values.
+  - Only provide the [statements required](https://matthewrocklin.com/minimal-bug-reports#see-how-small-you-can-make-things) to create an example of the issue.
+  - Use simple, descriptive names for functions and variables. Don't just copy your existing code.
+  - [Do not include real data](https://matthewrocklin.com/minimal-bug-reports#don-t-post-data). [Mock data examples](https://matthewrocklin.com/minimal-bug-reports#actually-don-t-include-your-data-at-all) to describe the format used, but do not provide real values.
 - _**Complete**_: Provide all the necessary programmatic pieces to recreate the issue.
-    - Do _**not**_ provide screenshots of code.
-    - Use `code blocks` for each file or snippet. Include a description with each block.
-    - Provide all error messages received, including the [complete traceback](https://matthewrocklin.com/minimal-bug-reports#provide-complete-tracebacks).
+  - Do _**not**_ provide screenshots of code.
+  - Use `code blocks` for each file or snippet. Include a description with each block.
+  - Provide all error messages received, including the [complete traceback](https://matthewrocklin.com/minimal-bug-reports#provide-complete-tracebacks).
 - _**Reproducible**_: Provide code that reliably reproduces the problem.
-    - Provide as much detail regarding the problem as possible.
-    - Test your example to make sure it produces consistent results.
+  - Provide as much detail regarding the problem as possible.
+  - Test your example to make sure it produces consistent results.
 
 > To read more about _MCVE format_, review this post on [Stack Overflow](https://stackoverflow.com/help/minimal-reproducible-example). For tips on how to properly format questions, check out the blog post by [@mrocklin](https://github.com/mrocklin/) on [crafting minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
 
 [![Report Issue](https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/report-issue.png)](https://github.com/CrowdStrike/foundry-sample-mitre/issues/new/choose)
 
 ### Support Escalation
 
-In generally, CrowdStrike will support `foundry-sample-mitre` at only the bare minimum level and only in unusual or niche cases.
-CrowdStrike will ultimately defer the support of this project to the open source community.
-
-#### Out of Scope Issues
-
-Depending on the root cause, there is a possibility that an identified issue exceeds the scope of this project, and may require additional investigation. A maintainer may ask you to [contact the CrowdStrike technical support team](https://supportportal.crowdstrike.com/) directly should this occur.
+`foundry-sample-mitre` is an open source project, not a CrowdStrike product. As such, it carries no formal support, expressed or implied.
 
 #### Confidentiality
 
@@ -50,10 +45,7 @@ There are also situations where aspects of a support concern cannot be discussed
 
 _MCVE format_ is designed to reduce the potential for encountering confidentiality concerns while describing your issue, but cannot speak to every scenario. If one of these concerns impacts your ability to post an issue to this repository, please [contact the CrowdStrike technical support team](https://supportportal.crowdstrike.com/) directly making sure to highlight the concern as part of your support request.
 
-
-
 ---
 
-
 <p align="center"><img src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo-footer.png"><BR/><img width="300px" src="https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/adversary-bear-1.png"></P>
-<h3><P align="center">WE STOP BREACHES</P></h3>
+<h3><P align="center">WE STOP BREACHES</P></h3>