Comments (14)
I'm not sure the utility of this. licenses.opendefinition.org and opendefinition.org are served by different technologies (? and wordpress). Seems fine to have separate repos modulo any bigger reorg. Closing for now, would be part of bigger reorg open in #5
from opendefinition.
At AC call we agreed to proceed with this. Basic approach in description above.
from opendefinition.
I wonder whether we want to deploy at api.opendefinition.org given that existing site will remain on wordpress for forseeable future ...
from opendefinition.
Much of relevant discussion on this is in #27
from opendefinition.
Moving thread here from #27 (comment)
@mlinksva so I think we probably do want to get rid of the html stuff at licenses.opendefinition.org and if we do have the API we may as well have it here (even if we submodule in ...)
So, next steps:
- Strip down licenses repo to be bare bones
- Do we still include all the jsonp stuff? Seems like we should to keep it simple but we then either won't have jsonp support here (not the end of the world) or would have to fake it here which seems a bit of a PITA (but not the end of the world). @mlinksva thoughts?
- Submodule it here somewhere nice e.g. api/v1/... or something
- Beauty here is we can submodule the same repo at different revisions multiple times to do versioning :-)
- Redirect licenses
Questions:
- Do we still want the nice "home page" for the API
- Do we still want the nice license listing?
The proposed API
opendefinition.org/api/v1/{license-id}.json
# groups stuff
# this is one option
opendefinition.org/api/v1/all.json
# alternative is to follow existing practice on licenses.opendefinition.org
opendefinition.org/api/v1/groups/all.json
from opendefinition.
Is there any need for jsonp? If not, scrap.
What is the point of json files by group? Seems that any client can fetch all.json and filter on whatever properties they wish to. Another alternative is
/api/v1/license/{license-id}.json
/api/vi/all.json
I don't know if there's any need for a HTML frontend. Currently licenses.opendefinition.org serves as documentation and a kind of quasi-chooser. Desired? Or maybe people should be looking at opendefinition.org/licenses as the ... one place to look. No strong opinion.
from opendefinition.
- jsonp - it means browser clients can load. I don't know use / need so i guess we scrap for present based on KISS
- Re groups: guess we could drop though certainly getting all in one is sort of useful ... (or alternatively being all to find a list of all the other files).
from opendefinition.
updated description with current proposal as to what happens
from opendefinition.
Can I suggest a simple solution to provide a machine-readable list of open licences and urls as this issue seems stalled...
Publish the licences as a CSV by OKI on datahub.io. If it's published as a CSV, then an API is generated.
In fact, unmaintained versions are:
- published as JSON on datahub.io
- and also on GitHub https://github.com/okfn/licenses
@rufuspollock @mlinksva
So if I fixed this, what's the true data source and preferred destination? Would you like me to proceed?
from opendefinition.
@Stephen-Gates basically yes! The main thing to complete actually right now is okfn/licenses#45 - let's get the licenses repo fixed and then we can publish straight into datahub.io as you suggest.
from opendefinition.
Ok I'll look into it over the weekend
from opendefinition.
So we now have an up-to-date licenses.csv and datapackage.json being checked by goodtables.
To nudge this work (and the related issue) along, here's my suggestion...
Open Licenses Service
- becomes an exemplar data package:
- licenses.csv (continuously validated)
- datapackage.json (follows versioning pattern)
- readme.md
- contains scripts to:
- has a githhub readme focused on using the data
- full set of community files to assist with contributions
- all other content removed
Open Definition site
- Licence approval process is updated to reflect that licenses.csv is updated as a result of the review process
- Filtered views of licenses.csv are shown on :
This would result in some loss of information e.g. the BY
, SA
and Comments
columns in the existing tables. This may result in adding columns to licences.csv.
Licences.csv changes
Consider changes to licenses.csv to:
- Add
BY
,SA
andComments
columns from the existing tables in Open Definition. - Add icon attribute to licenses #5
- Add uri to licenses #6
- define the family field, and the similar licenses #54
- Add a description for each field in the datapackage.json schema #64
but be careful to communicate, or avoid, breaking changes.
Next Steps
- determine what changes are required to support presenting filtered views of licenses.csv on the Open Definition site (consider data package views)
- make those changes
- update the Open Definition site
- consider the remaining suggestions
Thoughts?
from opendefinition.
I'd rather have the data package derived from:
- SPDX (this is where the most concentrated effort to curate info about licenses is, a shame to not leverage that)
- Open Definition (adding individual license records as Jekyll collection there would be one way to do it; I feel that we need to uplevel documentation around approval and making a CSV canonical would go opposite direction)
- Wikidata
Derived probably means a script to collect info from those sources and shove into a CSV or whatever data packages want.
That said feel free to proceed as I don't know when I'll get around to fleshing out above.
from opendefinition.
@mlinksva @Stephen-Gates this sounds good - i'm happy for Stephen to proceed with Mike's guidance.
from opendefinition.
Related Issues (20)
- Broken second-level markdown headers HOT 2
- Typo on http://opendefinition.org/od/2.1/en/
- A few broken license pages HOT 4
- Uncool URL
- Definitions' dates? HOT 2
- Open Definition 2.1 in Spanish HOT 1
- An open licence should be published openly HOT 9
- Rename "Indonesian" to "Bahasa Indonesia" HOT 1
- www & licenses sub domains unavailable HOT 5
- Adding the EPL v2 to the list of known licences HOT 1
- Older versions are not accessible? HOT 1
- Consider evaluation of licensing terms and best practices for their declaration HOT 1
- Maximise should be maximize HOT 2
- okfn-discuss doesn't exist anymore but approval process cites it HOT 1
- Document discussion/approval of submitted licenses with links on /licenses/
- My
- Deutschlandlizenz ( Data Licence Germany) 2.0: missing SPDX IDs perhaps not missing? HOT 2
- Wrong SPDX identifier for older Creative Commons Attribution-ShareAlike licenses HOT 1
- Design update to match new OKFN brand guidelines
- fork all to [hayzlee11] HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from opendefinition.