Updating Maintainers portion of the readme in repositories

[kstapelfeldt]

"This module is maintained by the Islandora community. If you add an issue to the queue, please attend a Tech call meeting or join us on Slack to discuss."

Track in https://docs.google.com/spreadsheets/d/1C4sFLbKcZePsrkhBSH5yfqE9TOfeszz7ebDDAsHUpxI/edit?usp=sharing - Kristina will do some of this.

[rosiel]

We discussed during same call that we don't feel it necessary to include the previous maintainer's name (so, dropping the last We thank xxxx for previously maintaining this module)

[kspurgin]

@seth-shaw-unlv I assigned you in the spreadsheet (updated link to a copy of that) to handle the two you are currently the maintainer on.

[seth-shaw-unlv]

I don't know that directly replacing the maintainers line with this statement makes sense. We already make similar statements in the Troubleshooting and Development sections:

## Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)
* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)

## Development

If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora/documentation/wiki#islandora-8-tech-calls). We love to hear from you!

If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information.

We recommend using the [islandora-playbook](https://github.com/Islandora-Devops/islandora-playbook) to get started.

Could we better incorporate the working into the existing Development section? Maybe add Slack to the Troubleshooting section?

[kspurgin]

I think we can do this better, consolidating and clarifying info.

At the risk of the scope of this creeping, though, I am noticing not all the repositories are super-consistent with the README. For example, the Crayfish repo does not have a Troubleshooting/Issues section and the Development section is formatted a bit differently than what you have above. It does have a list of organizational sponsors in the maintainers section that I assume should be retained.

This makes me want to look at them all systematically before trying to formulate a revision...

[kspurgin]

This is probably opening a can of worms I should leave alone, but do we still recommend using the islandora-playbook (over/instead of isle-dc) for getting started?

Is there an update we could make to https://islandora.github.io/documentation/#try-islandora so we could just link there for methods of getting started with Islandora for demo vs. dev purposes? Then, if the recommendation(s) change we just have one place to update them.

(Also at least one repo has additional hints/ "remember to do x" for running playbook that the others are lacking, so maintaining the instructions for playbook in one place would also keep that kind of thing consistent)

[kspurgin]

Reporting back on the above, based on systematic review:

• documentation repo's readme is very different from the rest which is probably fine given it's a very different kind of repo. It is omitted from the rest of the summary description below.
• islandora-ci has no README at all. (Should it have a basic standard one at least?) It is omitted from the rest of the summary description below.
• Troubleshooting/issues section
  • same in all repos that have it, except for very minor formatting
  • not present in crayfish (and children) and jsonld repos
• Development section
  • At least in some repos, the "Please see the Contributors pages on Islandora.ca" link is broken
  • Crayfish-Commons, openseadragon, and chullo repos include the "If you want to pull down the submodules for development..." note after the recommendation to use islandora-playbook.

[kspurgin]

My recommendation for moving forward would be:

• FIRST, some updates to the documentation
  • Add a "Help/Troubleshooting" section that will appear in left nav bar under Contributing. This will explain that, as an open source project, there is no one primarily responsible for providing technical support, so the best way to get help is to reach out to the community. Listserv and Slack signup info included
  • Create a GitHub Issue already says that new issues are reviewed in the Tech Call. Update to emphasize that we recommend showing up to the next Tech Call after creating an issue in order to be able to discuss or answer any questions about the issue
  • Figure out where in the documentation to put recommended method of spinning up Islandora for development and any dev-specific hints
  • Make sure Islandora community page is up-to-date (for instance it does not list Tech Calls for 2021 yet.) Or, should this be moved to the documentation, and linked to by the Foundation site, so the community can keep it up-to-date instead of it getting bottlenecked?
• THEN, have one block we can add to all the READMEs, that links to the relevant places in the documentation. My thinking behind this is it'll probably be rare that we want to change/remove topics covered in the READMEs, but more common that we would want to change the details of things like where to go for troubleshooting help or recommended ways to spin up an Islandora for dev. This way we can keep the details in the documentation up to date in one place instead of having to update all the READMEs.

Thinking something like the following comment...

[kspurgin]

Troubleshooting/Issues

See Help/Troubleshooting for ways to get or provide help.

Please create a Github Issue to report a bug, add a use case, or request a new feature. See the Islandora documentation for community practices and workflows for creating issues.

Development

• Before contributing code, make sure you are covered by a contributor license agreement
• See Contribute code for contribution guidelines and workflows
• See TBD for recommended method(s) of getting Islandora up and running for development.

Maintenance

This code is maintained by the Islandora community. That link lists many ways you can reach out to or get involved in the community.

(only for repos which have a list of organizational sponsors:)

The following organizations have sponsored the development and maintenance of this code:

• orgs
• listed
• here

[kstapelfeldt]

Order of Operations

1. merge document changes
2. Update URLs for the snippet in the comment above
3. Update all the read-me-s

Waiting on confirmation from @seth-shaw-unlv but the Tech call thought it was a great idea.

[seth-shaw-unlv]

Looks good to me.

[kspurgin]

Ok, I will work on a documentation PR