Contribute to Sumo Logic

We welcome all contributions to the documentation, from minor typo fixes to new topics. Your expertise and sharing helps fellow users learn and expand their knowledge of Sumo Logic.

Get Started!

Make sure you have a GitHub account.

We recommend adding 2FA protection when contributing to Sumo Logic repositories.

Edit a page from the website

On each webpage, you can select a link to edit the page. This link will open the correct page to edit, including versioned content!

1. On a page you find an error, click the Edit this page link found at the bottom. The markdown file opens in GitHub.
2. Make your edits to the file.
3. Scroll to the bottom and select Create a new branch... Enter a name for the branch and click Propose Change.

Clone and Edit

Another option is to clone the GitHub repository and edit locally. This is common for developers, working with GitHub tools, Git commands, and code editors like VSCode or Atom.

Fork and clone

1. Fork the sumologic-documentation repository. Remember to sync your fork and update branches as needed.
2. Review documentation guidelines.

Note: If you use a fork instead of a branch, please set permissions to allow maintainers to edit and update the PR. See Allowing changes to a pull request branch created from a fork in the GitHub documentation.

Create a branch

1. Create a new branch from your fork using a name that best describes the work or references a GitHub issue number.
2. Edit or create markdown (.md) files in your branch.
3. Push your branch to your fork.

Create a pull request

1. Create a pull request to the sumologic-documentation repository against the main branch. This is the branch all staging and production content builds from.
2. Complete the pull request template. Review the Pull Request Process page (coming soon) to learn how to complete a PR.
3. After creating a pull request, a Sumo Logic documentation team member will review it and may ask you to make revisions.

Note: If you have not signed the Contributor License Agreement (CLA), the pull request provides a link. You must sign the CLA before we can accept your contribution.

Report an issue

If you find a typo or errors in documentation, you can either fix it with a pull request (as described above) or you can report it by creating an issue. Enter as much information as you can, including content corrections, steps to reproduce, command or code updates, or questions for clarifications.

To easily submit an issue for a specific page, click Report an issue (coming soon) on the documentation web page and include your feedback.

Note: Check the existing issues on GitHub to see if someone has already reported the issue.

Submit an issue

If you find an issue on a page, or want to request more information, submit an issue. You can enter issues through GitHub or directly as feedback per page using the Log an issue link found at the bottom. This also will note the version!