Skip to content

Commit

Permalink
docs: Update user-facing docs
Browse files Browse the repository at this point in the history
Signed-off-by: Anurag Rajawat <[email protected]>
  • Loading branch information
Anurag Rajawat committed Nov 15, 2024
1 parent a218d2b commit 65e38ee
Show file tree
Hide file tree
Showing 14 changed files with 585 additions and 397 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
# SentryFlow

[![SentryFlow Docker Build](https://github.com/5gsec/sentryflow/actions/workflows/release.yml/badge.svg)](https://github.com/5gsec/sentryflow/actions/workflows/release.yml) [![CI for SentryFlow](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-go.yml/badge.svg)](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-go.yml) [![CI for AI Engine](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-py.yml/badge.svg)](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-py.yml)

SentryFlow is a cloud-native system for API observability and security, specializing in log collection, metric production, and data exportation.
SentryFlow is a cloud-native system for API observability, specializing in log collection, and data
exportation.

## Architecture Overview

![SentryFlow_Overview](docs/sentryflow_overview.png)

### Features

- Generation of API Access Logs
- Production of API Metrics
- AI-driven API Classification (Inference)

## Documentation
- API access observability

### Basic Information
[//]: # (- Production of API Metrics)

- [Getting Started](docs/getting_started.md)
- [Use Cases](examples/README.md)
[//]: # (- AI-driven API Classification &#40;Inference&#41;)

### Contribution
## Documentation

- [Contribution Guide](contribution/README.md)
- [Getting Started](docs/getting_started.md)
- [Contribution Guide](docs/CONTRIBUTING.md)
80 changes: 0 additions & 80 deletions contribution/README.md

This file was deleted.

1 change: 0 additions & 1 deletion contribution/vagrant/.gitignore

This file was deleted.

51 changes: 0 additions & 51 deletions contribution/vagrant/Vagrantfile

This file was deleted.

130 changes: 0 additions & 130 deletions contribution/vagrant/env-setup.sh

This file was deleted.

30 changes: 0 additions & 30 deletions contribution/vagrant/install-scripts/install-vagrant.sh

This file was deleted.

24 changes: 0 additions & 24 deletions contribution/vagrant/install-scripts/install-virtualbox.sh

This file was deleted.

2 changes: 1 addition & 1 deletion deployments/sentryflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ subjects:
apiVersion: v1
kind: ConfigMap
metadata:
name: config
name: sentryflow
namespace: sentryflow
labels:
app.kubernetes.io/part-of: sentryflow
Expand Down
Loading

0 comments on commit 65e38ee

Please sign in to comment.