Skip to content

Commit 4ae91dc

Browse files
committed
grammar fixes
1 parent 99a4029 commit 4ae91dc

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/contributing/style-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1089,13 +1089,13 @@ For a full list of options, see [Docusaurus Markdown front matter](https://docus
10891089
10901090
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.
10911091
1092-
* **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)).
1093-
* **Source docs**. The `description:` frontmatter and intro paragraph must start with: "The Sumo Logic source for <vendor>..." (see [template](/docs/contributing/templates/c2c-source)).
1092+
* **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)).
1093+
* **Source docs**. The `description:` frontmatter and intro paragraph must start with: "The Sumo Logic source for [vendor]..." (see [template](/docs/contributing/templates/c2c-source)).
10941094
10951095
This rule helps:
1096-
* Align docs with UI naming ("<vendor> by Sumo Logic”)
1097-
* Reinforce Sumo Logic as the provider of the integration
1098-
* Prevent ambiguity that suggests the vendor is the owner of the app/source
1096+
* Align docs with UI naming ("[vendor] by Sumo Logic”).
1097+
* Reinforce Sumo Logic as the provider of the integration.
1098+
* Prevent ambiguity that suggests the vendor is the owner of the app/source.
10991099
11001100
## Navigation menus
11011101

docs/contributing/templates/app-template-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1717

1818
\Introduction\
1919

20-
<!-- 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. -->
20+
<!-- 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. -->
2121

2222
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].
2323

docs/contributing/templates/c2c-source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
2020

2121
\Introduction\
2222

23-
<!-- 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. -->
23+
<!-- 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. -->
2424

25-
Example: 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].
25+
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].
2626

2727
\Depending on the availability in the Fed, add the below note.\
2828

0 commit comments

Comments
 (0)