Common readme update for multiple integrations as per new format #19280

vrajpatel-crest · 2024-12-18T10:49:35Z

What does this PR do?

Common readme update for multiple integrations as per new format

Motivation

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

…_endpoint integration

…integrations

…s://github.com/bhargavnariyanicrest/integrations-core into common-readme-update-for-multiple-integrations

…ions

dpoint01 · 2024-12-18T18:13:03Z

ringcentral/README.md


-### The integration collects:
+[RingCentral][5] is a leading cloud-based communication and collaboration platform for businesses. It offers services such as voice, messaging, and video conferencing, seamlessly integrating with various business applications. Known for its reliability, security, and scalability, RingCentral enhances communication efficiency and collaboration.


remove: "Known for its reliability, security, and scalability, RingCentral enhances communication efficiency and collaboration."

dpoint01 · 2024-12-18T18:13:54Z

ringcentral/README.md

-#### Metrics for:
- Voice (Analytics)
- A2P SMS
+The RingCentral integration seamlessly collects voice and audit logs, as well as Voice (Analytics) and A2P SMS metrics, and sends them to Datadog for comprehensive analysis.


remove "seamlessly" since It's being overused across all configs already.

dpoint01 · 2024-12-18T18:16:11Z

trend_micro_email_security/README.md

@@ -4,16 +4,14 @@

 This integration ingests the following logs:

- Policy events and detection
- Mail tracking
+- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.


Suggested change

- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.

- Policy events and detection - These logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.

dpoint01 · 2024-12-18T18:16:29Z

trend_micro_email_security/README.md

- Policy events and detection
- Mail tracking
+- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.
+- Mail tracking - This logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.


Suggested change

- Mail tracking - This logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.

- Mail tracking - These logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.

rtrieu

Left feedback primarily around style consistency.

rtrieu · 2024-12-18T19:42:06Z

cisco_secure_email_threat_defense/README.md

+
+    | Parameters | Description |
+    | ---------- | ----------- |
+    | Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |


Suggested change

| Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |

| Host Name | Host name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |

rtrieu · 2024-12-18T19:42:18Z

cisco_secure_email_threat_defense/README.md

+    | Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |
+    | Client Password | Client Password from Cisco Secure Email Threat Defense Account |
+    | API Key | API Key from Cisco Secure Email Threat Defense Account |


rtrieu · 2024-12-18T19:42:34Z

cisco_secure_email_threat_defense/README.md

+    | ---------- | ----------- |
+    | Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |
+    | Client Password | Client Password from Cisco Secure Email Threat Defense Account |


rtrieu · 2024-12-18T19:44:31Z

cisco_secure_email_threat_defense/README.md

+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |
+    | Client Password | Client Password from Cisco Secure Email Threat Defense Account |
+    | API Key | API Key from Cisco Secure Email Threat Defense Account |
+    | Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay |


Suggested change

| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay |

| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay. |

rtrieu · 2024-12-18T19:44:52Z

cisco_secure_endpoint/README.md

@@ -12,12 +12,8 @@ The Cisco Secure Endpoint integration provides out-of-the-box dashboards so you

 ## Setup

-### Configuration
+### Generate API Credentials in Cisco Secure Endpoint 


Suggested change

### Generate API Credentials in Cisco Secure Endpoint

### Generate API credentials in Cisco Secure Endpoint

rtrieu · 2024-12-18T20:17:58Z

trend_micro_vision_one_endpoint_security/README.md

+1. Add your API Host, Application ID, API Key and select the Time Zone from the dropdown.
+   | Parameters     | Description                                                             |
+   | -------------- | ----------------------------------------------------------------------- |
+   | API Host       | The API Host of Trend Micro Vision One Endpoint Security console.       |


rtrieu · 2024-12-18T20:18:44Z

trend_micro_vision_one_endpoint_security/README.md

+   | Parameters     | Description                                                             |
+   | -------------- | ----------------------------------------------------------------------- |
+   | API Host       | The API Host of Trend Micro Vision One Endpoint Security console.       |
+   | Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |


