Skip to content

Commit

Permalink
Docs index update and config fix
Browse files Browse the repository at this point in the history
  • Loading branch information
styx0x6 committed Jan 26, 2025
1 parent 3a71415 commit 18023b1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
# -- Project information -----------------------------------------------------

# Get project, author, version and release from colvert's settings.py file
import settings
from colvert import settings

project = settings.APP_SHORT_NAME
author = settings.APP_CONTRIBUTORS
Expand Down
34 changes: 22 additions & 12 deletions docs/index.rst.j2
Original file line number Diff line number Diff line change
@@ -1,31 +1,41 @@
###################################
Welcome to Colvert's documentation!
===================================
###################################

**Colvert** is a tool made for cybersecurity teams (CSIRTs / SOCs) and designed to manage their portfolio of *detection use cases* through their entire lifecycle in the context of **Information Security Event Management**.

Presentation
============

The tool consists of:

* The main application.
* Connectors to potentially get data from providers and contextual more-valued information.

Go to the main repository `https://github.com/colvert-project/colvert`_ for an overview of the tool.
Go to the main repository <https://github.com/colvert-project/colvert> for an overview of the tool.

* Website: <https://colvert.io>
* Contact: [email protected]

## Interesting Places
Interesting Places
==================

* **Last Release:** <https://github.com/colvert-project/colvert/releases/latest>
* **Packages:** <https://github.com/orgs/colvert-project/packages>
* **Discussions:** <https://github.com/orgs/colvert-project/discussions>
* **Issues Tracker:** <https://github.com/colvert-project/colvert/issues>

* **Security Policy:** <https://github.com/colvert-project/colvert/security/policy>
* **Security Advisories:** <https://github.com/colvert-project/colvert/security/advisories>

[Last Release](https://github.com/colvert-project/colvert/releases/latest) /
[Packages](https://github.com/orgs/colvert-project/packages) /
[Discussions](https://github.com/orgs/colvert-project/discussions) /
[Issues Tracker](https://github.com/colvert-project/colvert/issues) /
[Security Policy](https://github.com/colvert-project/colvert/security/policy) /
[Security Advisories](https://github.com/colvert-project/colvert/security/advisories)
Contributing
============

## Contributing
* How to contribute?
* <https://github.com/colvert-project/colvert/blob/main/CONTRIBUTING.md>

[How to contribute?](https://github.com/colvert-project/colvert/blob/main/CONTRIBUTING.md) /
[Colvert Contributor Code of Conduct](https://github.com/colvert-project/colvert/blob/main/CODE_OF_CONDUCT.md)
* Colvert Contributor Code of Conduct:
* <https://github.com/colvert-project/colvert/blob/main/CODE_OF_CONDUCT.md>

.. toctree::
:maxdepth: 3
Expand Down

0 comments on commit 18023b1

Please sign in to comment.