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

Improve the Packages Wiki page #1231

Open
Ana06 opened this issue Jan 9, 2025 · 0 comments
Open

Improve the Packages Wiki page #1231

Ana06 opened this issue Jan 9, 2025 · 0 comments
Assignees
Labels
📄 documentation Improvements or additions to documentation 🏃 CI Related to CI

Comments

@Ana06
Copy link
Member

Ana06 commented Jan 9, 2025

Details

Improve the Packages Wiki page introduced in #1197, after #1107 is completely addressed. Ideas:

  • Improve package descriptions. The package descriptions were not used before creating this page. Now that they are displayed to the users, we should ensure they are consistent, informative, short and not include version specific details. I suggest we start the description with the tool name (so that is clear which tool the package install) followed by a short description. We could even use markdown in the description to highlight the tool name, for example: **IDA Free** is the free version of IDA Pro, a powerful interactive disassembler and debugger.. This implies modifying most nuspecs, so I recommend implementing this in an independent PR.
  • Add package link. Make the name of the package clickable so that it takes to the package folder in this repository (or maybe the nuspec?).
  • Add tool link. Add projectUrl to the nuspec (only for the packages where there is a clear useful project URL) and link it in the wiki page (for example using the tool name in the description). This implies modifying most nuspecs, so I recommend implementing this in an independent PR.
  • Display packages in the FLARE-VM default configuration. This could be done by adding a column or using emojis after the package name. I think we should brainstrom how this exactly should look like in this issue before sending a PR.
  • Add license column. I think we should not display the license if it is unclear or likely to change, but we could do it for FLARE projects and for well established projects. We could implement it by adding a SPDX license expression in the license nuspec field and adding a new column to display it. We may want to discuss what exact package we want to display it for and how useful this would be before implementing it. This implies modifying most nuspecs, so I recommend implementing this in an independent PR.
  • At the moment, we regenerate the wiki page daily. After the page is finished (the rest improvements in this issue are implemented), we should consider updating the wiki page on merge if the workflow runs fast enough.

IMPORTANT: Any new convention in the nuspec needs to be documented in https://github.com/mandiant/VM-Packages/wiki/Chocolatey-packages#nuspec.

@mandiant/vms opinions? Any other ideas?

@Ana06 Ana06 added 📄 documentation Improvements or additions to documentation 🏃 CI Related to CI labels Jan 9, 2025
@Ana06 Ana06 added this to the FLARE-VM 2025 Q1 milestone Jan 9, 2025
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 🏃 CI Related to CI
Projects
None yet
Development

No branches or pull requests

2 participants