Attribution Wizard: Documentation #1379
Conversation
USER_GUIDE.md
Outdated
| ` ... in folder content` sub-panels also show the number of resources in the folder that are linked to the shown | ||
| attribution. | ||
|
|
||
| The `Add to Attribution Sub-Panel` allows to add an existing attribution to the attributions of the selected resource. | ||
| As in the other panels, the details of the attributions can be shown by clicking on the respective list item, while the | ||
| attribution can be added by clicking on the corresponding **+ icon**. | ||
|
|
||
| ###### Attribution Wizard |
There was a problem hiding this comment.
Should have a bigger font size.
There was a problem hiding this comment.
True, however, in a logical sense, Attribution Wizard must be a subsection of Attribution Selection Column, hence it needs one hash more. But if no one has arguments against using one hash less, I can do it. I agree that is would look nicer this way.
| - Path of the selected resource (1). | ||
| - Breadcrumbs for navigation (2). Each breadcrumb corresponds to a step of the wizard. | ||
| - Package URL (3) that reflects the currently selected package attributes. | ||
| - Lists of aggregated package attributes (4), e.g., package namespace, name, and version (depending on wizard step). |
There was a problem hiding this comment.
no comma after "e.g."
There was a problem hiding this comment.
It depends whether we want to use british (without comma after e.g.) oder american style (with comma after e.g.). I would prefer the american style.
USER_GUIDE.md
Outdated
|
|
||
| <img src="./docs/user_guide_screenshots/attribution_wizard_doc_overview.png" width="550"/> | ||
|
|
||
| In the first step, package namespace and name can be selected. The list entries are sorted by count, i.e., the number of occurrences in the attributions and signals of the current resource and its descendents. New list entries can be added manually via the textboxes below the lists (5). New list items are marked with a star-icon and are displayed at the top of the list (6). |
There was a problem hiding this comment.
no comma after "i.e."
Propose: "New list items are marked"-> "Manually added items are marked..."
There was a problem hiding this comment.
Regarding i.e.: see above.
The proposal is good. I will consider it.
|
@vasily-pozdnyakov regarding your comment: What do you mean by that? The last three screenshots are about the attribution wizard, attribution view, and report view. Do you mean updating the last two images because the corresponding appearances in the UI hast changed? @lennartclaas : yes, the UI has changed. |
|
I created a new ticket for updating other images in |
USER_GUIDE.md
Outdated
| ` ... in folder content` sub-panels also show the number of resources in the folder that are linked to the shown | ||
| attribution. | ||
|
|
||
| The `Add to Attribution Sub-Panel` allows to add an existing attribution to the attributions of the selected resource. | ||
| As in the other panels, the details of the attributions can be shown by clicking on the respective list item, while the | ||
| attribution can be added by clicking on the corresponding **+ icon**. | ||
|
|
||
| ##### Attribution Wizard | ||
|
|
||
| The `Attribution Wizard` can be opened via the context menu of an assigned attribution. It aggregates information from attributions and signals of the current resource and its descendents and provides a structured overview. By clicking through the wizard, package namespace, name, and version can be selected and saved to the `Attribution Details Column` of the attribution from which the wizard has been opened. |
There was a problem hiding this comment.
I'd replace the context menu of an assigned attribution by the context menu of a manual attribution.
USER_GUIDE.md
Outdated
|
|
||
| - Path of the selected resource (1). | ||
| - Breadcrumbs for navigation (2). Each breadcrumb corresponds to a step of the wizard. | ||
| - Package URL (3) that reflects the currently selected package attributes. |
There was a problem hiding this comment.
that reflects the currently selected package attributes. -> that describes the currently selected package.
Add section about attribution wizard to USER_GUIDE.md. Fix: opossum-tool#1299 Signed-off-by: Lennart Holstein <lennart.holstein@tngtech.com>
lennartclaas
force-pushed
the
wizard-doc
branch
from
a90647c to
c6354e4
Compare
Add section about attribution wizard to USER_GUIDE.md.
Some minor changes in USER_GUIDE.md to reduce oversized images.
Fix: #1299