Add tutorial for symbol and string collection using /api/collect endpoint#411
Add tutorial for symbol and string collection using /api/collect endpoint#411
/api/collect endpoint#411Conversation
keshav-space
commented
May 3, 2024
- Refrence PurlDB: purl2sym Packaging and documentation #330
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
JonoYang
left a comment
There was a problem hiding this comment.
@keshav-space Instructions are clear, I left some comments about some of the examples not having data in the extra_data field.
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
JonoYang
left a comment
There was a problem hiding this comment.
@keshav-space Thanks for updating the example to include more results, but I think some of the results can be truncated so the doc page isnt so large with example data. Other than that, I think it looks good.
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
@JonoYang I tried using ellipsis to truncate the JSON result, but that resulted in Sphinx throwing lexing error. Instead of truncating the results, I have changed the example to a smaller file, and we still have sufficient results to show from each tools. |
|
@JonoYang we found a way using the standard HTML |
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Reference: aboutcode-org/scancode.io#1220 Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
RTD.Tutorial.mov |
|
@keshav-space The toggle-able file contents looks great, thanks! |
Add tutorial for symbol and string collection using `/api/collect` endpoint