Skip to content

Commit 3246873

Browse files
authored
Merge branch 'main' into manashar4-patch-2
2 parents 0eb8977 + 158d30c commit 3246873

File tree

2,502 files changed

+21844
-13044
lines changed

Some content is hidden

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

2,502 files changed

+21844
-13044
lines changed

.clabot

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
"JV0812",
66
"jpipkin1",
77
"JainM6",
8-
"swiatekm-sumo",
98
"docsSeema",
10-
"@dependabot[bot]",
11-
"dependabot[bot]",
129
"angadrandhawa1",
1310
"kkujawa-sumo",
14-
"open-source-collection-team",
1511
"mat-rumian",
1612
"perk-sumo",
1713
"jmartini-sumo",
@@ -28,12 +24,10 @@
2824
"agaur",
2925
"bhargavisumo",
3026
"ravipadala-sumo",
31-
"jd-sumo",
3227
"davidcarltonsumo",
3328
"pkazmir-sumo",
3429
"dkarabin-sumo",
3530
"kevin-sumo",
36-
"mgol-sumo",
3731
"crm6718",
3832
"mvirga-sumo",
3933
"tarunk2",
@@ -165,9 +159,19 @@
165159
"ruturajsumo",
166160
"bchrobot-mh",
167161
"sachin-sumologic",
168-
"Andrew-L-Johnson"
162+
"Andrew-L-Johnson",
163+
"Ayah-Saleh",
164+
"ishaanahuja29",
165+
"raunakmandaokar",
166+
"bradtho",
167+
"Misterjohnson87",
168+
"lol3909",
169+
"Hellfire4959",
170+
"antonymartinsumo",
171+
"amee-sumo",
172+
"chetanchoudhary-sumo"
169173
],
170-
"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'll add you to our approved list of contributors.",
174+
"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.",
171175
"label": "cla-signed",
172176
"recheckComment": "The GitHub CLA Bot is rechecking to see that you have signed our CLA."
173177
}

.github/CODEOWNERS

Lines changed: 7 additions & 5 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.
2-
* @kimsauce @jpipkin1 @JV0812 @mafsumo
4+
* @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
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
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
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

.github/workflows/build_and_deploy.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ on:
2828

2929
jobs:
3030
build-and-deploy:
31-
runs-on: ubuntu-20.04
31+
runs-on: ubuntu-22.04
3232
environment:
3333
name: ${{ inputs.environment }}
3434
url: ${{ inputs.hostname }}${{ inputs.base_url }}
@@ -41,13 +41,13 @@ jobs:
4141
AWS_DEFAULT_REGION: us-east-1
4242
AWS_EC2_METADATA_DISABLED: "true"
4343
steps:
44-
- uses: actions/checkout@v3
44+
- uses: actions/checkout@v4
4545
with:
4646
fetch-depth: 0
4747
- name: Set up Node.js
4848
uses: actions/setup-node@v3
4949
with:
50-
node-version: '18.x'
50+
node-version: '20.x'
5151
cache: 'yarn'
5252
- name: Docusaurus Webpack cache
5353
uses: actions/cache@v3
@@ -57,7 +57,7 @@ jobs:
5757
- name: Install awscli
5858
uses: unfor19/install-aws-cli-action@v1
5959
- name: Install jq
60-
run: sudo apt-get install jq
60+
run: sudo apt-get install -y jq
6161
- name: Install dependencies
6262
run: yarn install --frozen-lockfile
6363
- name: Build the Docusaurus site

.github/workflows/pr.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
jobs:
1212
build-and-deploy:
13-
runs-on: ubuntu-20.04
13+
runs-on: ubuntu-22.04
1414
env:
1515
CI: true
1616
NODE_ENV: production

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/2015/12-31.md

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)