See this menu.

As the original author of "Dive Deeper into Hyrax" and "Design Patterns in Hyrax," I'm going to say that these are not resources for new users. They could be stashed under development resources. But they probably ought to be just links to the original slideshows. In their present form, they are not suitable as text only resources, they were slides from a talk and are missing lots of context.

Descriptive summary of request

dfdsds
Include a detailed description of the documentation issue you are submitting. Include
the version of software (Sufia, Hyrax, Hyku, etc.) that you are working in.
asdsa

Existing Docudsmentation

If you are submitting an issue related to existing documentation, include an "Existing Documentation" section
with link(s) to the document in question and describe what is incorrect. If possible, offer suggested
changes.

Expected Document

If you were unable to find relevant documentation for your issue and are submitting a request for new documentation,
include a general summary in "Expected Document".

Related work

If available, include a link to the software issue or PR in "Related Work".

Tags

When possible, please tag your issue with the provided labels:

• Change to Documentation
• Documentation Request (for new documentation)
• Question (when submitting a general question)

WIP: https://github.com/projecthydra/projecthydra.github.io/blob/mediated_deposit/pages/hydra/developer_resources/workflow_and_mediated_deposit.md

Background: The current theme is pretty basic. We need one that can handle much more content, and looks pretty.

Done when:

• layout is decided upon. UPDATE:: Use "Knowledge-base" layout
• theme is applied

work-in-progress:

New? Start here.
Get up and running, debugging, core concepts, submitting PRs

Coding Hyrax
How to do all the things, best practices, tutorials, architecture

Production
Hardware considerations, deployment, AWS hosting

Community
Contributing, conferences, interest groups, working groups

See https://github.com/projecthydra/sufia/wiki/Making-Admin-Users-in-Sufia for Sufia guide

Descriptive summary of request

Fill in content for how to submit PRs.

Existing Documentation

Stubbed page: https://github.com/samvera/samvera.github.io/blob/master/pages/hydra/developer_community/how-to-pr.md

Documentation exists on the Hyrax wiki pages. Can copy most of the content from there.

And what's the slack integration for this?

Do we want to allow users to access documentation for past releases? Such that adopters of earlier releases continue to have access to the appropriate documentation.

