Skip to content

Reorganize Concepts section (and others) #2112

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

Merged
merged 5 commits into from
Jun 28, 2022

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented May 25, 2022

Purpose / why

I didn't think that the "Concepts" section made much sense with what it had in it. I rewrote the section with some new pages outlining what I think are the key islandora concepts:

  • nodes in islandora
  • media in islandora
  • derivatives
  • RDF

Then, I reorganized some of the files, putting more walkthroughs into the "Tutorials" section (which I renamed "walkthroughs"), and divvied the "Sysadmin documentation" into developer and user and contributing documentation.

I also created a section to discuss things like "collections" and "paged content" and hopefully "audio" "video" "image" and specifically "newspaper" - all the content types that have associated behaviours that people are going to want to see.

Verification

Does having the "concepts" like this make sense?

Interested Parties

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?

@rosiel rosiel changed the title Data model Reorganize Concepts section (and others) May 25, 2022
Copy link
Contributor

@islandora-community islandora-community left a comment

Choose a reason for hiding this comment

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

This PR makes important changes to improve navigation and content of concepts documentation. The derivatives diagram/lane representation is a great addition!

Islandora uses the [Portland Common Data Model (PCDM)](https://github.com/duraspace/pcdm/wiki)
to arrange elements
of the repository. Nodes correspond to pcdm:Objects, and Media to pcdm:Files.
The "Member of" field on nodes allows us to create pcdm:memberOf relationships
Copy link
Contributor

Choose a reason for hiding this comment

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

Checking - should this stay "Member of" or be referred to as field_member_of here?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm pretty happy leaving this in "user language" in this place.

@@ -0,0 +1,55 @@
# RDF in an Islandora Repository

Islandora was build on the idea that a repository can be represented
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we may need to replace "build" with "built" here?

@ysuarez
Copy link
Contributor

ysuarez commented May 31, 2022

I need to build the docs based on this PR to see the new proposed TOC order side by side with the current one, to help we weigh in on the new order better. So far I like what I see.

@islandora-community
Copy link
Contributor

Potential overlap with some content on the Resource Nodes and Media pages https://islandora.github.io/documentation/user-documentation/resource-nodes/ @inikolaidis

- 'Paged Content': 'user-documentation/paged-content.md'
# conceptual and procedural, repository managers/ curators
# move out procedural description for ordering pages
- 'Audio': 'models/audio.md'
Copy link
Contributor

Choose a reason for hiding this comment

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

These 2 pages on models (audio, video) are to be made still, correct? I don't think we have a corresponding page in our documentation for these yet

@kstapelfeldt kstapelfeldt merged commit e7b33ed into Islandora:main Jun 28, 2022
@kstapelfeldt
Copy link
Member

Thanks @rosiel for your awesome work.

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.

4 participants