Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 9 additions & 13 deletions .claude/commands/release-note-collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
#### Installed Collector Release Structure

```markdown
In this release, we've enhanced the security and stability of the Collector with added support for security patches.
This release includes security and stability fixes.

#### Security fix

Expand All @@ -136,17 +136,17 @@ In this release, we've enhanced the security and stability of the Collector with
```

**Installed Collector Guidelines:**
* Start with standard intro: "In this release, we've enhanced the security and stability of the Collector with added support for {security patches/bug fixes/features}."
* Start with a direct intro: "This release includes {security patches/bug fixes/features}."
* Use H4 (`####`) for section headings: Security fix, Bug fix, Feature
* List items use bullet points with dashes.
* Include specific version numbers for dependencies.
* Reference CVE numbers when applicable (format: CVE-YYYY-NNNNN or GHSA-XXXX-XXXX-XXXX)
* Keep descriptions concise (one sentence per item).
* Order: Security fixes first, then bug fixes, then features
* For everything else (voice, conciseness), follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide.

**Example:**
```markdown
In this release, we've enhanced the security and stability of the Collector with added support for security patches.
This release includes security and stability fixes.

#### Security fix

Expand All @@ -161,7 +161,7 @@ In this release, we've enhanced the security and stability of the Collector with
#### OpenTelemetry Release Structure

```markdown
We're excited to {announce/introduce} {feature description}. {What it does and benefits}. [Learn more](/docs/path/to/doc).
{Feature name} {is now available / now supports X / now includes Y}. {What it does and benefits}. [Learn more](/docs/path/to/doc).

{Optional: Additional paragraphs with more details}

Expand All @@ -171,26 +171,22 @@ We're excited to {announce/introduce} {feature description}. {What it does and b
```

**OpenTelemetry Guidelines:**
* Start with "We're excited to announce..." or "We're excited to introduce...".
* Write 2-3 sentences in first paragraph.
* Focus on user benefits and business value.
* End first paragraph with "Learn more" link.
* Follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide for voice, conciseness, and "Learn more" links.
* Can include additional paragraphs for context.
* Use relative paths for documentation links (start with `/docs/`).
* Add admonitions for important notes or breaking changes.

**Example (Feature announcement):**
```markdown
import useBaseUrl from '@docusaurus/useBaseUrl';

We're excited to announce that you can now convert Installed Collector (IC) local file sources to OpenTelemetry (OTel) source templates for a more modern, scalable, and consistent data collection experience. This conversion helps future-proof your setup, making it easier to manage collectors at scale while benefiting from ongoing OTel improvements and support. [Learn more](/docs/send-data/installed-collectors/sources/convert-ic-local-file-source-to-otel-st/).
You can now convert Installed Collector (IC) local file sources to OpenTelemetry (OTel) source templates for a more modern, scalable, and consistent data collection experience. This conversion makes it easier to manage collectors at scale while benefiting from ongoing OTel improvements and support. [Learn more](/docs/send-data/installed-collectors/sources/convert-ic-local-file-source-to-otel-st/).
```

**Example (Infrastructure change):**
```markdown
import useBaseUrl from '@docusaurus/useBaseUrl';

We're excited to announce that the OpenTelemetry collector installation files can now be downloaded from a CDN for Chef, Puppet, and Ansible. This change improves download reliability, performance, and availability while maintaining the same installation experience.
OpenTelemetry collector installation files can now be downloaded from a CDN for Chef, Puppet, and Ansible. This change improves download reliability, performance, and availability while maintaining the same installation experience.

Refer to the following documentation to view the updated URLs in the UI.
* [Ansible](/docs/send-data/opentelemetry-collector/install-collector/ansible/).
Expand All @@ -215,7 +211,7 @@ Before finishing, verify:
* [ ] For installed: Sections use H4 (`####`), proper order (Security → Bug → Feature)
* [ ] For installed: Version numbers in **bold** format
* [ ] For installed: CVE/GHSA references included where applicable
* [ ] For OTel: Starts with "We're excited to..."
* [ ] For OTel: Opens with a direct statement, not an announcement phrase (see the [style guide](/docs/contributing/style-guide/#release-notes))
* [ ] For OTel: "Learn more" link included with relative path
* [ ] No trailing whitespace.

Expand Down
35 changes: 13 additions & 22 deletions .claude/commands/release-note-cse.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Examples:
**For Content Releases:**
```yaml
---
title: {Month} {Day}th, {Year} - Content Release
title: {Month} {Day}, {Year} - Content Release
hide_table_of_contents: true
keywords:
* rules
Expand Down Expand Up @@ -120,9 +120,9 @@ hide_table_of_contents: true
* Application releases: Feature-specific keywords (e.g., `insights`, `entities`, `signals`, `cloud siem`)
* User may want to add or modify keywords based on specific content

**Date formatting:**
* Use ordinal suffixes: "March 12th", "February 3rd", "January 21st"
* Full month name, not abbreviated.
**Title and date formatting:**
* `{Month} {D}, {Year} - Content Release` or `{Month} {D}, {Year} - Application Update`
* Follow the [style guide](/docs/contributing/style-guide/#release-notes) date format: full month name, no ordinal, no leading zero (`March 12, 2026`).

### Step 4: Add required import

Expand Down Expand Up @@ -177,37 +177,28 @@ Additional changes are enumerated below.

**Application Release Guidelines:**
* Use H3 (`###`) for each feature.
* Start with clear, concise description.
* Include "Learn more" link to relevant docs.
* Keep it brief (2-3 sentences per feature).
* Add screenshots using: `<img src={useBaseUrl('img/path')} alt="description" />`
* Highlight business value and user impact.
* For voice, conciseness, and "Learn more" links, follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide.

### Step 6: Format dates and titles

**Title formatting rules:**
* Month: Full name (March, not Mar)
* Day: Ordinal suffix (12th, 3rd, 21st)
* 1st, 2nd, 3rd.
* 4th-20th end in "th".
* 21st, 22nd, 23rd, 31st.
* 24th-30th end in "th".
* Year: Full 4 digits
* Type: "Content Release" or "Application Update"
Title format: `{Month} {D}, {Year} - Content Release` or `{Month} {D}, {Year} - Application Update`.

Dates follow the [style guide](/docs/contributing/style-guide/#release-notes): full month name, no ordinal, no leading zero.

Examples:
* ✅ "March 19th, 2026 - Content Release".
* ✅ "February 3rd, 2026 - Application Update".
* ✅ "March 19, 2026 - Content Release".
* ✅ "February 3, 2026 - Application Update".
* ❌ "Mar 19, 2026 - Content Release" (month abbreviated).
* ❌ "March 19 2026 - Content Release" (missing "th").
* ❌ "March 19th, 2026 - Content Release" (ordinal suffix).

### Step 7: Validation checklist

Before finishing, verify:
* [ ] File created in `/blog-cse/` directory (not `/docs/`).
* [ ] Filename follows pattern: `YYYY-MM-DD-{type}.md`
* [ ] Frontmatter complete with all required fields.
* [ ] Title formatted correctly with ordinal suffix.
* [ ] Title date formatted correctly (`Month D, YYYY`, no ordinal).
* [ ] `hide_table_of_contents: true` present
* [ ] Keywords appropriate for release type.
* [ ] `import useBaseUrl` statement included.
Expand All @@ -228,7 +219,7 @@ Claude:
1. Confirms date: 2026-03-19
2. Confirms type: Content Release
3. Creates: blog-cse/2026-03-19-content.md
4. Generates frontmatter with proper title: "March 19th, 2026 - Content Release"
4. Generates frontmatter with proper title: "March 19, 2026 - Content Release"
5. Adds summary section
6. Creates sections for Rules and Log Mappers
7. Formats with proper [New]/[Updated] tags
Expand Down
49 changes: 20 additions & 29 deletions .claude/commands/release-note-csoar.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Examples:
**For Content Release:**
```yaml
---
title: {Month DD, YYYY} - Content Release
title: {Month D, YYYY} - Content Release
hide_table_of_contents: true
image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082
keywords:
Expand All @@ -147,7 +147,7 @@ keywords:
**For Application Update:**
```yaml
---
title: {Month DD, YYYY} - Application Update
title: {Month D, YYYY} - Application Update
hide_table_of_contents: true
image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082
keywords:
Expand All @@ -157,12 +157,8 @@ keywords:
```

**Title formatting:**
* Start with full date: "Month DD, YYYY" (e.g., "June 05, 2024" or "March 06, 2026")
* Follow with " - Content Release" or " - Application Update"

**Date formatting:**
* Use full month name (January, February, March, etc.)
* Use zero-padded day (01, 05, 06, 08, not 1, 5, 6, 8)
* Start with the date, then " - Content Release" or " - Application Update" (e.g., "June 5, 2024 - Content Release")
* Dates follow the [style guide](/docs/contributing/style-guide/#release-notes): full month name, no ordinal, no leading zero

**Keywords:**
* **Always ask user to confirm keywords before creating file**
Expand All @@ -187,7 +183,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
**Content Release template:**
```markdown
---
title: June 05, 2024 - Content Release
title: June 5, 2024 - Content Release
hide_table_of_contents: true
image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082
keywords:
Expand All @@ -214,7 +210,7 @@ This release introduces new integrations, new playbooks, and several updates.
**Application Update template:**
```markdown
---
title: March 06, 2026 - Application Update
title: March 6, 2026 - Application Update
hide_table_of_contents: true
image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082
keywords:
Expand Down Expand Up @@ -253,6 +249,8 @@ Fixed an issue where [description of bug and fix].

### Step 7: Content formatting guidelines

Voice and wording follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide. The formatting below is specific to Cloud SOAR release notes.

## Content Release Formatting

#### Intro Paragraph
Expand Down Expand Up @@ -372,8 +370,8 @@ Fixed issues while selecting variables containing the period character in textar
**For Content Release:**
* [ ] File created in `/blog-csoar/` directory
* [ ] Filename is `YYYY-MM-DD-content-release.md`
* [ ] Title is "Month DD, YYYY - Content Release" (zero-padded day)
* [ ] Date uses full month name with zero-padded day (e.g., "June 05")
* [ ] Title is "Month D, YYYY - Content Release" (no ordinal, no leading zero)
* [ ] Date uses full month name, no leading zero (e.g., "June 5")
* [ ] Image URL: Standard Sumo Logic preview image
* [ ] Keywords: automation service, cloud soar, soar (three keywords)
* [ ] `hide_table_of_contents: true` is present
Expand All @@ -387,8 +385,8 @@ Fixed issues while selecting variables containing the period character in textar
**For Application Update:**
* [ ] File created in `/blog-csoar/` directory
* [ ] Filename is `YYYY-MM-DD-application-update.md`
* [ ] Title is "Month DD, YYYY - Application Update" (zero-padded day)
* [ ] Date uses full month name with zero-padded day (e.g., "March 06")
* [ ] Title is "Month D, YYYY - Application Update" (no ordinal, no leading zero)
* [ ] Date uses full month name, no leading zero (e.g., "March 6")
* [ ] Image URL: Standard Sumo Logic preview image
* [ ] Keywords: automation service, cloud soar (two keywords)
* [ ] `hide_table_of_contents: true` is present
Expand All @@ -412,7 +410,7 @@ Claude:
2. Confirms date: June 5, 2024
3. Creates: blog-csoar/2024-06-05-content-release.md
4. Generates frontmatter:
- title: "June 05, 2024 - Content Release"
- title: "June 5, 2024 - Content Release"
- image: Standard Sumo Logic preview image
- keywords: automation service, cloud soar, soar
5. Writes content with:
Expand All @@ -433,7 +431,7 @@ Claude:
3. Confirms release month: February
4. Creates: blog-csoar/2026-03-06-application-update.md
5. Generates frontmatter:
- title: "March 06, 2026 - Application Update"
- title: "March 6, 2026 - Application Update"
- keywords: automation service, cloud soar
6. Writes content with:
- H2: "## February release"
Expand Down Expand Up @@ -466,22 +464,15 @@ Cloud SOAR API docs:

## Date formatting rules

**Format: "Month DD, YYYY"**

Month names (full):
* January, February, March, April, May, June
* July, August, September, October, November, December

Day: Zero-padded two digits (use 01, 06, 08, 15... not 1, 6, 8)
Titles use the [style guide](/docs/contributing/style-guide/#release-notes) date format: `Month D, YYYY`, full month name, no ordinal, no leading zero.

**Examples:**
* ✅ March 06, 2026
* ✅ January 08, 2026
* ✅ March 6, 2026
* ✅ January 8, 2026
* ✅ December 31, 2025
* ✅ June 05, 2024
* ❌ March 6, 2026 (not zero-padded)
* ❌ March 6th, 2026 (has ordinal)
* ❌ Mar 06, 2026 (abbreviated month)
* ❌ March 06, 2026 (leading zero)
* ❌ March 6th, 2026 (ordinal)
* ❌ Mar 6, 2026 (abbreviated month)
* ❌ 2026-03-06 (wrong format)

## Release timing
Expand Down
24 changes: 9 additions & 15 deletions .claude/commands/release-note-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,7 @@ hide_table_of_contents: true
* Keep topic concise but descriptive

**Date formatting:**
* Use full month name (January, February, March, etc.)
* Use day without ordinal suffix (1, 9, 23, not 1st, 9th, 23rd)
* Format: "Month Day, YYYY"
* `Month D, YYYY`, per the [style guide](/docs/contributing/style-guide/#release-notes): full month name, no ordinal, no leading zero.

**Image:**
* Always use the standard Sumo Logic preview image
Expand Down Expand Up @@ -156,6 +154,8 @@ hide_table_of_contents: true

### Step 6: Content formatting guidelines

Follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide for voice, conciseness, and "Learn more" links. The guidance below is only what is specific to developer release notes.

#### API Changes

For API announcements, include:
Expand All @@ -172,7 +172,7 @@ image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-cente
hide_table_of_contents: true
---

We're excited to announce new API endpoints for managing Field Extraction Rules (FERs) programmatically. These endpoints enable you to create, update, delete, and list FERs via the REST API, making it easier to automate and scale your field extraction configurations.
New API endpoints for managing Field Extraction Rules (FERs) are now available. These endpoints enable you to create, update, delete, and list FERs via the REST API, making it easier to automate and scale your field extraction configurations.

#### New endpoints

Expand Down Expand Up @@ -203,7 +203,7 @@ keywords:
- python
---

We've released version 2.0 of the Sumo Logic Python SDK with support for the latest APIs and improved error handling.
Sumo Logic Python SDK version 2.0 is now available, with support for the latest APIs and improved error handling.

#### What's new

Expand Down Expand Up @@ -286,7 +286,7 @@ image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-cente
hide_table_of_contents: true
---

We've made the following improvements to our APIs:
The following API improvements are now available:

* **Audit logging**: When performing create, update, and delete requests through Sumo Logic APIs, the API accessID is now included within the operator field of your related [Audit Event Index](/docs/manage/security/audit-indexes/audit-event-index) messages.
* **Search Job API**: Now returns query execution statistics in response headers for better monitoring and debugging.
Expand Down Expand Up @@ -352,19 +352,13 @@ Claude:

## Date formatting rules

**Format: "Month Day, YYYY"**

Month names (full):
* January, February, March, April, May, June
* July, August, September, October, November, December

Day: No ordinal suffix (use 1, 2, 3... not 1st, 2nd, 3rd)
Titles use the [style guide](/docs/contributing/style-guide/#release-notes) date format: `Month D, YYYY`, full month name, no ordinal, no leading zero.

**Examples:**
* ✅ March 23, 2026
* ✅ January 1, 2026
* ✅ December 31, 2025
* ❌ March 23rd, 2026 (no ordinal)
* ❌ March 23rd, 2026 (ordinal)
* ❌ Mar 23, 2026 (abbreviated month)
* ❌ 2026-03-23 (wrong format)

Expand Down Expand Up @@ -501,4 +495,4 @@ Would you like me to help refine the content or add additional details?
* [Developer Release Notes](https://sumologic.com/help/release-notes-developer)
* [Release Notes Index](/docs/release-notes)
* [API Documentation](/docs/api)
* [Style Guide](/docs/contributing/style-guide)
* [Style Guide: Release notes](/docs/contributing/style-guide/#release-notes)
17 changes: 6 additions & 11 deletions .claude/commands/release-note-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,9 @@ This enhancement streamlines your workflow by providing quick access to frequent

### Step 6: Content formatting guidelines

**Write for clarity:**
* Start with a clear statement of what the feature is
* Explain the benefit or business value in 2-3 sentences
* Use "What's new:" section for bulleted specifics (optional)
* End with a "Learn more" link to relevant docs
**Voice and wording:** follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide (direct-statement openers, no announcement framing, conciseness, "Learn more" links). Service-specific structure is below.

* Use a "What's new:" section for bulleted specifics (optional).

**Use formatting for readability:**
* Use **bold** for section labels like "What's new:"
Expand Down Expand Up @@ -443,11 +441,8 @@ Would you like me to help refine the content or add additional details?
## Tips and best practices

**For all Service releases:**
* Lead with user benefit, not technical implementation
* Explain "what" and "why", not "how"
* Keep descriptions concise (2-3 sentences)
* Link to comprehensive documentation for details
* Use "What's new" bullets for multiple specific changes
* Voice, openers, conciseness, and "Learn more" links follow [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide.
* Use "What's new" bullets for multiple specific changes.

**Title guidelines:**
* Be specific about the feature (not "New Collection Feature")
Expand All @@ -471,4 +466,4 @@ Would you like me to help refine the content or add additional details?

* [Service Release Notes](https://sumologic.com/help/release-notes-service)
* [Release Notes Index](/docs/release-notes)
* [Style Guide](/docs/contributing/style-guide)
* [Style Guide: Release notes](/docs/contributing/style-guide/#release-notes)
1 change: 1 addition & 0 deletions .claude/skills/sumo-style/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,4 @@ These are Sumo Logic- and repo-specific facts that override general assumptions.
- **Numbered list items always use `1.`** (not `1.`, `2.`, `3.`). Docusaurus handles rendering.
- **Capitalized product terms.** Collector, Source, Hosted Collector, Library. User-created objects (dashboards, folders) are lowercase.
- **C2C sources and apps have distinct openers.** Do not use the app opener for a source doc or vice versa.
- **Release notes have their own rules.** Voice, openers (no announcement framing), title date format, and per-folder conventions live in [Release notes](/docs/contributing/style-guide/#release-notes) in the style guide. Apply that section when writing or editing anything in `blog-service`, `blog-collector`, `blog-cse`, `blog-csoar`, or `blog-developer`.
Loading
Loading