Improve READMEs #2
Conversation
Add link to Sylabs OpenAPI specification, and Go client module to 'Clients' section. Add Singularity Enterprise as commercial implementation, and move Sylabs Cloud Library to non-commercial implementations.
|
|
||
| The specification here is a community effort to document and maintain this application | ||
| programming interface. | ||
| programming interface. To support this effort, Sylabs has contributed the | ||
| [OpenAPI specification](https://github.com/sylabs/scs-library-client/blob/master/api/server/openapi.yml) |
There was a problem hiding this comment.
Question: Is there a way to render this link in a more human-friendly form?
There was a problem hiding this comment.
100%! Actually I do this with a bunch of pages for US-RSE - we can basically make a web request that retrieves and renders the spec, so we can keep it in one repository and render in another. Where should we put it - at the top of the current spec page rendered as yaml?
Let me know - I'm going to merge the charter and I can do a follow up PR with this.
There was a problem hiding this comment.
Note that there are a bunch of online sites that will render a nice view of an OpenAPI spec for you, e.g.
There was a problem hiding this comment.
There was a problem hiding this comment.
Right but isn't the idea to have it rendered in the same place as this repo (and not another site?)
There was a problem hiding this comment.
Or are you suggesting to take whatever libraries they use, and use them here?
There was a problem hiding this comment.
I think it's fine to just use that hyperlink, it doesn't have to be rendered here.
Add link to Sylabs OpenAPI specification, and Go client module to
Clientssection.Clarify that Singularity Enterprise is the commercial (for profit) implementation, not to be confused with the Sylabs Cloud Library, which isn't a commercial product (Sylabs operates that for free).