Commit graph

15 commits

Author SHA1 Message Date
Juliana Fajardini
18e0d23ed3 docs: remove mentions to Suricata-6
Task #7262
2024-09-23 18:59:26 +02:00
Juliana Fajardini
08eb67f74c devguide: make 'contributing' a chapter
This could be justified from a semantic point of view, and also can help
in bringing more attention to where this information is, as it is less
hidden, now.

Also add Dev Guide as one of our resources in our Readme.
2024-01-04 15:51:21 +01:00
Shivani Bhardwaj
0a4011655f doc/code-submission: add commit sign guide 2023-10-06 21:28:12 +02:00
Juliana Fajardini
765b05f139 docs: miscellanea updates
- Fix a DPDK reference link, add some line breaks.
- Exemplify what a good commit message looks
like, for Suricata's commit style.
2023-08-03 08:34:35 +02:00
Juliana Fajardini
24745b3a73 doc/userguide: update ref to installation from git
It was still pointing to the redmine wiki and the documentation to be
truthful to the new documentation.
2023-07-15 17:14:43 +02:00
Philippe Antoine
e30f4943ae doc: GitHub PRs workflow 2023-06-08 19:56:37 +02:00
Jason Ish
f8620d0ed2 docs: update url to docs.suricata.io 2023-05-30 12:21:05 +02:00
Victor Julien
c0d9b3c078 doc/userguide: spelling 2023-05-06 14:50:43 +02:00
Juliana Fajardini
ae2a477978 devguide: clarify clang formatting changes policy
It was pointed out by a contributor that our workflow mentioned
rewrite-branch as the preferred way, while in fact our policy is to add
said changes to a different commit. Updating documentation to prevent
other situations like that.
2023-05-05 11:03:13 +02:00
Juliana Fajardini
4c7ca2c367 devguide/install: add note about ubuntu version
We want to make it clear with which system the instructions for
installing from were tested with.
2022-12-22 10:33:01 +01:00
Bazzan Don
6e4a5cee7a devguide: add page on installing suricata from git
As part of the process of moving documentation from redmine
to "Read the Docs", this commit moves installing Suricata using git
page from redmine wiki into Suricata Developer Guide section.
It also updates the necessary steps.

Ticket: #5585
2022-12-08 09:18:38 -03:00
Victor Julien
2f6c014f70 doc/devguide: update packet (de)alloc in unittests 2022-10-25 10:39:10 +02:00
Juliana Fajardini
3c25185e0b devguide: add section about stale tickets policy
Just to set the right expectations, and to have it registered for us,
too.
2022-10-13 11:25:42 +02:00
Juliana Fajardini
45b7aad2b5 devguide: incorporate contribution process page
That page existed only in our redmine. Updated and added a few things,
like a paragraph about our expectations for feature contributors.

Also updated links, contacts and some other processes that may have
changed since last edition.

Added some section labels in related documents, for ease of referencing.

Task #4929
2022-06-29 09:22:34 +02:00
Juliana Fajardini
6f77c722a2 devguide: move into userguide as last chapter
Moved devguide dir into userguide dir.
Since the devguide is now incorporated as the last chapter of the
userguide, removed build and configuration files from the devguide
dir, as these are no longer needed.

Task #4909
2022-03-29 07:56:03 +02:00