Skip to content
This repository has been archived by the owner on Jun 10, 2024. It is now read-only.

UI docs and panel - terminology re: server name #90

Closed
planetf1 opened this issue Feb 24, 2021 · 7 comments
Closed

UI docs and panel - terminology re: server name #90

planetf1 opened this issue Feb 24, 2021 · 7 comments

Comments

@planetf1
Copy link
Member

In the README.md we have references to

  • Egeria React UI server & cra-server
  • Presentation Server
  • view server
  • remoteServerName
  • localServerName

We also have reference to a tenant

Also these, though I think the words stitch the usages together well enough & consistent with the main egeria docs

  • Egeria server
  • metadata server
  • Egeria OMAG Server

In a comment on a PR I asked:

Is 'serverName' the tenant name (ie coco) rather than the server?

Yes servername is the way we refer to tenants in Egeria. I will merge - if you think it needs more clarification then we can , make further amendments.

Originally posted by @davidradl in #88 (comment)

I understand this clarification, and it is technically consistent with the use of 'local server name' in the README, but I rather suspect it will be immensely confusing for any users of this UI

I think we need to reevaluate

  • terms like presentation server, local server, remote server, view server
  • ensure we add to a glossary if required (main egeria)?
  • Take care with using 'server name' on the UI -- that is a different user role from that configuring the software. - how will they know this info, what would they likely call it?
  • consider clarifying the environment variable.

I'm ok with the functioning & understand the term usage, but am concerned new users will find this very confusing.

@davidradl
Copy link
Member

@planetf1 yes that is fair. I think from the discussions yesterday - we need to move most of the readme content into core Egeria documentation; specifically into the admin guide and the development resources. When it is there we should link to the existing definitions of the words, and then add any new terms. Presentation server for me was the capability, but we have used it to refer to the egeria react ui (which we called the Git repo after we had started using the presentation server term). As to what the user would expect here, I am open to suggestions , I suspect we should call it server name or tenant name and have a help link to define exactly what it means. We expect users will usually be given the tenanted url, this screen is likely to be shown for a developer running in developer mode (as you did); hopefully this screen makes the experience a bit better than it was. Open to suggestions on the wordings.

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

@github-actions
Copy link

github-actions bot commented Sep 1, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

@github-actions
Copy link

github-actions bot commented Nov 1, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

@github-actions
Copy link

github-actions bot commented Jan 1, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

@github-actions
Copy link

github-actions bot commented Mar 6, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants