Git Product home page Git Product logo

docs's Introduction

docs

The documentation uses mkdocs to render the content.

Test changes

# Install the requirements first
pip install -r requirements.txt

# Start the mkdocs server in development mode
mkdocs serve

Alternatively you can use a docker container:

docker build . -t thehive-docs
docker run -it --rm -p 8000:8000 -v $PWD:/docs thehive-docs

Deploy

After commiting changes in mainbranch, deploy the documentation by running this command:

mkdocs gh-deploy --remote-branch gh-pages

docs's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

[API] Add alert API docs

Add documentation of the following APIs:

  • Create alert
  • Update alert
  • List/Search alert
  • Mark alert as read/unread
  • Merge alert into a case
  • Promote alert into a case
  • Delete an alert
  • List alert similar cases
  • List alert observables
  • Add alert observable
  • Update alert observable
  • Delete alert observable
  • Run responder on alert
  • List responder jobs
  • Review

[API] Add task API docs

Add documentation of the following APIs:

  • Create case task
  • Update case task
  • List/Search case task
  • Delete case task
  • Add task log
  • Delete task log
  • Run responder on task
  • List responder jobs
  • Review

[Guide] How to manage case templates

Write documentation about how to manage case templates as an organisation manager user:

  • How to create case templates
  • How to manage case template tasks
  • How to manage case template custom fields
  • Include links to analysts documentation for:
    • How to use case templates in cases
    • How to use case templates in alerts

[API] Add query API docs

Add documentation of the generic query APIs:

  • describe the api structure
  • describe filtering
  • describe sorting
  • describe pagination
  • describe extra data options

[Guide] How to manage users

Write documentation about how to manage organisation users super admin:

  • How to create users
  • How to define passwords, api key
  • How to include a user in many organisations

[API] Add organisation API docs

Add documentation of the following APIs:

  • Create organisation
  • Update organisation
  • List/Search organisation
  • Link organisation

[API] Add custom field API docs

Add documentation of the following APIs:

  • Create custom field
  • Update custom field
  • List/Search custom fields
  • Delete custom field
  • Get custom field
  • Get custom field count
  • Review

[API] Add case API docs

Add documentation of the following APIs:

  • Create case
  • Update case
  • List/Search cases
  • Merge cases
  • Delete case
  • Export case to MISP
  • List related cases
  • List related alerts
  • List attachments
  • Run responder on case
  • List responder jobs
  • Review

[API] Add observable API docs

Add documentation of the following APIs:

  • Create case observable
  • Update case observable
  • List/Search case observable
  • Run analyzer on observable
  • List analyzer jobs
  • Run responder on observable
  • List responder jobs
  • Review

[API] Add user API docs

Add documentation of the following APIs:

  • Create user
  • Update user
  • List/search users
  • Set user password
  • Generate API key for a user
  • Revoke API key of a user
  • Get API key of a user
  • Lock user
  • Delete user
  • Review

[API] Add case template API docs

Add documentation of the following APIs:

  • Create case template
  • Update case template
  • List/Search case template
  • Delete case template
  • Review

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.