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

Create more documentation regarding tech/protocol types, diagram color legend, and usage of schema json etc. #13

Open
cschneider4711 opened this issue Feb 7, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@cschneider4711
Copy link
Member

This issue is to track the creation of aforementioned documentation

@cschneider4711 cschneider4711 self-assigned this Feb 7, 2021
@cschneider4711 cschneider4711 added the documentation Improvements or additions to documentation label Feb 7, 2021
@chujiaoma
Copy link

Hi, I was wondering where is the documentation regarding the protocol types? I'd also be interested to know more about how the different types of authorization for technical asset is defined and used? thanks.

@dAnjou
Copy link

dAnjou commented Jun 2, 2022

It'd also be super useful to know which fields and values have what kind of implication on the output. Like, how does the output change if I change confidentiality from internal to restricted, or doesn't that make a difference at all?

@cschneider4711
Copy link
Member Author

cschneider4711 commented Nov 4, 2023

First part of docs have been added via recent PRs (thx to @Thorsten-Sick ) and direct commits: Now several explanation switches on the CLI can be used to list these (basic still) explanations:

  -explain-model-macros
        Detailed explanation of all the model macros
  -explain-risk-rules
        Detailed explanation of all the risk rules
  -explain-types
        Detailed explanation of all the types

... each of them returning the details in the console then.

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
Projects
None yet
Development

No branches or pull requests

3 participants