|
8 | 8 | <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> |
9 | 9 | </p> |
10 | 10 |
|
11 | | -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. |
| 11 | +Sumo Docs is the open-source documentation site for Sumo Logic, an all-in-one cloud data analytics platform built to support security, operations, and business intelligence use cases. Sumo Logic empowers users to monitor, analyze, troubleshoot, and visualize data from their applications and network environments in real time. Its elastic processing capabilities enable seamless log data collection and management from various sources, regardless of type, volume, or location. Learn more at [sumologic.com](https://www.sumologic.com). |
12 | 12 |
|
13 | | -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. |
| 13 | +## Get involved |
14 | 14 |
|
15 | | -## Contributing Content |
| 15 | +We welcome contributions from the community! Whether it's fixing a typo, adding new content, or proposing improvements, your input helps users make the most of Sumo Logic. You can contribute by creating an issue or submitting a pull request in our GitHub repository. |
16 | 16 |
|
17 | | -For detailed instructions, including our style guide, see [Contributor Guidelines](https://help.sumologic.com/docs/contributing). |
| 17 | +Here’s how to get started: |
| 18 | +- Fork our repo and create a new branch for your content changes. |
| 19 | +- Preview your edits by building the site locally. |
| 20 | +- Submit a pull request for review. |
18 | 21 |
|
19 | | -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. |
| 22 | +Our team will help review, test, and merge your contributions for publishing. |
20 | 23 |
|
21 | | -## Building Locally |
| 24 | +Sumo Docs is built with [Docusaurus 3](https://docusaurus.io/) and supports React, Rehype, and Remark plugins. We also use [cla-bot](https://colineberhardt.github.io/cla-bot/) to manage our Contributor License Agreement (CLA) process. |
22 | 25 |
|
23 | | -Docusaurus requires the following to build on locals: |
| 26 | +Before submitting an issue or pull request, we recommend reviewing the sections below. |
24 | 27 |
|
25 | | -* [NodeJS](https://nodejs.org/en/download/) version >= 16.14 |
26 | | -* [Yarn](https://yarnpkg.com/en/) version >= 1.5, you can install with [Homebrew](https://brew.sh/) if you have that installed: `brew install yarn` |
| 28 | +## Table of contents |
27 | 29 |
|
28 | | -The site includes translations into other languages. To build on your local: |
| 30 | +- [Get involved](#get-involved) |
| 31 | +- [Prerequisites](#prerequisites) |
| 32 | +- [Installation](#installation) |
| 33 | +- [Contributing content](#contributing-content) |
| 34 | +- [Building locally](#building-locally) |
| 35 | +- [Publishing content](#publishing-content) |
29 | 36 |
|
30 | | -1. Clone the repo using Git or tools like GitHub Desktop. |
31 | | -1. In a terminal, change to the cloned repo folder. Run the install command: `yarn install`. |
32 | | -1. To serve and review your content, use one of the following: |
33 | | - * Use start, hot reloads as you make changes: `yarn start`. Any issues with broken links and images are listed according to file. Locate and update those issues, then run build and start again to verify. |
34 | | - * Use npm serve to test and review multi-languages: `npm run serve`. This build does not hot reload and requires a rebuild to test and review. |
35 | | -1. To build locally and test your links, run `yarn build`. |
| 37 | +## Prerequisites |
36 | 38 |
|
37 | | -The static files are generated in the `build` folder and run on your local machine at: `http://localhost:3000/`. To stop the build or served site, hit Ctrl + C to interrupt. You can enter new commands in terminal, rebuild, and restart. |
| 39 | +To contribute to Sumo Docs, ensure you have the following tools installed: |
38 | 40 |
|
39 | | -Sumo Docs was created using [Docusaurus 2](https://docusaurus.io/) with React, Rehype, and Remark plugin support. Our CLA bot was built using [cla-bot](https://colineberhardt.github.io/cla-bot/). |
| 41 | +- [Node.js](https://nodejs.org/en/download/) version 18 or higher |
| 42 | +- [Yarn](https://yarnpkg.com/en/), installable via [Homebrew](https://brew.sh/) (`brew install yarn`) |
40 | 43 |
|
41 | | -## Publishing Content |
| 44 | +## Installation |
42 | 45 |
|
43 | | -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. |
| 46 | +1. Fork and clone the repository using Git or a tool like GitHub Desktop. |
| 47 | +2. Navigate to the cloned repository folder: |
| 48 | + ```bash |
| 49 | + cd sumologic-documentation |
| 50 | + ``` |
| 51 | +3. Install dependencies: |
| 52 | + ```bash |
| 53 | + yarn install |
| 54 | + ``` |
| 55 | + |
| 56 | +## Apply your changes |
| 57 | + |
| 58 | +Make edits using [Markdown syntax](https://help.sumologic.com/docs/contributing/style-guide/#markdown). Keep contributions concise, informative, and aligned with our guidelines. |
| 59 | + |
| 60 | +Refer to our [Contributor Guidelines](https://help.sumologic.com/docs/contributing/create-edit-doc/#edit-a-doc) for more information on: |
| 61 | +- Markdown editing |
| 62 | +- Proposing bug fixes |
| 63 | +- Testing your changes |
| 64 | + |
| 65 | +All contributions must follow our [Style Guide](https://help.sumologic.com/docs/contributing/style-guide/). |
| 66 | + |
| 67 | +## Building locally |
| 68 | + |
| 69 | +Building the site locally ensures your changes are accurate and functional before submission. |
| 70 | + |
| 71 | +1. Serve and preview your content with hot reloads: |
| 72 | + ```bash |
| 73 | + yarn start |
| 74 | + ``` |
| 75 | + Any issues, such as broken links or images, will be listed. Fix them, rebuild, and verify your changes. |
| 76 | + |
| 77 | +2. Build the site and test locally: |
| 78 | + ```bash |
| 79 | + yarn build |
| 80 | + ``` |
| 81 | + The static files will be generated in the `build` folder and served at `http://localhost:3000/`. |
| 82 | + |
| 83 | +To stop the local server or build process, press `Ctrl + C`. You can rebuild and restart as needed. |
| 84 | + |
| 85 | +## Publishing content |
| 86 | + |
| 87 | +Our documentation team regularly reviews issues and pull requests. While we strive to address contributions promptly, there may be delays as we work through the backlog. Your patience is appreciated. |
0 commit comments