As an example, for the Customize Metadata tutorial (PR #36), the tutorial has a parent directory (customize-metadata) and a subdirectory for the Hyrax version (customize-metadata/hyrax-1.0). The actual files of the tutorial are Inside the hyrax-1.0 directory.

I wasn't sure if putting the release directory at the tutorial level vs. putting it at the highest directory level is most appropriate.

Highest level:

This would allow a user to switch to a release and have a side menu that is specific to that release with only documentation for that release. This may result in some documentation being copied for a major release that is exactly the same as the previous release documentation.

At the tutorial level:

It seems like some of our documentation will change with major (hyrax-1) or minor (hyrax-1.0) releases and some may be more stable. Also, some may be Hyrax specific, some may be PCDM specific, some may be specific to lower components of the stack.

Thoughts?

Blacklight generates app/models/search_builder.rb into your application. It defaults to including Blacklight::Solr::SearchBuilderBehavior which are functions to allow blacklight to talk to solr (vs another search engine). Hydra generates include Hydra::AccessControlsEnforcement for filtering
searches by access (groups & users). Finally Hyrax generates include Hyrax::SearchFilters which overrides the hydra filters and allows users with the admin role to see all documents.

Hyrax then sets the blacklight_config.config.search_builder_class = Hyrax::CatalogSearchBuilder in the catalog controller. This enables the public search to not show works that are suppressed (in workflow) and to find a work if an attached file matches the search query.

Hyrax::CatalogSearchBuilder inherits from Hyrax::SearchBuilder
https://github.com/projecthydra-labs/hyrax/blob/master/app/search_builders/hyrax/catalog_search_builder.rb (This class should be removed because it's basically the same as ::SearchBuilder)

Hyrax::SearchBuilder inherits from Blacklight::SearchBuilder
https://github.com/projecthydra-labs/hyrax/blob/master/app/search_builders/hyrax/search_builder.rb

Blacklight::SearchBuilder is a plain old Ruby object
https://github.com/projectblacklight/blacklight/blob/v6.8.0/lib/blacklight/search_builder.rb

I don't have an existing AddToCollectionActor defined in my app, should I?

$ ls app/actors/curation_concerns/actors/
book_actor.rb

$ ls `bundle show curation_concerns`/app/actors/curation_concerns/actors/
abstract_actor.rb           apply_order_actor.rb            embargo_actor.rb               lease_actor.rb
actor_stack.rb              assign_representative_actor.rb  file_actor.rb                  root_actor.rb
add_to_collection_actor.rb  attach_files_actor.rb           file_set_actor.rb
add_to_work_actor.rb        base_actor.rb                   interpret_visibility_actor.rb

Maybe make it clearer you're looking at a file from the gem directory since everything else has been within cc-sample?

Add an A-Z index

Add an A-Z index that includes all terms that can lead to a page. For example, the index could include entry Rubocop and entry Coding Styles, both of which would link to the documentation Coding Best Practices -> Coding Style with RuboCop.

Done when: Existing tutorials under http://projecthydra.github.io/training/ are not front and center on the homepage (like they currently are), but WITHOUT CHANGING ANY OF THE LINKS!!

app/forms/curation_concers/book_form.rb

is missing an 'n', it should be

app/forms/curation_concerns/book_form.rb

Descriptive summary of request

The Customizing Metadata tutorial says it is for Hyrax version 1.0, but at least some, if not all, links to files go to the master branch. They should link to the code in the 1-0-stable branch.

Existing Documentation

Picking one page at random:

• https://github.com/samvera/samvera.github.io/blob/master/pages/hydra/developer_resources/customize_metadata/hyrax_1.0/controller.md - The link to works_controller_behavior.rb goes to the master branch. (Near the bottom of the file in the Presenter Class section.)

There are probably incorrect links in all the files.

Related

• Add copy of this documentation for Hyrax 2.0 which can point to master for now, but eventually will point to 2-0-stable.

Descriptive summary of request

Include a detailed description of the documentation issue you are submitting. Include
the version of software (Sufia, Hyrax, Hyku, etc.) that you are working in.

Existing Documentation

If you are submitting an issue related to existing documentation, include an "Existing Documentation" section
with link(s) to the document in question and describe what is incorrect. If possible, offer suggested
changes.

Expected Document

If you were unable to find relevant documentation for your issue and are submitting a request for new documentation,
include a general summary in "Expected Document".

Related work

If available, include a link to the software issue or PR in "Related Work".

Tags

When possible, please tag your issue with the provided labels:

• Change to Documentation
• Documentation Request (for new documentation)
• Question (when submitting a general question)

Hi @elrayle, the build failed in production with the gem in place. Would you like to tackle making it work there? It didn't generate useful error messages ("build failed"), and I put in a ticket to Github support about it. It's possible adding Travis would give us the verbosity we need to solve it.

Background: Original tutorial is here: https://github.com/projecthydra/sufia/wiki/Customizing-Metadata

This needs to be modified to apply to Hyrax (as opposed to Sufia).

Also, we need to identify a good location for where it should live within the layout.

Done when:

• Tutorial has been modified to apply to Hyrax.
• Content has been added to the appropriate location.

Descriptive summary of request

Add https://github.com/projecthydra/sufia/wiki/Coding-Conventions information to http://projecthydra.github.io/best-practices-coding-styles.html

Maybe add this to quality practices on the projecthydra.github.io site?
http://projecthydra.github.io/quality.html

Suggestion from @jrochkind

Specifically "what do I do when rubocop says my code is wrong?"

This could include

• autofixing
• disabling in source code http://rubocop.readthedocs.io/en/latest/configuration/#disabling-cops-within-source-code
• using rubocop_todo.yml
• disabling cops for the whole project.

Add this content (and get it reviewed) https://github.com/projecthydra/curation_concerns/wiki/Solr-Search-Builders in How Search Works section.

The slide viewer puts a hard return in the line:

$ cp `bundle show curation_concerns`/app/views/curation_concerns/base/_attribute_rows.html.erb
app/views/curation_concerns/books/

Probably nothing to fix, but just be aware that some people (like me) might get an error when they try to cut and paste:

vagrant@camper:~/cc-sample$ cp `bundle show curation_concerns`/app/views/curation_concerns/base/_attribute_rows.html.erb

cp: missing destination file operand after ‘/home/vagrant/.rvm/gems/ruby-2.3.1/gems/curation_concerns-1.6.1/app/views/curation_concerns/base/_attribute_rows.html.erb’
Try 'cp --help' for more information.

vagrant@camper:~/cc-sample$ app/views/curation_concerns/books/

See this google thread for where to start:

https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/hydra-tech/Uj1bSMDTuFc/S67r7jp2FQAJ

See this thread on the list:

https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/hydra-tech/jLxZt3NsLyo/Zr0o3SCMFAAJ

https://help.github.com/articles/sitemaps-for-github-pages/

Current slide 6 is confusing:

• Has confusing "c/" and "o/" prefixes
• Has "GenericWork" instead of "Work"
• Typo: s/Thubnail/Thumbnail/
• Outdated term: s/GenericFile/FileSet/
• Outdated term: s/Content/OriginalFile/

I've made these corrections here, so feel free to grab a screenshot and use it: https://docs.google.com/drawings/d/1if47TYgEhqDLPh3D0026B_cBLa0BEAOpWPs8AqoQMZE/edit

The default ones could be improved upon

Possible options:

👍
⚙️
🔨

Targeted patterns:

• Forms
• Presenters
• Actors
• Indexers
• SearchBuilders
• Background Jobs
• Services
• Helpers

anything else?

We need to have a page that compares and contrasts the various usages of the overloaded term 'roles'.

• workflow roles
• admin set participants
• role manager roles

How do these relate to other features (e.g. workflows, admin sets, abilities control, etc.)?

Group-Sourced Content: Workflows & Mediated Deposit

Issue goal:

To complete documentation re: Workflows by answering these questions in the Q&A workflow section.

Current Questions

• How do I set up an app to use a given workflow by default?
• How do I diagram and configure a new workflow?
• How do I test that all of this is working correctly?

Feedback Needed

Do you have additional questions regarding workflows & mediated deposit?

• Add your question below.

Do you have experience in any area regarding workflows?

• Write your information in a comment below, or tell us a bit about what you know and you will be contacted to compile your info into a documentation page.

Here is the original, editable doc for the architecture diagram:

https://docs.google.com/drawings/d/141c_uuLdKqCWadMhGRxq9XHKlsjeiyLAAUYAU_LdwFE/edit

• Update it with new name
• Send new version to Richard Green for use on the new project website
• Update the version in our docs site

@escowles wrote some good technical onboarding docs, here: https://github.com/escowles/technical-onboarding/

These should be incorporated into the officially maintained docs

• Add the content
• Check @escowles's docs against what we've incorporated, and check for updates
• Ask @escowles what he thinks and ask for feedback

Done when: the following questions are answered:

• can we have notifications from SO sent to Slack channel?

By default Hydra ships with a YAML based group management system. Typically this is only used when learning Hydra and you might replace it with something such as https://github.com/projecthydra/hydra-role-management , https://github.com/RolifyCommunity/rolify or https://github.com/projecthydra-labs/hydra-ldap.

To change the groups in the default YAML implementation, you want to edit config/role_map.yml. That file should look something like this:

development:
  archivist:
    - [email protected]

test:
  archivist:
    - [email protected]
    - [email protected]
    - [email protected]
  admin_policy_object_editor:
    - [email protected]
  donor:
    - [email protected]
    - [email protected]
  researcher:
    - [email protected]
    - [email protected]
  patron:
    - [email protected]
    - [email protected]

production:
  # Add roles for users here.

If we want to add ourselves as to the admin group we could make this change:

development:
  admin:
    - [email protected]

We can change the groups implementation (default is RoleMapper) by setting

User.groups_service = MyCustomService

The original implementation of that class is here: https://github.com/projecthydra/hydra-head/blob/master/hydra-access-controls/lib/hydra/role_mapper_behavior.rb

Slide touring_design_patterns/#slide-24

WEBrick::HTTPServer#start: pid=5962 port=3000
Listening on tcp://0.0.0.0:3000

After I restart the rails server and try to create a new book, I get the error below. Did I miss copying something or get a namespace wrong somewhere?

NameError in CurationConcerns::BooksController#create
uninitialized constant CurationConcerns::Actors::ActorFactory::MetadataEnrichmentActor

Extracted source (around line #5):

class CurationConcerns::Actors::ActorFactory
  def self.stack_actors(curation_concern)
    [MetadataEnrichmentActor,
     AddToCollectionActor,
     AddToWorkActor,
     AssignRepresentativeActor,

Descriptive summary of request

We need a page here about choosing predicates, how to do it, what the options are, what might guide your choices.

Existing Documentation

There is this document, that could be formatted as a jekyll page pretty much as it is:
https://docs.google.com/document/d/1oMvVlGuBwD5U1251oxNmTZn7WgkNTj6tF-k1hOYjnac/edit

Tags

tag: Metadata

When possible, please tag your issue with the provided labels:

• Change to Documentation
• Documentation Request (for new documentation)
• Question (when submitting a general question)

Hydra uses cancancan to do authorization of many actions: https://github.com/CanCanCommunity/cancancan#1-define-abilities

Cancancan generates app/models/ability.rb into your application and then Hydra's generator and later Hyrax's generator each adds a couple of lines so that the class looks like this:

class Ability
  include Hydra::Ability

  include Hyrax::Ability
  self.ability_logic += [:everyone_can_create_curation_concerns]

  # Define any customized permissions here.
  def custom_permissions
    # Limits deleting objects to a the admin user
    #
    # if current_user.admin?
    #   can [:destroy], ActiveFedora::Base
    # end

    # Limits creating new objects to a specific group
    #
    # if user_groups.include? 'special_group'
    #   can [:create], ActiveFedora::Base
    # end
  end
end

You don't need to make any changes to this class as the included behavior provides all that you need to get started. However, if you are integrating an group system other than the default (See Hydra::RoleMapper), then you may want to change who has the admin role.

You can do this by overriding the admin? method on the Ability class like this:

    def admin?
      user_groups.include? 'librarians'
    end

Descriptive summary of request

This is a good and concise overview of the pieces of the stack, it would be great to have a page containing this in the new dev section.

Existing Documentation

https://github.com/RepoCamp/ahc/wiki/Hyrax-Introduction

Tags

When possible, please tag your issue with the provided labels:

• Change to Documentation
• Documentation Request (for new documentation)
• Question (when submitting a general question)

cd cc-sample
rails generate curation_concerns:install # already done on VM
rake db:migrate

Descriptive summary of request

Something I'm often trying to verify, and get asked frequently is the default set of metadata properties that are available when a work type is generated.

Existing Documentation

Most of the fields are added here:
https://github.com/projecthydra-labs/hyrax/blob/1186607726f465cb1c30566caeb39b539481d1ec/app/models/concerns/hyrax/basic_metadata.rb

but some are added earlier and I'm having trouble identifying where. We should have an official document so that crawling around in the code isn't required to identify the fields.

Expected Document

A table like presented something like below would be great:

Property | Predicate | from
id
head
tail
depositor
title
date_uploaded
date_modified
state
proxy_depositor
on_behalf_of
arkivo_checksum
owner
label|ActiveFedora::RDF::Fcrepo::Model.downloadFilename|Hyrax::BasicMetadata
relative_path
import_url
part_of
resource_type
creator
contributor
description
keyword
license
rights_statement
publisher
date_created
subject
language
identifier
based_near
related_url
bibliographic_citation
source