Sumo Docs

Sumo Docs is the open-source documentation site for Sumo Logic, an AI-powered security operations platform providing Cloud SIEM and security analytics to help teams automate, detect, and investigate threats. Sumo Logic empowers users to monitor, troubleshoot, and defend their environments using AI insights powered by log analytics. Learn more at sumologic.com.

The site is built with Docusaurus 3 and supports React, Rehype, and Remark plugins.

Get involved

We welcome contributions from the community. You can fix a typo, propose new content, or improve existing docs by opening an issue or submitting a pull request.

Browse existing issues before opening a new one — someone may have already reported it.

We use cla-bot to manage our Contributor License Agreement (CLA) process. You will be prompted to sign the CLA on your first contribution.

Prerequisites

• Node.js version 20 or higher
• Yarn, installable via Homebrew (brew install yarn)

Installation

1. Fork and clone the repo.

2. Navigate to the repo folder:

   cd sumologic-documentation

3. Install dependencies:

   yarn install

Apply your changes

Edit files using Markdown syntax. Keep contributions concise, accurate, and aligned with our Style Guide.

See our Contributor Guidelines for details on Markdown editing, proposing bug fixes, and testing your changes.

Build locally

Serve and preview your changes with hot reloads:

yarn start

Any broken links or images will be listed in the output. Fix them, rebuild, and verify before submitting. Press Ctrl + C to stop the local server.

Repo structure

Path	Contents
/docs	Documentation source files
/blog-service	Service release notes
/blog-collector	Collector release notes
/blog-cse	Cloud SIEM release notes
/blog-csoar	Cloud SOAR release notes
/static/img	Images and media assets
sidebars.ts	Left-nav sidebar configuration
docusaurus.config.ts	Site configuration
cid-redirects.json	Permanent URL redirects (CID mappings)

For Docs Team contributors

This repo includes Claude Code tooling for the Docs Team — slash commands for creating docs, auditing content, managing Jira tickets, and more. See CLAUDE.md for the full reference.

Publishing

Our docs team reviews issues and pull requests regularly. Response times may vary depending on the backlog.

Merge times depend on the type of change:

• Content changes (docs/, blog-*, static/img) — no hard merge window. We prefer U.S. or India business hours when possible.
• Back-end changes (src/, sidebars.ts, config files, .github/) — merged Monday–Friday, 7:00am–2:00pm PT only, when the WebOps team is available.

PRs that mix content and back-end files follow the back-end rules.

License

This project is licensed under the MIT License.