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

[uss_qualifier] improve documentation for op intent reference ACL validation #402

Merged

Conversation

Shastick
Copy link
Contributor

@Shastick Shastick commented Dec 13, 2023

This PR:

  • Splits the DSS0005 requirement into each of the 5 sub-items that it contains
    • Note that DSS0005 can still be referenced directly, as certain checks seem very coarse grained and it is not possible to attribute them to one of the sub-items – I guess this should be improved but is not in the scope of this PR)
  • Makes the documentation more precise by properly calling what we are creating on the DSS an "Operational Intent Reference" and not an "Operational Intent"

@Shastick Shastick marked this pull request as ready for review December 13, 2023 10:57
Copy link
Member

@BenjaminPelletier BenjaminPelletier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good; leaving unmerged to re-merge concurrent changes in main branch.

Note that DSS0005 can still be referenced directly, as certain checks seem very coarse grained and it is not possible to attribute them to one of the sub-items – I guess this should be improved but is not in the scope of this PR)

Yes, I think we should probably fix this, but also yes, not in scope of this PR. It is occasionally reasonable to have a parent requirement exist in addition to its broken-down children, but I think that should usually be the exception. In most (but not all) cases where we subdivide a requirement for F3411, the parent requirement is removed as something that can be validated against. I don't remember why we still have NET0470 as a linkable requirement given it is subdivided.

Makes the documentation more precise by properly calling what we are creating on the DSS an "Operational Intent Reference" and not an "Operational Intent"

Thanks for the clarification :) I'm pretty sure the precision will be appreciated by someone using the test in the future.

@Shastick
Copy link
Contributor Author

PR updated for doc to properly include the severity level

@BenjaminPelletier BenjaminPelletier merged commit f19fd29 into interuss:main Dec 15, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants