Publish usage guidelines

hbz / lobid

Linking Open Bibliographic Data

https://lobid.org/

Eclipse Public License 2.0

15 stars 4 forks source link

Publish usage guidelines #464

Closed acka47 closed 8 months ago

acka47 commented 3 years ago

There are lots of lobid API users, some of them quite heavy and several of them not giving credit to lobid as data source. It would make sense to create an API user guide with respect to the following questions (and probably more):

How to query lobid? What queries make sense for which use case (e.g. downloading dumps, single requests, getting updated files only)?
How to give credit in your application/dataset to lobid as data source?

hauschke commented 2 years ago

Suggestion: Include a CITATION.cff for https://doi.org/10.11588/ip.2019.1.52673.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

acka47 commented 11 months ago

By now, we have – thanks to @sebastian-meyer et al – a usage policy addressing different aspects, see https://pad.gwdg.de/s/entwurf-lobid-usage-policy. We will have to think about how to integrate it into the lobid.org website.

acka47 commented 11 months ago

This will probably have to be split into different issues as the four sections on general, technical, legal and feedback aspects won't be put onto one page.

kaena83 commented 11 months ago

This might be an approach:

The usage policy could be published on GitHub, as already done with the Data Protection Declaration.

Make the new policy visible on lobid startpage (see mockup): https://lobid.org/
Repeat analogously on startpages of lobid services (resources, organisations, gnd)
Make policy visible in API documentation of each service at top of page:

acka47 commented 11 months ago

The usage policy could be published on GitHub.

I'd like to see it as part of the webpage but this does not affect the other proposals. I like the approach but would leave out "neu" before "Nutzungs-Policy" so that it does not get strange after some months...

kaena83 commented 11 months ago

Yes, makes sense. Would "Hier finden Sie unsere Nutzungs-Policy." be ok? Or do you have another idea?

Who is responsible for making the changes on the lobid pages (so that I can assign them)? I would then write tickets for

a) the start page (lobid)

create new page for usage policy
add it in menu below (see mockup)
add hint in lobid page (see mockup)

b) lobid resources

add hint in start page of lobid resources (see mockup)
add hint in documentation of web api (see mockup)

c) lobid organisations

add hint in start page of lobid organisations (see mockup)
add hint in documentation of web api (see mockup)

d) lobid-gnd

add hint in start page of lobid gnd (see mockup)
add hint in documentation of web api (see mockup)

I will change the phrases accordingly, link to respective pages / draft of usage policy and write the wording out in the tickets so that it can be c/p.

Is this fine?

kaena83 commented 11 months ago

"Gewährleistung" should not be included in the Usage Policy and desplayed separately.

acka47 commented 8 months ago

This is done, see https://blog.lobid.org/2023/10/12/lobid-usage-policy.html . Closing