search

cisagov / Malcolm

Malcolm is a powerful, easily deployable network traffic analysis tool suite for full packet capture artifacts (PCAP files), Zeek logs and Suricata alerts.
https://cisagov.github.io/Malcolm/
Other
1.96k stars 327 forks source link

Typo in documentation - live-analysis.md #302

Closed un1c0rn-sec closed 7 months ago

un1c0rn-sec commented 7 months ago

🐛 Summary

There is a typo in https://github.com/cisagov/Malcolm/blob/main/docs/live-analysis.md

To reproduce

Steps to reproduce the behavior:

  1. Navigate to https://github.com/cisagov/Malcolm/blob/main/docs/live-analysis.md in a browser.
  2. Note the line generate and forward Zeek and Suricata logs, Arkime sessions, and other information to [Malcolm]({{ site.github.repository_url }})

Expected behavior

The word Malcolm in that line should be a proper hyperlink to its intended page.

Any helpful log output or screenshots

None, it's pretty self-evident.

un1c0rn-sec commented 7 months ago

There is a similar issue on https://github.com/cisagov/Malcolm/blob/main/docs/malcolm-hedgehog-e2e-iso-install.md

mmguero commented 7 months ago

Those replacers inside of the mustache brackets ({{ }}) are intentional, as they are populated when the official HTML documentation is rendered. For example, here's the page you listed..

When viewing them within the github repository tree, you are correct, you'll see the unresolved text. This is not a mistake, it's just not the documentation in its final form.

un1c0rn-sec commented 7 months ago

Oh, thank you for the clarification. My mistake.