-
Notifications
You must be signed in to change notification settings - Fork 23
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
Add tutorial for symbol and string collection using /api/collect
endpoint
#411
Conversation
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@keshav-space Instructions are clear, I left some comments about some of the examples not having data in the extra_data
field.
docs/source/how-to-guides/tutorial_symbol_and_string_collection.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
Signed-off-by: Keshav Priyadarshi <git@keshav.space>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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! |