Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update docs #24

Merged
merged 3 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Description

<!--
Thank you for your pull request (PR)!
Please provide a description of what your PR does providing a link (if applicable) to the issue it fixes.
-->

Fixes # (issue)

**Does this PR introduce a breaking change?**

## Checklist

- [ ] PR title follows the `<type>: <description>` convention.
- [ ] I use [conventional commits](https://www.conventionalcommits.org/) in my commit messages.
- [ ] I have updated the [documentation](../docs) accordingly.
- [ ] I Keep It Small and Simple: The smaller the PR is, the easier it is to review and have it merged.
- [ ] I have performed a self-review of my code.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes.

## Additional information for reviewer

#### Mention if this PR is part of any design or a continuation of previous PRs

<!--
The PR title must follow `<type>: <description>` convention:

where: <br/>

- `type` is to define what type of PR is this, most common types are as follows:
- `fix` - for bug fixes or improvements.
- `feat` - for new features which adds functionality.
- `chore` - for changes that do not relate to a fix or feature and don't modify src or test files.
- `docs` - for changes related to documentation.
- `test` - for changes related to tests.

- `description` is a single line brief description of the changes made in the pull request.
-->

<!--
Open your PR in Draft mode and verify all the applicable Checklist items before marking your issue as ready
-->
78 changes: 0 additions & 78 deletions .github/workflows/ci-test-py.yml

This file was deleted.

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)
6 changes: 0 additions & 6 deletions ai-engine/.dockerignore

This file was deleted.

2 changes: 0 additions & 2 deletions ai-engine/.gitignore

This file was deleted.

Loading
Loading