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 PURL services documentation #249

Closed
4 tasks done
pombredanne opened this issue Dec 13, 2023 · 6 comments
Closed
4 tasks done

Create PURL services documentation #249

pombredanne opened this issue Dec 13, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@pombredanne
Copy link
Member

pombredanne commented Dec 13, 2023

We should create and publish on RTD a comprehensive installation and usage documentation for the various PURL-based services of PurlDB. This should be backed by a publicly accessible demo system

@pombredanne
Copy link
Member Author

We would need some doc for the purlcli and some doc for each of the endpoints

@pombredanne
Copy link
Member Author

@johnmhoran @AyanSinhaMahapatra is this something you guys could get started?
Overall we would need some doc in the same style and structure as ScanCode.io?

@johnmhoran
Copy link
Member

@pombredanne I just saw this. Yes, I'd be happy to work with @AyanSinhaMahapatra on this -- we can start by finding a time to discuss general structure and content and see how the ScanCode.io RTD informs our work. I'll also need to learn what the various endpoints do and how we use them.

Unless you suggest otherwise, I would like to get a bit more of my PURL CLI work out of the way first since I'm still wrestling with the urls command, have not yet fully changed the four existing commands to the SCTK-like data structure, and have more commands to add (scan and git -- and perhaps others?).

@pombredanne
Copy link
Member Author

Some status update:

@pombredanne pombredanne self-assigned this Apr 5, 2024
@AyanSinhaMahapatra AyanSinhaMahapatra added the documentation Improvements or additions to documentation label Apr 8, 2024
johnmhoran added a commit that referenced this issue May 28, 2024
@johnmhoran
Copy link
Member

@pombredanne @AyanSinhaMahapatra As noted a bit earlier in purldb PR 436, I've added details to the existing purldb-toolkit RTD page re the use of the four current PURLCLI tools, with a mix of command and output examples and several related notes. The .rst is here:

https://github.com/nexB/purldb/blob/f49eff87ae9a4226584096498836de7d5015f6a2/purldb-toolkit/README.rst

The initial description above for this issue also says This should be backed by a publicly accessible demo system. What is this? Any examples or articles or a design doc?

johnmhoran added a commit that referenced this issue May 30, 2024
johnmhoran added a commit that referenced this issue May 31, 2024
Reference: #249
Signed-off-by: John M. Horan <[email protected]>
AyanSinhaMahapatra added a commit that referenced this issue Jun 3, 2024
Update purldb-toolkit and related README files #249
@pombredanne
Copy link
Member Author

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