Skip to content

Commit 92f9342

Browse files
authored
Merge branch 'main' into docs-232-personal-access-keys
2 parents b595ffd + 2b8d0cd commit 92f9342

File tree

571 files changed

+10790
-5399
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

571 files changed

+10790
-5399
lines changed

.clabot

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@
55
"JV0812",
66
"jpipkin1",
77
"JainM6",
8-
"swiatekm-sumo",
98
"docsSeema",
109
"angadrandhawa1",
1110
"kkujawa-sumo",
12-
"open-source-collection-team",
1311
"mat-rumian",
1412
"perk-sumo",
1513
"jmartini-sumo",
@@ -26,12 +24,10 @@
2624
"agaur",
2725
"bhargavisumo",
2826
"ravipadala-sumo",
29-
"jd-sumo",
3027
"davidcarltonsumo",
3128
"pkazmir-sumo",
3229
"dkarabin-sumo",
3330
"kevin-sumo",
34-
"mgol-sumo",
3531
"crm6718",
3632
"mvirga-sumo",
3733
"tarunk2",
@@ -72,6 +68,9 @@
7268
"rikishi-c",
7369
"Melvin-CnC",
7470
"yuting-liu",
71+
"jc-sumo",
72+
"vfalconisumo",
73+
"yuting-liu",
7574
"arpitjain305",
7675
"kparekh010",
7776
"ajaiswals",
@@ -169,9 +168,11 @@
169168
"lol3909",
170169
"Hellfire4959",
171170
"antonymartinsumo",
172-
"amee-sumo"
171+
"amee-sumo",
172+
"chetanchoudhary-sumo",
173+
"JamoCA"
173174
],
174-
"message": "Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement. To proceed with your PR, please [sign here](https://forms.gle/YgLddrckeJaCdZYA6) and we will add you to our approved list of contributors.",
175+
"message": "Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please [sign your name here](https://forms.gle/YgLddrckeJaCdZYA6) and we will add you to our approved list of contributors.",
175176
"label": "cla-signed",
176177
"recheckComment": "The GitHub CLA Bot is rechecking to see that you have signed our CLA."
177178
}

.github/CODEOWNERS

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
# More details: https://help.github.com/articles/about-codeowners
2+
13
# Default owners for everything in the repo.
24
* @kimsauce @jpipkin1 @JV0812 @mafsumo @amee-sumo
35

4-
# Owners of all files in the `/docs` directory and its subdirectories.
5-
/docs/ @kimsauce @jpipkin1 @JV0812 @mafsumo @amee-sumo
6+
# Owners of all files in the `/docs/integrations` directory.
7+
/docs/integrations/ @SumoLogic/sumoappdev @kimsauce @jpipkin1 @JV0812 @mafsumo @amee-sumo
68

79
# Owners of all files in the `/docs/send-data/kubernetes` directory.
8-
/docs/send-data/kubernetes/ @SumoLogic/open-source-collection-team @kimsauce @jpipkin1 @JV0812 @mafsumo @amee-sumo
10+
/docs/send-data/kubernetes/ @SumoLogic/open-source-collection-team @SumoLogic/k8s-developers @kimsauce @jpipkin1 @JV0812 @mafsumo @amee-sumo
911

1012
# Owners of all files in the `/docs/send-data/opentelemetry-collector` directory and its subdirectories.
11-
/docs/send-data/opentelemetry-collector/ @SumoLogic/open-source-collection-team @kimsauce @jpipkin1 @mafsumo @JV0812 @amee-sumo
13+
/docs/send-data/opentelemetry-collector/ @SumoLogic/open-source-collection-team @kimsauce @jpipkin1 @mafsumo @JV0812 @amee-sumo
1214

1315
# GitHub workflow owners
1416
/.github/workflows/ @SumoLogic/open-source-collection-team @kimsauce

README.md

Lines changed: 64 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,80 @@
88
<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>
99
</p>
1010

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).
1212

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
1414

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.
1616

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.
1821

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.
2023

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.
2225

23-
Docusaurus requires the following to build on locals:
26+
Before submitting an issue or pull request, we recommend reviewing the sections below.
2427

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
2729

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)
2936

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
3638

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:
3840

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`)
4043

41-
## Publishing Content
44+
## Installation
4245

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.

blog-collector/2024-11-26.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Version 19.516-1
3+
hide_table_of_contents: true
4+
image: https://help.sumologic.com/img/sumo-square.png
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
<a href="https://help.sumologic.com/release-notes-collector/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a>
10+
11+
In this release, we've enhanced the security and stability of the Collector with added support for security patches.
12+
13+
### Security Fixes
14+
15+
- Upgraded `Tanuki version` to version 3.5.60 to fix the collector intermittently crashing issue.
16+
- Upgraded collector JRE to **Amazon Corretto Version 8.432.06.1**.
17+
18+
### Troubleshooting
19+
20+
When upgrading this collector version, the collector running as a non-root user (run as mode) or on a Mac operating system cannot be upgraded through the API/Web UI. To resolve these issue, follow the respective steps below:
21+
- **Collector running as a non-root user.** An error message will be displayed indicating that the upgrade is not possible. The upgrade must be performed manually on your machine. Refer to [Upgrade Collectors in Sumo Logic](/docs/send-data/collection/upgrade-collectors/#upgrade-collectors-using-the-command-line) to upgrade the collector manually.
22+
- **Collector running on Mac.** The process will stop while upgrading, and the collector will need to be restarted manually on your machine. Use the code below to restart manually.
23+
```
24+
sudo ./collector start
25+
```

blog-cse/2022/12-31.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ Cloud SIEM now supports custom sources of inventory data. Now, if you want to in
453453

454454
#### Standard Match Lists
455455

456-
As a reminder, the migration for our out-of-the-box rules content from standard match lists to tags for Entities has begun. The system is now automatically setting the appropriate tags for any Entities appearing in any of the standard match lists called out in the [previous announcement](https://help.sumologic.com/release-notes-cse/2022/10/13/application-update/). This will continue until January 20, 2023, when the migration will be complete.
456+
As a reminder, the migration for our out-of-the-box rules content from standard match lists to tags for Entities has begun. The system is now automatically setting the appropriate tags for any Entities appearing in any of the standard match lists called out in the [previous announcement](/release-notes-cse/2022/12/31/#october-13-2022---application-update). This will continue until January 20, 2023, when the migration will be complete.
457457

458458
#### Minor Changes and Enhancements
459459

@@ -776,7 +776,7 @@ Labels were not being created properly based on Network Blocks for a small numbe
776776
#### Read-Only User Capabilities for Cloud SIEM
777777
New user capabilities (permissions) have been created enabling read-only access to content and configuration features in Cloud SIEM.
778778

779-
These can be used when defining roles in the Sumo Logic platform (at **Administration > Users and Roles > Roles**).
779+
These can be used when [defining roles](/docs/manage/users-roles/roles/create-manage-roles/) in the Sumo Logic platform.
780780

781781
<img src={useBaseUrl('img/release-notes/cse/Read-Only-Roles.png')} alt="read-only roles" />
782782

blog-cse/2023/12-31.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ For full details, see the [Cloud SOAR documentation](/docs/platform-services/aut
166166
---
167167
### October 26, 2023 - Content Release
168168

169-
This content release includes templates for creating Cloud SIEM parsers. There are two versions of each, one with comments that explain the purpose of each parser component, and “clean” versions that you can use to start quickly creating custom parsers. Further documentation on using these parsers will be available on [Sumo Logic Docs](https://help.sumologic.com/) in the coming weeks. Other changes in this release are enumerated below.
169+
This content release includes templates for creating Cloud SIEM parsers. There are two versions of each, one with comments that explain the purpose of each parser component, and “clean” versions that you can use to start quickly creating custom parsers. Further documentation on using these parsers will be available on [Sumo Logic Docs](/docs/cse/get-started-with-cloud-siem/cloud-siem-content-catalog/) in the coming weeks. Other changes in this release are enumerated below.
170170

171171
#### Rules
172172

@@ -1325,7 +1325,7 @@ Each node in the graph represents a single Entity. The graph also displays the r
13251325

13261326
The graph also includes a number of controls for zoom, full screen mode, filtering by Entity type, and adjusting the time frame for relationship detection.
13271327

1328-
For more information about how to use the Entity Relationship Graph, see the [online documentation](https://help.sumologic.com/docs/cse/get-started-with-cloud-siem/about-cse-insight-ui/#about-the-entities-tab-graph-view). You will also see an introduction to the feature the first time you visit an Insight details page.
1328+
For more information about how to use the Entity Relationship Graph, see the [online documentation](/docs/cse/get-started-with-cloud-siem/about-cse-insight-ui/#about-the-entities-tab-graph-view). You will also see an introduction to the feature the first time you visit an Insight details page.
13291329

13301330
#### Minor Changes and Enhancements
13311331

0 commit comments

Comments
 (0)