adding documentation links into the readme file (#222)

cleanining unused files
This commit is contained in:
Marian Novotny
2021-03-23 12:19:20 +00:00
committed by GitHub Enterprise
parent c7b93c8558
commit 2a603c2cbe
7 changed files with 27 additions and 6 deletions

View File

@@ -1,3 +1,30 @@
![Siembol](logo.svg)
Siembol provides a scalable, advanced security analytics framework based on open-source big data technologies. Siembol normalizes, enriches, and alerts on data from various sources which allows security teams to respond to attacks before they become incidents.
- [Introduction](https://github.com/G-Research/siembol/tree/master/docs/introduction)
- [How to try siembol](https://github.com/G-Research/siembol/blob/master/docs/introduction/how-tos/how_to_try_siembol.md)
- [How to contribute](https://github.com/G-Research/siembol/blob/master/docs/introduction/how-tos/how_to_contribute.md)
- [Siembol UI](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/siembol_ui.md)
- [How to add new config in siembol ui](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_add_new_config_in_siembol_ui.md)
- [How to submit a config in siembol ui](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_submit_config_in_siembol_ui.md)
- [How to deploy configurations in siembol ui](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_deploy_configurations_in_siembol_ui.md)
- [How to test config in siembol ui](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_test_config_in_siembol_ui.md)
- [How to test a deployment in siembol ui](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_test_deployment_in_siembol_ui.md)
- [How to add links to siembol ui home page](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_add_links_to_siembol_ui_home_page.md)
- [How to set-up OAUTH2 OIDC in siembol ui](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_setup_oauth2_oidc_in_siembol_ui.md)
- [How to modify ui layout](https://github.com/G-Research/siembol/blob/master/docs/siembol_ui/how-tos/how_to_modify_ui_layout.md)
- Siembol services
- [How to set-up a service in config editor rest](https://github.com/G-Research/siembol/blob/master/docs/services/how-tos/how_to_set_up_service_in_config_editor_rest.md)
- [Siembol alerting services](https://github.com/G-Research/siembol/blob/master/docs/services/siembol_alerting_services.md)
- [Siembol parsing services](https://github.com/G-Research/siembol/blob/master/docs/services/siembol_parsing_services.md)
- [How to set-up netflow v9 parsing](https://github.com/G-Research/siembol/blob/master/docs/services/how-tos/how_to_setup_netflow_v9_parsing.md)
- [Siembol enrichment service](https://github.com/G-Research/siembol/blob/master/docs/services/siembol_enrichment_service.md)
- [How to set-up an enrichment table](https://github.com/G-Research/siembol/blob/master/docs/services/how-tos/how_to_set_up_enrichment_table.md)
- [Siembol response service](https://github.com/G-Research/siembol/blob/master/docs/services/siembol_response_service.md)
- [How to write response plugin](https://github.com/G-Research/siembol/blob/master/docs/services/how-tos/how_to_write_response_plugin.md)
- [Siembol deployment](https://github.com/G-Research/siembol/blob/master/docs/deployment/deployment.md)
- [How to set-up zookeper nodes](https://github.com/G-Research/siembol/blob/master/docs/deployment/how-tos/how_to_set_up_zookeper_nodes.md)
- [How to set-up a github webhook](https://github.com/G-Research/siembol/blob/master/docs/deployment/how-tos/how_to_setup_github_webhook.md)
- [How to tune the performance of storm topologies](https://github.com/G-Research/siembol/blob/master/docs/deployment/how-tos/how_to_tune_performance_of_storm_topologies.md)
- [How to set-up kerberos for external dependencies](https://github.com/G-Research/siembol/blob/master/docs/deployment/how-tos/how_to_set_up_kerberos_for_external_dependencies.md)

View File

@@ -1 +0,0 @@
"# alerting"

View File

@@ -1 +0,0 @@
"# config-editor"

View File

@@ -1 +0,0 @@
"# docs"

View File

@@ -1 +0,0 @@
"# indexing"

View File

@@ -1 +0,0 @@
"# parsing"

View File

@@ -1 +0,0 @@
"# alerting"