Move licenses API docs to opendefinition.org #206
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One of the objectives of this visual refresh is to bring the look-and-feel of https://licenses.opendefinition.org/ into line with the current OKFN branding.
There are two long-standing issues at
where moving the API documentation out of the seperate site/repo and into the main Open Definition site/repo is discussed. These issues broadly seemed to gain some approval from the community but were never really actively worked on. Now seems like a good time to revive this plan though as by far the easiest approach to updating the styling there is to move that one page of content into this repo.
As such, I've grabbed the documentation from https://github.com/okfn/licenses/blob/master/index.html and moved it over to this site (updating where appropriate) and left all the JSON/data where it is. I've also submitted a companion PR over at okfn/licenses#93 replacing the index page on licenses.opendefinition.org with a client-side redirect to https://opendefinition.org/licenses/api/ (which doesn't exist yet, but will once this is merged).
This doesn't fully close either of the referenced issues as there was also some additional discussion there around changes to the API/data. I have not addressed these here.