Lionfish Documentation Updates

[schrolla]

Description

This epic focuses on updating ScubaGear documentation during the Lionfish release cycle.

Improvements for this epic include:

• Adding new instructions for using the configuration file with Defender
• Adding a comprehensive sample ScubaGear configuration file
• Fixing out of date images in documentation
• Adding information on dependency min/max versions
• Adding instructions on how to upgrade to the latest ScubaGear version.

Initiative / Goal

The goal is to improve the usability of ScubaGear through more comprehensive and accurate documentation.

Hypothesis

By making the ScubaGear documentation more complete and fixing any errors, users will be able to use the tool more easily and take advantage of a broader range of its features.

Acceptance criteria

Criteria that are considered must have for completion and in-scope for this epic include:

• ScubaGear documentation has been updated to include the improvements listed above

Stakeholders / Resources

Include CISA decision makers and dev team members in discussions about this epic. Resources needed for this epic include GitHub and markdown readers as well as tool testing infrastructre to confirm that updating documentation is accurate.

Timeline

Lionfish release

Associated Tasks

See associated sub-issues