Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation issues #9

Open
whikernel opened this issue Jan 6, 2023 · 0 comments
Open

Documentation issues #9

whikernel opened this issue Jan 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@whikernel
Copy link
Contributor

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.

@whikernel whikernel added the documentation Improvements or additions to documentation label Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant