Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change the word "backend" to "service"/"provider" in UI #55

Open
christophfriedrich opened this issue Mar 5, 2020 · 3 comments
Open
Labels
Milestone

Comments

@christophfriedrich
Copy link
Collaborator

To avoid confusion, what has so far been called "backend group" should be a "service provider" (or short "service" or short "provider"), and what has been called "backend" should be an "instance" or "implementation" (or maaaybe "version").

Reference from the API spec:

Well-Known URI (see RFC 57855) for openEO, listing all implemented openEO versions supported by the service provider. This allows a client to easily identify the most recent openEO implementation it supports.

This should be changed in the UI as well as in the code and the database 'schemes'.

@christophfriedrich christophfriedrich added this to the v0.5 milestone Mar 5, 2020
@christophfriedrich christophfriedrich self-assigned this Mar 5, 2020
@m-mohr m-mohr modified the milestones: v0.5, v0.6 Apr 22, 2020
@m-mohr
Copy link
Member

m-mohr commented May 8, 2020

I'm all in for UI improvements, but not sure about back-end changes if it's major work to do. If it's major work I'd prefer to just document it well enough and then leave back-end changes for later.

@christophfriedrich
Copy link
Collaborator Author

Thinking about it, this isn't as bad an issue as I thought a while ago.

I had a quick look again and found five occurrences of "backend" in the UI:

  • At the very top of the Discover section: "This is a list of all available openEO backends:"
  • In the production-readiness notice: "This backend is (NOT) production-ready."
  • In the outdated-data notice: "This backend was recently unavailable for crawling."
  • In the About section: "openEO hub is a tool to discover backends that support the openEO API.
  • Again in the About section, next paragraph: "The data is crawled from the backends and then cached, so may lag behind reality."

In none of these cases I find the word "backend" to actually be dramatic. In fact, using "implementation" instead of "backend" would probably confuse me more -- e.g. I would expect a "list of implementations" to contain links to software packages like on our Github page, not information on what some deployment of such a software package is capable of. And something like "This instance is production-ready" is probably more obfuscated to the average non-tech-savvy user than the current wording.*

The word "backend group" is not used in the UI at all, only internally.

Changing it in the code would be nice because all sorts of things are called backend at the moment (due to the natural growth/agile development of the project), but it would be quite a bit of work without actual benefit so I'll postpone this for (much) later.

Let me know if anyone thinks different on this matter.

* "Backend" is a rather normal word, isn't it? I use it all the time and assume that average users know roughly what it means, but thinking about it this may not be true for people outside our IT bubble... 🤔

@christophfriedrich christophfriedrich removed their assignment Jun 17, 2020
@christophfriedrich christophfriedrich modified the milestones: v0.6, v1.0 Jun 17, 2020
@m-mohr
Copy link
Member

m-mohr commented Jun 17, 2020

These occurances are easy to fix with two well-known words: provider and service.

  • At the very top of the Discover section: "This is a list of all available openEO backends:"

backends => providers

  • In the production-readiness notice: "This backend is (NOT) production-ready."

backend => service

  • In the outdated-data notice: "This backend was recently unavailable for crawling."

backend => service

  • In the About section: "openEO hub is a tool to discover backends that support the openEO API.

backends => providers or services

  • Again in the About section, next paragraph: "The data is crawled from the backends and then cached, so may lag behind reality."

backends => services

* "Backend" is a rather normal word, isn't it? I use it all the time and assume that average users know roughly what it means, but thinking about it this may not be true for people outside our IT bubble... 🤔

I rarely used backend before openEO. A word used more often is server, I guess. But for "normal" people service / provider should be better to understand. :-)

@christophfriedrich christophfriedrich changed the title Change terminology of "backend" and "backend group" Change the word "backend" to "service"/"provider" in UI Sep 8, 2020
christophfriedrich added a commit that referenced this issue Sep 9, 2020
For most people, "service" is more understandable than "backend". Also changed the wording of the introductory sentence in the DiscoverSection because this is not necessarily the list of *all* backends, just the ones we know of.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants