Skip to content

DOCS-1098 - Docs templates - standardize app/source intros with Sumo Logic naming #5866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2025
Merged

DOCS-1098 - Docs templates - standardize app/source intros with Sumo Logic naming #5866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99a4029
Docs templates - standardize app/source intros with Sumo Logic naming
kimsauce Oct 2, 2025
4ae91dc
grammar fixes
kimsauce Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/contributing/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 10 additions & 2 deletions docs/contributing/templates/app-template-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@ description: Description goes here. #example: The Sumo Logic App for Split enabl

import useBaseUrl from '@docusaurus/useBaseUrl';

/Introduction/
<head>
<meta name="robots" content="noindex" />
</head>

\Introduction\

<!-- RULE: Always start with "The Sumo Logic app for [vendor]" in both the description (frontmatter) and the intro paragraph to ensure brand visibility and consistency with "[vendor] by Sumo Logic" in the UI. The exact wording after that can be adapted. This example shows a common structure, but you may rephrase to fit the use case. -->

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

Expand Down Expand Up @@ -108,4 +116,4 @@ import AppUpdate from '../../reuse/apps/app-update.md';

import AppUninstall from '../../reuse/apps/app-uninstall.md';

<AppUninstall/>
<AppUninstall/>
4 changes: 2 additions & 2 deletions docs/contributing/templates/c2c-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`.
<!-- RULE: Always start with "The Sumo Logic source for [vendor]" in both the description (frontmatter) and the intro paragraph. This ensures brand clarity since the UI shows only the vendor name. The exact wording after that can be adapted. This example shows a common structure, but you may rephrase to fit the use case. -->

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.\

Expand Down