search

hbz / lobid

Linking Open Bibliographic Data
https://lobid.org/
Eclipse Public License 2.0
15 stars 4 forks source link

Add usage policy and warranty to lobid webpage #505

Closed kaena83 closed 9 months ago

kaena83 commented 9 months ago

The new usage policy and warranty for lobid should be included in the lobid web page. For this, several changes have to be made. Have a look into Figma in doubt. The modifications encompass 4 main points (see below).

1. New page for usage policy

2. New page for warranty

3. Modify the lobid start page

grafik

4. Modify the API documentation for each lobid service (lobid-organisations, lobid-resources, lobid-gnd)..

grafik

Phu2 commented 9 months ago

Do we have english versions of the usage policy and warranty already? For example, linking from http://lobid.org/organisations/api/en to the german usage policy does not meet the users expectation.

kaena83 commented 9 months ago

No not yet as far as I know. I suggested that too. I put it on the agenda.

acka47 commented 9 months ago

Not deployed yet. Reopening

Phu2 commented 9 months ago

@kaena83 @acka47 Please review http://stage.lobid.org/

@sroertgen Please have a look at the changes in gatsby https://github.com/hbz/lobid/pull/506

kaena83 commented 9 months ago

@Phu2 This looks all fine too me. Two things concerning the texts, perhaps @acka47 can give a feedback too in this regard:

  1. There are currently two headers for the usage policy http://stage.lobid.org/usage-policy/. Maybe we could delete one of them, e.g. "Richtlinien einer rücksichtsvollen lobid-Nutzung"? (also see Screenshot below)
  2. Maybe we could include the warranty additionally in the usage policy? That is, users of the API would not have to look for it separately. It´s not very likely that they will actively look for it in the menu at the end of the page.

Image

acka47 commented 9 months ago

There are currently two headers for the usage policy http://stage.lobid.org/usage-policy/. Maybe we could delete one of them, e.g. "Richtlinien einer rücksichtsvollen lobid-Nutzung"? (also see Screenshot below)

+1 IMO, we should replace "Richtlinien API-Nutzung" on top by "Richtlinien einer rücksichtsvollen lobid-Nutzung"

Looking into this, I currently see four <h1> headers. At least from Markdown I know that this is not good practice to habve more than one level 1 headiong (see e.g. https://google.github.io/styleguide/docguide/style.html#document-layout).

So, my suggestion would be to have only one `h1``on top, remove the h1 below the toc and make the other h1 h2s (and the sub headings h3 then).

Maybe we could include the warranty additionally in the usage policy? That is, users of the API would not have to look for it separately. It´s not very likely that they will actively look for it in the menu at the end of the page.

A link to the warranty would do it for me. Reading the warranty again I am not satisfied with the structure. E.g. I think the sentence "lobid ist nicht selbst Urheber der angebotenen Daten, sondern aggregiert und transformiert lediglich Informationen aus offenen und freien Quellsystemen Dritter." should come much earlier, maybe even as first sentence. But we can also rewrite this at a later stage.

Phu2 commented 9 months ago

What about the last paragraph "Empfehlungen zur Verbesserung des lobid-Angebots"? It sounds like a note to ourselves and not addressed to users.

Phu2 commented 9 months ago

The anchor links don't work. We need to install and configure the sub-plugin https://www.gatsbyjs.com/plugins/gatsby-remark-autolink-headers/

Phu2 commented 9 months ago

@kaena83 @acka47 Redeployed to http://stage.lobid.org/usage-policy/ with headings restructured and working anchor links. Do you want to add the link to the warranty? Please do as you like: https://github.com/hbz/lobid/blob/505-fix-usage-policy/gatsby/lobid/static/pages/usage-policy.md and review the last paragraph as i mentioned earlier Then i will deploy to stage and production. After that i will add the links from the other lobid pages (task 4. in the description).

kaena83 commented 9 months ago

What about the last paragraph "Empfehlungen zur Verbesserung des lobid-Angebots"? It sounds like a note to ourselves and not addressed to users.

This is true.

acka47 commented 9 months ago

Yes, the last paragraph is an internal note collecting possible improvements that came up when OpenCultureConsulting did the project. So we will have to delete it.

kaena83 commented 9 months ago

Alright, I delete it.

Phu2 commented 9 months ago

Again redeployed to http://stage.lobid.org/usage-policy/ @kaena83 @acka47 ready to go live? The link to http://lobid.org/warranty will be functioning afterwards.

acka47 commented 9 months ago

ready to go live?

Yes, thanks.

kaena83 commented 9 months ago

Ready.

Phu2 commented 9 months ago

Deployed to production https://lobid.org/. Links from other lobid services will follow soon.