okfn / opendefinition

Open Definition source
https://opendefinition.org/
Creative Commons Attribution 4.0 International
108 stars 130 forks source link

Move licenses API docs to opendefinition.org #206

Closed chris48s closed 3 years ago

chris48s commented 3 years ago

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 https://github.com/okfn/licenses/pull/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.

rufuspollock commented 3 years ago

LGTM. Great to see this moving forward 👏 /cc @mlinksva