rtrieu · 2024-12-18T20:18:54Z

trend_micro_vision_one_endpoint_security/README.md

+   | -------------- | ----------------------------------------------------------------------- |
+   | API Host       | The API Host of Trend Micro Vision One Endpoint Security console.       |
+   | Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |
+   | API Key        | The API Key of of Trend Micro Vision One Endpoint Security console.     |


rtrieu · 2024-12-18T20:19:02Z

trend_micro_vision_one_endpoint_security/README.md

+   | API Host       | The API Host of Trend Micro Vision One Endpoint Security console.       |
+   | Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |
+   | API Key        | The API Key of of Trend Micro Vision One Endpoint Security console.     |
+   | Time Zone      | The Time Zone of the Trend Micro Vision One console.                    |


rtrieu · 2024-12-18T20:19:12Z

trend_micro_vision_one_endpoint_security/README.md

- Application ID
- API Key
- Time Zone (This timezone should be the same as the Trend Vision One console.)
+2. Click the Save button to save your settings.


Suggested change

2. Click the Save button to save your settings.

2. Click the **Save** button to save your settings.

rtrieu · 2024-12-18T20:21:03Z

cisco_secure_email_threat_defense/README.md

+    | Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay |
+
+
+2. Click the Save button to save your settings.


Suggested change

2. Click the Save button to save your settings.

2. Click the **Save** button to save your settings.

…ions

rtrieu

Found a few more things!

rtrieu · 2024-12-23T17:09:55Z

cisco_secure_email_threat_defense/README.md

+    | Parameters | Description |
+    | ---------- | ----------- |
+    | Host Name | Host name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |


rtrieu · 2024-12-23T17:10:01Z

cisco_secure_email_threat_defense/README.md

+    | ---------- | ----------- |
+    | Host Name | Host name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |
+    | Client Password | Client password from your Cisco Secure Email Threat Defense Account. |


rtrieu · 2024-12-23T17:10:08Z

cisco_secure_email_threat_defense/README.md

+    | Host Name | Host name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |
+    | Client Password | Client password from your Cisco Secure Email Threat Defense Account. |
+    | API Key | API key from your Cisco Secure Email Threat Defense Account. |


rtrieu · 2024-12-23T17:10:17Z

cisco_secure_email_threat_defense/README.md

+    | Client ID | Client ID from Cisco Secure Email Threat Defense Account |
+    | Client Password | Client password from your Cisco Secure Email Threat Defense Account. |
+    | API Key | API key from your Cisco Secure Email Threat Defense Account. |
+    | Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay. |


Suggested change

| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay. |

| Verdict Delay | Events are fetched with a delay according to the time (in minutes) specified in the Verdict Delay. |

surabhipatel-crest and others added 17 commits December 12, 2024 17:02

Updated readme format

64d6520

update hubspot-content-hub readme

f09b6dd

update shopify readme

d0d0371

update StreamNative readme

5257e38

Update Trend Micro integrations README

da28435

Update: Readme for cisco_secure_email_threat_defense and cisco_secure…

5b4a484

…_endpoint integration

Merge branch 'DataDog:master' into common-readme-update-for-multiple-…

38d8a02

…integrations

Contentful README.md modified

8040b83

Incident.io README.md modified

f5257d2

LastPass README.md format changed

64b9177

MUX README.md format changed

3ccf830

README changed for lastpass & mux

92da55d

Updated Readme of pingone

6b27d93

Merge branch 'common-readme-update-for-multiple-integrations' of http…

f26410b

…s://github.com/bhargavnariyanicrest/integrations-core into common-readme-update-for-multiple-integrations

format StreamNative readme

5000254

updated readme

db1a83d

Added minor changes

d395341

vrajpatel-crest requested review from a team as code owners December 18, 2024 10:49

datadog-assets bot added docs/review-requested ecosystems/review-requested product/review-requested labels Dec 18, 2024

