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

Improve ABOUT file visibility in DejaCode #42

Closed
DennisClark opened this issue Feb 5, 2024 · 1 comment
Closed

Improve ABOUT file visibility in DejaCode #42

DennisClark opened this issue Feb 5, 2024 · 1 comment
Assignees
Labels
design needed Design details needed to complete the issue enhancement New feature or request HighPriority High Priority integration Integration with other applications
Milestone

Comments

@DennisClark
Copy link
Member

DennisClark commented Feb 5, 2024

ABOUT File Visibility and the DejaCode UI
DejaCode currently provides a simple and convenient interface that enables a user to generate an ABOUT file (and associated files) for a Package or Component; however, the DejaCode user does not actually see what the ABOUT file is going to look like or what it looks like after the file is generated. The ABOUT file is in the user’s file system, separate from the DejaCode application and its database; only the single user sees the ABOUT file unless it is shared with the user’s team by some other technology.

Consider a new tab in the Package details user view, perhaps called “ABOUT”, that offers a rendering of its ABOUT file exactly as it will appear in a generated .yml file. This “preview” would allow the user to evaluate the Package data as it exists in DejaCode, complete with any curations, before it is actually generated. The same “preview” would also provide an appropriate means to confirm the successful Import ( see #43 ) of an ABOUT file into the DejaCode database, where the Import would either create or update a Package identified by the PURL.

If a DejaCode user updates Package details, then after those changes are saved the proposed ABOUT tab would show any impact on the ABOUT file fields as a preview of an ABOUT file that can potentially be generated.

@DennisClark DennisClark added enhancement New feature or request design needed Design details needed to complete the issue integration Integration with other applications HighPriority High Priority labels Feb 5, 2024
@DennisClark DennisClark added this to the DejaCode 5.1 milestone Feb 5, 2024
tdruez added a commit that referenced this issue May 14, 2024
Signed-off-by: tdruez <tdruez@nexb.com>
@DennisClark
Copy link
Member Author

@tdruez the new feature looks great in Staging Starship, exactly as requested, thanks. Packages with varying amounts of details are correctly presented in the preview, updates are reflected in that preview, and the generation is exactly what is expected. No problems found.

tdruez added a commit that referenced this issue May 15, 2024
tdruez added a commit that referenced this issue May 15, 2024
Signed-off-by: tdruez <tdruez@nexb.com>
tdruez added a commit that referenced this issue May 15, 2024
Signed-off-by: tdruez <tdruez@nexb.com>
tdruez added a commit that referenced this issue May 15, 2024
Signed-off-by: tdruez <tdruez@nexb.com>
@tdruez tdruez closed this as completed May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design needed Design details needed to complete the issue enhancement New feature or request HighPriority High Priority integration Integration with other applications
Projects
None yet
Development

No branches or pull requests

4 participants