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

Update Config file documentation and document ability to add organizational metadata to the config file #1425

Open
buidav opened this issue Nov 13, 2024 · 0 comments · May be fixed by #1443
Assignees
Labels
enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@buidav
Copy link
Collaborator

buidav commented Nov 13, 2024

💡 Summary

Some organizations find value in adding these parameters such as organization name into the ScubaResults.json itself.
This issue is document how someone can do this and rewrite the conf file documentation a little bit to highlight the different types of config files.

Some suggested naming keys so far for these fields in the Config file.
OrgName
OrgUnitName

Motivation and context

Answering a request from an org that asked if this was possible.

Implementation notes

  • Add sample config file that shows how this can be done.
  • Update config file to show what these fields could be.

Acceptance criteria

  • A user is able to understand how to add additional fields to config file and note where the fields end in the ScubaResults.json
  • Documentation is updated to point to this new config file and more clearly illustrate the different types of config files.
@buidav buidav added the enhancement This issue or pull request will add new or improve existing functionality label Nov 13, 2024
@buidav buidav changed the title Document ability to add organizational metadata to the config file Update Config file documentation and document ability to add organizational metadata to the config file Nov 20, 2024
@schrolla schrolla added this to the Kraken milestone Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
2 participants