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.

Sign up for GitHub

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

Jump to bottom

Added a section about the field data type Authority Link #2146

Merged
merged 3 commits into from
Aug 10, 2022
Merged

Added a section about the field data type Authority Link #2146

merged 3 commits into from
Aug 10, 2022

Conversation

mjanowiecki
Copy link
Contributor

I am pretty sure this is an Islandora-specific data type, but I could not find out what module it is associated with.

I also think this metadata page is starting to get unruly in terms of length. Can we make a separate page to talk about Field Data Types?

Purpose / why

There is no documentation yet about the Islandora Authority Link data type.

What changes were made?

I added a section describing the Authority Link field data type, as well as a subsection describing how to configure the field Authority Sources. I included two screenshots from the sandbox.

Verification

I'm not sure what this section means?

Interested Parties

  • @Islandora/documentation
  • @Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The person merging should ensure the following:

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@mjanowiecki
Added a section about the data type Authority Link
b6c2376 
I am pretty sure this is an Islandora-specific data type, but I could not find out what module it is associated with. 

I also think this metadata page is starting to get unruly in terms of length. Can we make a separate page to talk about Field Data Types?
@mjanowiecki mjanowiecki added the Type: documentation provides documentation or asks for documentation. label Aug 1, 2022
@mjanowiecki
Copy link
Contributor Author

Partially addresses ticket #1280

@mjanowiecki mjanowiecki added the Subject: Metadata related to metadata issues. Consider also using the search tag. label Aug 1, 2022
rosiel
rosiel reviewed Aug 2, 2022
View reviewed changes
docs/user-documentation/metadata.md Outdated
@@ -83,11 +83,35 @@ Each of these vocabularies has its own set of fields allowing repositories to fu

The vocabularies provided by default are a starting point, and a repository administrator can create whatever vocabularies are desired.

## Field Types
## Field Data Types
Copy link
Member

Choose a reason for hiding this comment

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

I think this section is about Drupal's field types. I find 'Field Data Types' to be ambiguous. It might refer to the data type of the value as stored in the database, which is different from (and hidden, to an extent by) the field type.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense, I was just going off what Drupal called them. Happy to keep as is

@rosiel
Copy link
Member

rosiel commented Aug 2, 2022

This is awesome, thank you! And much needed! I just had some notes on terminology. Happy to discuss!

@mjanowiecki
Copy link
Contributor Author

@Islandora/documentation Hi all, this branch now has conflicting files and I'm not savvy enough with GitHub to figure out how to resolve the conflicts...

@seth-shaw-asu
Copy link
Member

Conflict resolved. Although, now that I look at past comments, perhaps I should have kept the original section heading! Sorry!

@ysuarez ysuarez merged commit 30b4db7 into main Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rosiel rosiel rosiel left review comments

Assignees
No one assigned
Labels
Subject: Metadata related to metadata issues. Consider also using the search tag. Type: documentation provides documentation or asks for documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mjanowiecki @rosiel @seth-shaw-asu @ysuarez @islandora-community