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

create links key at node level in registry #17

Merged
merged 8 commits into from
Jul 13, 2023
Merged

Conversation

mishaschwartz
Copy link
Collaborator

As suggested in #10, this does the following:

  • creates a links key for each node
  • replaces the url key with an entry in links (rel = service)
  • replaces the icon_url key with an entry in links (rel = icon)
  • requires a rel = version entry in links (refers to the /version endpoint)
  • requires a rel = collection entry in links (refers the the /services endpoint)
  • suggests other potential links values in the README.md file

Resolves #10

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
daccs_node_registry/update.py Outdated Show resolved Hide resolved
daccs_node_registry/update.py Outdated Show resolved Hide resolved
@dchandan dchandan requested a review from fmigneault July 12, 2023 14:55
README.md Outdated Show resolved Hide resolved
README.md Outdated
| `cite-as` <br> `publication` | Attribution by researchers to reference the node when using it for publications | |
| `copyright` <br> `license` <br> `terms-of-service` | Legal use of the node | |
| `describedby` | URL to full documentation and details of the node, its purpose and so on | |
| `edit` | A self-reference to https://github.com/DACCS-Climate/DACCS-node-registry or anywhere that the specific node registry entry to redirect users where to update it | |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I follow the wording of this entry.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'll do a little proofread/edit and make the wording a bit more consistent

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the node_registry.json file in this branch anymore?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we do. The node_registry.json in this file contains the static information and should be edited by node managers. The version in the current-registry branch has a superset of that info that includes all the data grabbed daily from the node endpoints and some additional metadata.

@mishaschwartz mishaschwartz merged commit d74e6fc into main Jul 13, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal of additional links for registered nodes
3 participants