diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 871570c408..d274367466 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -1085,7 +1085,17 @@ tags: [metrics, traces] For a full list of options, see [Docusaurus Markdown front matter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter). +### Branding and naming in app/source docs +To ensure consistency between our UI and our documentation, every App and Source doc must begin by clearly identifying it as a Sumo Logic integration. The UI often shows only the vendor name (for example, "Slack", "Amazon S3"), so the documentation must reinforce that Sumo Logic is delivering the integration. + +* **App docs**. The `description:` frontmatter and intro paragraph must start with: "The Sumo Logic app for [vendor]..." (see [template](/docs/contributing/templates/app-template-v2)). +* **Source docs**. The `description:` frontmatter and intro paragraph must start with: "The Sumo Logic source for [vendor]..." (see [template](/docs/contributing/templates/c2c-source)). + +This rule helps: +* Align docs with UI naming ("[vendor] by Sumo Logic”). +* Reinforce Sumo Logic as the provider of the integration. +* Prevent ambiguity that suggests the vendor is the owner of the app/source. ## Navigation menus diff --git a/docs/contributing/templates/app-template-v2.md b/docs/contributing/templates/app-template-v2.md index 86aa083ac2..eecb3d04da 100644 --- a/docs/contributing/templates/app-template-v2.md +++ b/docs/contributing/templates/app-template-v2.md @@ -11,7 +11,15 @@ description: Description goes here. #example: The Sumo Logic App for Split enabl import useBaseUrl from '@docusaurus/useBaseUrl'; -/Introduction/ + + + + +\Introduction\ + + + +The Sumo Logic app for [vendor] enables you to [monitor/analyze/collect/etc.] [data type] from [vendor]. This integration helps you [business value/security/performance outcome], providing visibility into [specific activities, events, or metrics]. With this data in Sumo Logic, you can [identify/respond to/optimize/etc.] [key use cases]. ## Data collected @@ -108,4 +116,4 @@ import AppUpdate from '../../reuse/apps/app-update.md'; import AppUninstall from '../../reuse/apps/app-uninstall.md'; - \ No newline at end of file + diff --git a/docs/contributing/templates/c2c-source.md b/docs/contributing/templates/c2c-source.md index 2eb2469d8a..38b64661a3 100644 --- a/docs/contributing/templates/c2c-source.md +++ b/docs/contributing/templates/c2c-source.md @@ -20,9 +20,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; \Introduction\ -The `{{source name}}` collects `{{data/event types}}` from `{{source of origin}}`. `{{What the app does}}`. + -Example: The Microsoft Graph Security API Source provides a secure endpoint to consume alerts from the Microsoft Graph Security API endpoint. It securely stores the required authentication, scheduling, and state tracking information. One threat event is reported for each affected device. +The Sumo Logic source for [vendor] enables you to [collect/ingest/stream/etc.] [data type] from [vendor] into Sumo Logic. This integration helps you [business value/security/observability outcome], providing visibility into [specific activities, events, or metrics]. With this data in Sumo Logic, you can [detect/respond/optimize/etc.] [key use cases]. \Depending on the availability in the Fed, add the below note.\