Skip to content
Permalink
Browse files

DOC: README: rewrite contributing section

contribution:
rewording and more verbosity
add new feed whishlist

merge user guide and data harmonization
  • Loading branch information
wagner-certat committed Mar 23, 2020
1 parent a677c1d commit 4e6097d1f290167700655190a88669a28b8c3e98
Showing with 25 additions and 30 deletions.
  1. +25 −30 README.rst
@@ -56,24 +56,18 @@ Table of Contents
1. `How to Install <#how-to-install>`__
2. `Developers Guide <#developers-guide>`__
3. `User Guide <#user-guide>`__
4. `IntelMQ Manager <#intelmq-manager>`__
5. `Incident Handling Automation
4. `IntelMQ Manager and more tools <#intelmq-manager-and-more-tools>`__
5. `How to Participate <#how-to-participate>`__
6. `Incident Handling Automation
Project <#incident-handling-automation-project>`__
6. `Data Harmonization <#data-harmonization>`__
7. `How to Participate <#how-to-participate>`__
8. `Licence <#licence>`__
9. `Funded by <#funded-by>`__
7. `Licence <#licence>`__
8. `Funded by <#funded-by>`__

How to Install
--------------

See `INSTALL <docs/INSTALL.md>`__.

Developers Guide
----------------

See `Developers Guide <docs/Developers-Guide.md>`__.

User Guide
----------

@@ -84,37 +78,38 @@ If you know additional feeds and how to parse them, please contribute your code
For support questions please use the intelmq-users mailing list:
https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-users

IntelMQ Manager
---------------
IntelMQ use the Data Harmonization. Please read `this
document <docs/Data-Harmonization.md>`__ for more details.

IntelMQ Manager and more tools
------------------------------

Check out this graphical
`tool <https://github.com/certtools/intelmq-manager>`__ and easily
manage an IntelMQ system.

More tools can be found in the `ecosystem documentation <docs/Ecosystem.md>`__.

How to participate
------------------

IntelMQ is a community project depending on your contributions. Please consider sharing your work.

- Have a look at our `Developers Guide <docs/Developers-Guide.md>`__ for documentation.
- Subscribe to the Intelmq-dev Mailing list to get answers to your development questions:
https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-dev
- The `Github issues <github.com/certtools/intelmq/issues/>`__ lists all the open feature requests, bug reports and ideas.
- Looking for ideas which additional feeds you could add support for? The `Feeds whishlist <docs/Feeds-wishlist.md>`__ is the list you are looking for.
- Contribute code with pull requests (The `Github help <https://help.github.com/>`__ can be useful if you are not familiar with the system yet).
- Some developers are also on IRC: `channel #intelmq on irc.freenode.net <ircs://chat.freenode.net:6697/intelmq>`__.

Incident Handling Automation Project
------------------------------------

- **URL:**
http://www.enisa.europa.eu/activities/cert/support/incident-handling-automation
- **Mailing-list:** ihap@lists.trusted-introducer.org

Data Harmonization
------------------

IntelMQ use the Data Harmonization. Please read `this
document <docs/Data-Harmonization.md>`__ for more details.

How to participate
------------------

- Subscribe to the Intelmq-dev Mailing list:
https://lists.cert.at/cgi-bin/mailman/listinfo/intelmq-dev (for
developers)
- Watch out for our regular developers conf call
- IRC: server: irc.freenode.net, channel: #intelmq
- Via github issues
- Via Pull requests (please do read help.github.com first)

Licence
-------

0 comments on commit 4e6097d

Please sign in to comment.
You can’t perform that action at this time.