Merge branch 'master' into common-readme-update-for-multiple-integrat…

6450516

…ions

dpoint01 reviewed Dec 18, 2024

View reviewed changes

rtrieu self-requested a review December 18, 2024 19:50

rtrieu requested changes Dec 18, 2024

View reviewed changes

datadog-assets bot added the docs/requested-changes label Dec 18, 2024

datadog-assets bot removed the docs/review-requested label Dec 18, 2024

rtrieu reviewed Dec 18, 2024

View reviewed changes

updated readme as per review comments

3388bc0

vrajpatel-crest requested review from rtrieu and dpoint01 December 20, 2024 13:28

Merge branch 'master' into common-readme-update-for-multiple-integrat…

ba2fd47

…ions

dpoint01 previously approved these changes Dec 23, 2024

View reviewed changes

rtrieu requested changes Dec 23, 2024

View reviewed changes

Updated Readme as per PR comments

7caabb0

DhruvaPatel-crest dismissed dpoint01’s stale review via 7caabb0 December 24, 2024 06:33

vrajpatel-crest requested a review from rtrieu December 24, 2024 06:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Common readme update for multiple integrations as per new format #19280

Common readme update for multiple integrations as per new format #19280

vrajpatel-crest commented Dec 18, 2024

dpoint01 Dec 18, 2024

dpoint01 Dec 18, 2024

dpoint01 Dec 18, 2024

dpoint01 Dec 18, 2024

rtrieu left a comment

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu Dec 18, 2024

rtrieu left a comment

rtrieu Dec 23, 2024

rtrieu Dec 23, 2024

rtrieu Dec 23, 2024

rtrieu Dec 23, 2024


		### The integration collects:
		[RingCentral][5] is a leading cloud-based communication and collaboration platform for businesses. It offers services such as voice, messaging, and video conferencing, seamlessly integrating with various business applications. Known for its reliability, security, and scalability, RingCentral enhances communication efficiency and collaboration.

	- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.
	- Policy events and detection - These logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.

	- Mail tracking - This logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.
	- Mail tracking - These logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.

	\| Host Name \| Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. \|
	\| Host Name \| Host name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. \|

	\| API Key \| API Key from Cisco Secure Email Threat Defense Account \|
	\| API Key \| API key from your Cisco Secure Email Threat Defense Account. \|

	\| Client Password \| Client Password from Cisco Secure Email Threat Defense Account \|
	\| Client Password \| Client password from your Cisco Secure Email Threat Defense Account. \|

	\| Verdict Delay \| Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay \|
	\| Verdict Delay \| Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay. \|

	### Generate API Credentials in Cisco Secure Endpoint
	### Generate API credentials in Cisco Secure Endpoint

	\| API Host \| The API Host of Trend Micro Vision One Endpoint Security console. \|
	\| API Host \| The API host of Trend Micro Vision One Endpoint Security console. \|

	\| Application ID \| The Application ID of Trend Micro Vision One Endpoint Security console. \|
	\| Application ID \| The application ID of Trend Micro Vision One Endpoint Security console. \|

	\| API Key \| The API Key of of Trend Micro Vision One Endpoint Security console. \|
	\| API Key \| The API key of of Trend Micro Vision One Endpoint Security console. \|

	\| Time Zone \| The Time Zone of the Trend Micro Vision One console. \|
	\| Time Zone \| The time zone of the Trend Micro Vision One console. \|

	2. Click the Save button to save your settings.
	2. Click the Save button to save your settings.

	\| Client ID \| Client ID from Cisco Secure Email Threat Defense Account \|
	\| Client ID \| Client ID from Cisco Secure Email Threat Defense account \|

Common readme update for multiple integrations as per new format #19280

Are you sure you want to change the base?

Common readme update for multiple integrations as per new format #19280

Conversation

vrajpatel-crest commented Dec 18, 2024

What does this PR do?

Motivation

Review checklist (to be filled by reviewers)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rtrieu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rtrieu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment