From 174d10c94308dd9de73ef6b06f1b6fa848801861 Mon Sep 17 00:00:00 2001
From: Nitish Tiwari <tiwari.nitish@gmail.com>
Date: Thu, 27 Oct 2022 14:19:41 +0530
Subject: [PATCH 1/3] Add links to specific docs and remove the syslog-ng docs.

Syslog-ng docs are now available at
https://www.parseable.io/docs/log-agents/syslog-ng
---
 README.md                        |   3 +-
 docs/syslog_ng_log_forwarding.md | 168 -------------------------------
 2 files changed, 2 insertions(+), 169 deletions(-)
 delete mode 100644 docs/syslog_ng_log_forwarding.md

diff --git a/README.md b/README.md
index ac488357b..1b3f7fc06 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,6 @@ Instead of installing locally, you can also try out Parseable on our [Demo insta
 ## Usage
 
 If you've already deployed Parseable using the above Docker command, use below commands to create stream and post event(s) to the stream. Make sure to replace `<stream-name>` with the name of the stream you want to create and post events (e.g. `my-stream`).
-
 #### Create a stream
 
 ```sh
@@ -86,6 +85,8 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/<stream-n
 ```
 
 For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
+To configure Parseable with popular logging agents, please refer to the [agent documentation](https://www.parseable.io/docs/category/log-agents).
+To integrate Parseable with your applications directly, please refer to the [integration documentation](https://www.parseable.io/docs/category/application-integration).
 
 ## Support
 
diff --git a/docs/syslog_ng_log_forwarding.md b/docs/syslog_ng_log_forwarding.md
deleted file mode 100644
index f80cca1b9..000000000
--- a/docs/syslog_ng_log_forwarding.md
+++ /dev/null
@@ -1,168 +0,0 @@
-# Syslog-ng log forwarding to Parseable
-
-
-Syslog-ng implement [syslog](https://en.wikipedia.org/wiki/Syslog) protocol for Unix and Unix-like systems, 
-to forward syslog-ng log to Parseable you can follow the guide below.
-
-## Syslog-ng setup
-
-For this documentation we use syslog-ng in form of docker image, first setup docker-compose file:
-
-```
----
-version: "2.1"
-services:
-  syslog-ng:
-    image: lscr.io/linuxserver/syslog-ng:latest
-    container_name: syslog-ng
-    environment:
-      - PUID=1000
-      - PGID=1000
-      - TZ=Europe/London
-    volumes:
-      - /your/local/path/syslog-ng/config:/config
-      - /your/local/path/syslog-ng/log:/var/log #optional
-    ports:
-      - 514:5514/udp
-      - 601:6601/tcp
-      - 6514:6514/tcp
-    restart: unless-stopped
-  parseable:
-    image: parseable/parseable:latest
-    entrypoint: /bin/parseable
-    command: server
-    ports:
-    - "8000:8000"
-    environment:
-    - P_S3_URL=https://minio.parseable.io:9000
-    - P_S3_ACCESS_KEY=minioadmin
-    - P_S3_SECRET_KEY=minioadmin
-    - P_S3_REGION=us-east-1
-    - P_S3_BUCKET=parseable
-    - P_LOCAL_STORAGE=/tmp/data
-    - P_USERNAME=parseable
-    - P_PASSWORD=parseable
-```
-
-Run `docker-compose up` and syslog-ng will listen on port UDP `514` and in `/your/local/path/syslog-ng/config`
-path will contain default configuration file, we only need to customize destination log in main config file,
-`syslog-ng.conf`.
-
-```
-$ cat syslog-ng.conf
-############################################################################
-# Default syslog-ng.conf file which collects all local logs into a
-# single file called /var/log/messages tailored to container usage.
-
-@version: 3.35
-@include "scl.conf"
-
-source s_local {
-  internal();
-};
-
-source s_network_tcp {
-  syslog(transport(tcp) port(6601));
-};
-
-source s_network_udp {
-  syslog(transport(udp) port(5514));
-};
-
-destination d_local {
-  file("/var/log/messages");
-  file("/var/log/messages-kv.log" template("$ISODATE $HOST $(format-welf --scope all-nv-pairs)\n") frac-digits(3));
-};
-
-log {
-  source(s_local);
-  source(s_network_tcp);
-  source(s_network_udp);
-  destination(d_local);
-};
-```
-
-
-
-## Sending syslog log
-
-First ensure log stream in Parseable already created.
-
-```
-$ curl --request PUT \
-  --url http://localhost:8000/api/v1/logstream/{logstream-name} \
-  --header 'Authorization: Basic cGFyc2VhYmxlOnBhcnNlYWJsZQ=='
-```
-
-Add following section in `syslog-ng.conf` file:
-
-```
-destination d_http {
-    http(
-        url("http://parseable:8000/api/v1/logstream/logstream-name")
-        method("POST")
-        user-agent("syslog-ng User Agent")
-        user("parseable")
-        password("parseable")
-        headers("X-P-META-Host: 192.168.1.10", "X-P-TAGS-Language: syslog")
-        headers("Content-Type: application/json")
-        body-suffix("\n")
-        body('$(format-json --scope rfc5424 --key ISODATE)')
-    );
-};
-```
-
-and then in `log` section add `d_http` as destination:
-
-```
-log {
-  source(s_local);
-  source(s_network_tcp);
-  source(s_network_udp);
-  destination(d_local);
-  destination(d_http);
-};
-```
-
-`url()` define the address of parseable server, use `parseable` if you following 
-docker compose step. `user(), password()` to define HTTP Basic Auth, required by Parseable to authenticate
-sending log request. `headers()` to customize custom header and set content-type of the payload. And
-finally `body('$(format-json --scope rfc5424 --key ISODATE)')` to format syslog as JSON.
-
-After editing `syslog-ng.conf` restart the docker-compose instance.
-
-
-## Testing
-
-To test you can use following python script.
-
-```python
-import logging
-import logging.handlers
-
-my_logger = logging.getLogger('MyLogger')
-my_logger.setLevel(logging.DEBUG)
-
-handler = logging.handlers.SysLogHandler(address=('127.0.0.1', 514))
-
-my_logger.addHandler(handler)
-
-my_logger.debug('test-app this is debug')
-my_logger.critical('test-app this is critical')
-```
-
-Execute those code and then you can query Parseable using
-
-```
-$ curl --request POST \
-  --url http://localhost:8000/api/v1/query \
-  --header 'Authorization: Basic cGFyc2VhYmxlOnBhcnNlYWJsZQ==' \
-  --header 'Content-Type: application/json' \
-  --data '{
-	"startTime": "2022-10-16T13:11:00+00:00",
-	"query": "select * from logstream-name limit 10",
-	"endTime": "2022-10-16T13:21:00+00:00"
-}'
-```
-
-Or view it in Parseable dashboard.
\ No newline at end of file

From b30db917f580787f6454922bb44db24f2901a10e Mon Sep 17 00:00:00 2001
From: Nitish Tiwari <tiwari.nitish@gmail.com>
Date: Thu, 27 Oct 2022 14:30:54 +0530
Subject: [PATCH 2/3] temp

---
 README.md | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 1b3f7fc06..f167271f9 100644
--- a/README.md
+++ b/README.md
@@ -18,13 +18,11 @@
 
 As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We faced this issue first hand at our jobs, and we've seen several other large scale Kubernetes users relating to this gap.
 
-Parseable started because of this _missing_ case. We intend to enrich the ecosystem with a developer friendly, cloud native, event & log observability platform.
+Our aim with Parseable is to provide a fully open source, developer friendly, kubernetes and cloud native, scalable logging and observability platform.
 ## How it works
 
 Parseable exposes REST API to ingest and query log data. Under the hood, it uses Apache Arrow and Parquet to handle and compress high volume log data. All data is stored in S3 (or compatible systems). Parseable also has a bundled web console to visualize and query log data. 
 
-Parseable can be deployed in cloud and container based environments in minutes and can scale as the requirements grow.
-
 #### Key differentiators
 
 - Written in Rust. Low CPU & memory footprint, with low latency, high throughput.
@@ -34,7 +32,7 @@ Parseable can be deployed in cloud and container based environments in minutes a
 
 ## Installing
 
-Docker is the quickest way to experience Parseable on your machine. Run the below command to deploy Parseable in demo mode.
+Run the below command to deploy Parseable in demo mode with Docker.
 
 ```sh
 mkdir -p /tmp/data
@@ -47,7 +45,7 @@ docker run \
 
 Once this runs successfully, you'll see dashboard at [http://localhost:8000](http://localhost:8000). You can login to the dashboard with `parseable`, `parseable` as the credentials. Please make sure not to post any important data while in demo mode.
 
-For non-demo and other installation options (Kubernetes, bare-metal), please refer to the [documentation](https://www.parseable.io/docs/category/installation).
+Prefer other platforms? Check out installation options (Kubernetes, bare-metal), in the [documentation](https://www.parseable.io/docs/category/installation).
 
 #### Live demo 
 
@@ -84,9 +82,9 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/<stream-n
 ]'
 ```
 
-For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
-To configure Parseable with popular logging agents, please refer to the [agent documentation](https://www.parseable.io/docs/category/log-agents).
-To integrate Parseable with your applications directly, please refer to the [integration documentation](https://www.parseable.io/docs/category/application-integration).
+- For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
+- To configure Parseable with popular logging agents, please refer to the [agent documentation](https://www.parseable.io/docs/category/log-agents).
+- To integrate Parseable with your applications directly, please refer to the [integration documentation](https://www.parseable.io/docs/category/application-integration).
 
 ## Support
 

From cfba4e3cce0192de770722d54855757926b232f9 Mon Sep 17 00:00:00 2001
From: Nitish Tiwari <tiwari.nitish@gmail.com>
Date: Thu, 27 Oct 2022 14:35:00 +0530
Subject: [PATCH 3/3] temp

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f167271f9..a44da611f 100644
--- a/README.md
+++ b/README.md
@@ -16,9 +16,9 @@
 
 ## Why Parseable?
 
-As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We faced this issue first hand at our jobs, and we've seen several other large scale Kubernetes users relating to this gap.
+As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We saw this issue manifest multiple times in several shapes and forms, across organizations.
 
-Our aim with Parseable is to provide a fully open source, developer friendly, kubernetes and cloud native, scalable logging and observability platform.
+Our aim with Parseable is to provide a fully open source, developer friendly, kubernetes and cloud native, scalable, logging and observability platform.
 ## How it works
 
 Parseable exposes REST API to ingest and query log data. Under the hood, it uses Apache Arrow and Parquet to handle and compress high volume log data. All data is stored in S3 (or compatible systems). Parseable also has a bundled web console to visualize and query log data.