Create a Sumo Logic Document
The Sumo Logic Docs site is comprised of GitHub-flavored markdown files containing content like bulleted instructions, screenshots, tables, interactive code samples, and more.
Here's a high level overview of how to create a doc.
Step 1: Create a doc file
In the /docs folder, create a markdown file in the format <your-file>.md.
Step 2: Add title and metadata
See our Style Guide > Frontmatter section to learn how.
Step 3: Write and edit your doc
Help us keep Sumo Logic open and inclusive by reviewing our Code of Conduct.
See our Style Guide to learn how to write and style content, add code snippets, import multimedia, and more. Doc body text content is written in GitHub-flavored markdown, with some customizations.
Step 4: Add doc to the navigation menu
To add your new doc to the left-nav menu, you'll need to add its name and file path to the sidebars.ts file.
The Sumo Logic Doc Team will help your add your documentation to the sidebar and top navigation. If you have suggestions, please include those in your Pull Request description. If you add the documentation to the sidebar, the team will review the location and names for building and placement in navigation.
Step 5: Build and deploy on local to preview changes
Next, you'll build and deploy a local instance of the Sumo Logic Docusaurus site.
Our site is built using Docusaurus, a static site generator, which builds your site as simple static HTML, JavaScript and CSS files. To view our install installment requirements and preview your build, see Building Locally in our README.
We use Yarn for all installs and builds. Never use NPM commands for installing or updating packages.
Step 6: Submit your request
See Clone Sumo Docs Repository for instructions.
