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

Potential idea for discussion: re-arranging *Using Islandora* section [DOCS] #2154

Closed
mjanowiecki opened this issue Aug 11, 2022 · 6 comments
Labels
Type: discussion Identifies a topic for conversation - may be similar to a question. Type: documentation provides documentation or asks for documentation.

Comments

@mjanowiecki
Copy link
Contributor

I'm not sure how to link to it, but I'm looking at the section of documentation that is nested under https://islandora.github.io/documentation/user-documentation/

  • If this is a request for new documentation, where in the existing documentation does this documentation belong?

  • Describe your documentation request.

As a frequent user of the Using Islandora section of the documentation, I think it's a little unclear where to find specific information, especially if you are unsure what specific terms mean (like Context or Flysystem). For instance, if I'm looking for information on how to adjust how my content/repo items are viewed but I don't know what IIIF is or Context is, I might not know to click on those pages.

I was thinking that rearranging this section by function could be helpful to help newbie find what they are looking for. These are main functions I've thought of, but obviously we could pick different terminology or pick more.

  • Describe
  • View
  • Search
  • Handling files (idk how else to put this)
  • Administer

I've outlined a potential way to rearrange this section based on these functions and would love to talk with documentation folks to see if they think this could be helpful. Here's my preliminary idea -- again, would love a larger discussion on this. :)

  • Introduction
  • Describing content*
    • Content models (incorporate Resource Nodes page)
    • Metadata (incorporate Drupal Bundle Configuration page)
    • Linked data (incorporate RDF Generation page)
    • Metadata harvesting (renaming of OAI-PMH page)
  • Searching content
    • Search
    • Advanced search
    • Faceting
  • Viewing content
    • Context
    • Viewers
    • IIIF
  • Handling content files
    • Media
    • Large files
    • Flysystem
  • Administering Islandora
    • Access Control
    • Usage Stats
    • Versioning
    • Islandora Defaults
    • JWT Authentication
  • Accessibility in Islandora
  • Multilingual Islandora
  • Extending Islandora

*Note: For Describing content, Searching content, Viewing content, Handling content files, and Administrating Islandora, I wasn't envisioning these headers as actual pages necessarily... more as an organizing sections. But we could turn these into pages and add overviews if it would make sense.

  • Which version of islandora are you using?

Islandora 8

  • What user roles is this documentation intended for?

I think this documentation is mainly intended for a user or collection manager of Islandora.

  • What implementations of islandora does this documentation request apply to?

All?

Any related open or closed issues to this bug report?

Screenshots:

@mjanowiecki mjanowiecki added Type: documentation provides documentation or asks for documentation. Type: discussion Identifies a topic for conversation - may be similar to a question. labels Aug 11, 2022
@mjanowiecki
Copy link
Contributor Author

@rosiel I'm just tagging you Rosie because it seems like you have worked a fair amount on these sections and would love to hear what you think :)

@rosiel
Copy link
Member

rosiel commented Aug 22, 2022

I love it! I'd be happy to work with you on this.

@mjanowiecki
Copy link
Contributor Author

awesome! maybe I could do a draft and you could review?

@mjanowiecki
Copy link
Contributor Author

Ok, I did a draft but I somehow pushed it to an old patch of mine? https://github.com/Islandora/documentation/compare/mjanowiecki-patch-1?

@mjanowiecki
Copy link
Contributor Author

mjanowiecki commented Sep 14, 2022

How the sidebar looks in patch (approximately):
Screen Shot 2022-09-14 at 12 14 42 PM

@mjanowiecki mjanowiecki mentioned this issue Sep 15, 2022
7 tasks
@mjanowiecki
Copy link
Contributor Author

This is done now! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: discussion Identifies a topic for conversation - may be similar to a question. Type: documentation provides documentation or asks for documentation.
Projects
None yet
Development

No branches or pull requests

2 participants