dfir-iris / iris-doc-src Goto Github PK
View Code? Open in Web Editor NEWIRIS documentation sources
License: GNU Lesser General Public License v3.0
IRIS documentation sources
License: GNU Lesser General Public License v3.0
We will add this to the documentation repo instead
iris-doc-src/docs/getting_started.md
Line 58 in c2591c9
Originally posted by @whikernel in dfir-iris/iris-web#369 (review)
These remarks are all about the documentation page Processor modules, with respect to a v2.0.0-beta-1 version:
Thank you.
As specified here dfir-iris/iris-web#22, by @cudeso :
"""
According to https://dfir-iris.github.io/_static/iris_api_reference.html#operation/post-case-asset-add the fields asset_type_id and analysis_status_id require a string. However the API returns
"data": {"analysis_status_id": ["Not a valid integer."], "asset_type_id": ["Not a valid integer."]}
Supplying integers in the POST results in a successful request.
"""
As reported here dfir-iris/iris-web#20, endpoint manage/assettype/list
is missing in the API reference/
These are remarks about documentation page Modules:
bool
, float
, string
, sensitive_string
, textfield_json
and textfield_html
. But maybe there are more?Thank you.
Reported by @c8y3 - see dfir-iris/iris-web#159 (comment)
Here are a few typos found in the documentation pages:
https://docs.dfir-iris.org/development/: The sub-branches of develop contains either => The sub-branches of develop contain either https://docs.dfir-iris.org/development/: An issue fixe => An issue fix https://docs.dfir-iris.org/development/: This ensure a smooth migration between versions => This ensures a smooth migration between versions https://docs.dfir-iris.org/development/environment/: Then Pycharm need to be setup with a dedicated environment, by adding a new configuration => Then Pycharm needs to be setup with a dedicated environment, by adding a new configuration https://docs.dfir-iris.org/development/environment/: To do so, the app docker need to be erased and rebuilt => To do so, the app docker needs to be erased and rebuilt. https://docs.dfir-iris.org/development/code-tips/: IRIS does not defines a separate API for users => IRIS does not define a separate API for users https://docs.dfir-iris.org/development/code-tips/: It's often the page method itself except for modales => It's often the page method itself except for modals
It would be great to have acronyms link to some external explanatory page. For instance on page https://docs.dfir-iris.org/operations/modules/, EVTX could link to https://github.com/libyal/libevtx/blob/main/documentation/Windows%20XML%20Event%20Log%20(EVTX).asciidoc. Alternatively, a page with all acronym definitions would be nice. Such as VT: VirusTotal, MISP: Malware Information Sharing Project, IOC: Indicator Of Compromise, IR: Incident Response, DIM: DFIR IRIS Module...
By the way, what is the meaning of DFIR-IRIS?Lastly, on page https://docs.dfir-iris.org/operations/modules/, it would be nice to have "see Quick Start" be a link to the corresponding documentation page.
Thank you.
Here are a few issues with the REST API documentation.
Initially opened as dfir-iris/iris-web#165 (comment)
These remarks all concern the documentation page on hooks (https://docs.dfir-iris.org/development/hooks/):
register_hooks
is mentioned in this page, but it is only explained later in the Processor modules page (https://docs.dfir-iris.org/development/modules/quick_start/processor/). I suggest to move the documentation page on hooks down in the Modules section and after the Quick StartThank you.
These remarks are not really bugs in the documentation, but changes which will be needed to do for the future v2.0.0 release. They are discrepancies between the current documentation and the behaviour of the v2.0.0-beta-1:
Add module
button. The screenshot should be changed tooManage cases
, there is no more Update
tab. I guess, this is replaced by button Pipeline
in the Case
page?A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.