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 USAGE document microlibrary to filter out deprecated relationships appropriately #14

Merged
merged 1 commit into from
Nov 7, 2021

Conversation

jondricek
Copy link
Contributor

Fixes #12

As far as I can tell, this should address the microlibrary issue in the USAGE.md file

@jondricek jondricek requested a review from isaisabel October 27, 2021 03:54
Copy link
Contributor

@isaisabel isaisabel left a comment

Choose a reason for hiding this comment

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

Overall looks good. I have one possible improvement to the imports on the microlibrary, but that's very much an optional improvement so I'm marking this as "approved."

One other thing to note: the microlibrary is also included in the USAGE document on MITRE/CTI. We had apparently fixed this bug already over there (and forgotten to propagate the fix to this copy of the USAGE), but we might want to update that document so that they have the same implementation, especially since your solution is cleaner than what we have on MITRE/CTI.


We also should consider the long term maintenance plan of the two usage documents, the fact they're maintained in parallel means it's easy to accidentally forget to propagate a correction to both.

We may want to remove the MITRE/CTI USAGE document and replace it with a link to this document so we don't have to maintain two in parallel. This instance of the document includes information about the ATT&CK Spec features not available in the STIX 2.0 dataset so they're not completely identical, but the STIX 2.1 additions are clearly marked so it should be OK to remove the MITRE/CTI USAGE in favor of a single document on this repo:

Screen Shot 2021-10-27 at 8 21 32 AM

USAGE.md Show resolved Hide resolved
USAGE.md Show resolved Hide resolved
USAGE.md Show resolved Hide resolved
@jondricek
Copy link
Contributor Author

As you already saw, I had added an issue on the MITRE/cti repo about keeping the two documents in sync. I like the idea of maintaining a single document here and just referencing it from the MITRE/cti repo. Given your approval, I'll go ahead and merge this PR now.

@jondricek jondricek merged commit b92b5b9 into master Nov 7, 2021
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.

Relationships microlibrary Filter argument
2 participants