Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved README : Added Table of Contents, Project Overview, Contribution Guidelines, and Social Media Links #4564

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,49 @@
<a href="https://help.sumologic.com/release-notes-service"><img src="https://img.shields.io/badge/RSS-FFA500?style=for-the-badge&logo=rss&logoColor=white" alt="RSS Follow" width="50"/></a>
</p>

Share your knowledge with the Sumo Logic community by contributing to our docs! You can contribute by creating an issue or pull request (PR) on our GitHub repository. We welcome all types of contributions; from minor typo fixes to new topics.
## Table of Contents
- [Project Overview](#project-overview)
- [Key Features](#key-features)
- [Contributing Content](#contributing-content)
- [How to Contribute](#how-to-contribute)
- [Building Locally](#building-locally)
- [Publishing Content](#publishing-content)
- [Get Involved](#get-involved)

Share your knowledge with the Sumo Logic community by contributing to our docs! You can contribute by creating an issue or pull request (PR) on our GitHub repository. We welcome all types of contributions; from minor typo fixes to new topics. Clear contributions is super important to help users get the most out of Sumo Logic's capabilities.

Documentation staff members review issues and pull requests on a regular basis. We do our best to address all issues as soon as possible, but working through the backlog takes time. We appreciate your patience.

## Project Overview

Sumo logic is an all-in-one cloud data analytics platform that is designed with the goal of Security, Operations, and Business Intelligence use cases. It allows users to monitor, analyze, troubleshoot, and visualize data from their application and network environments in real-time. The elastic processing capabilities of Sumo Logic enables users to collect and manage log data from various sources, regardless of type, volume, or location.

## Key Features

1) Data Monitoring & Troubleshooting : Analyze and visualize data from applications, infrastructure, and network environments
2) Elastic Processing : Handle large-scale log data processing across different data types and sources
3) Real-Time Insights : Gain actionable intelligence into online operations, customer behavior, and security threats

## Contributing Content

For detailed instructions, including our style guide, see [Contributor Guidelines](https://help.sumologic.com/docs/contributing).

We recommend forking our repo, creating a new branch for your content changes, and submitting a pull request. We will help review, test, and merge the content for publishing.

## How to Contribute

Please follow the steps below, if you want to contribute :

1) Fork the Repository : Creates a copy of the repo under your GitHub account.
2) Create a Branch : Make sure to work on a new branch in order to keep your changes more organized.
3) Make Your Changes : Edit the code or documentation directly from your branch.
4) Submit a Pull Request : Once you have done all your changes, submit a pull request to the original repo so the team can review it.

For more details on the GitHub contribution, visit [GitHub’s Guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).

## Contribution Guidelines
All contributions should adhere to the [Contributor Style Guide](https://help.sumologic.com/docs/contributing/style-guide/). Make changes that are concise and also informative, especially when contributing new topics.

## Building Locally

Docusaurus requires the following to build on locals:
Expand All @@ -41,3 +74,7 @@ Sumo Docs was created using [Docusaurus 2](https://docusaurus.io/) with React, R
## Publishing Content

As pull requests are merged to the `main` branch by the Sumo Logic Doc team, the content builds and deploys to a staging site. This allows you to review and test your content thoroughly on a server, rather than a local build, prior to merging your code to production.

## Get Involved

Follow @SumoLogic on [X/Twitter](https://x.com/SumoLogic) to recieve the latest updates from the SumoLogic team.
Loading