Skip to content

Commit

Permalink
Restructuring and updating sections within the template Markdown docu…
Browse files Browse the repository at this point in the history
…ments to reflect the proposed reorganizations of Samvera GitHub projects.
  • Loading branch information
jrgriffiniii committed Oct 14, 2024
1 parent 0a7f0bb commit e99f97d
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 121 deletions.
125 changes: 92 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,112 @@

This repository holds templates and guidelines to support the maintenance of projects in the [Samvera](https://github.com/samvera) Github organization.

## Samvera Core Components
## Samvera GitHub Organization

The Samvera GitHub Organization (https://github.com/samvera/) contains `git` repositories for multiple projects developed and actively maintained by the Samvera Community. The projects themselves may be divided into four distinct groups:

- Hyrax
- Samvera Ruby Gems
- Samvera JavaScript Packages
- Samvera Infrastructure
- Samvera Administration

### Hyrax
_(and the Hyrax Ecosystem)_

Hyrax stands as an open source, self-deposit repository project, which has been actively maintained and under continuous development for approximately seven years. GitHub repositories exist for Samvera which actively maintain not only the [Hyrax source code base](https://github.com/samvera/hyrax), but which provide [a framework for deploying Hyrax implementations using virtualized server or cloud infrastructure](https://github.com/samvera/hyku), along with other projects supporting Hyrax infrastructure.

### Samvera Ruby Gems
_(formerly labeled as "Core Components")_

Samvera Ruby Gems are published as small, modular software libraries which were designed to be adopted by [Ruby on Rails](https://rubyonrails.org/) application developers who seek to implement digital object repositories. Core Components permit developers to benefit from, and contribute to Samvera for cases in which Hyrax might be impractical or unsatisfactory for their organizational requirements.

### Samvera JavaScript Packages

While Hyrax and Samvera Ruby Gems provide a suite of solutions for web application developers seeking to implement digital object repositories, there exist a small, but growing number of projects which exclusively provide user interface features and functionality. These are expected to provide published JavaScript packages using the [npm](https://npmjs.com), and, being under the open source Apache 2.0 license, are most welcome for contributors.

### Samvera Infrastructure

There also exist those Samvera Community projects which provide some hosted service which integrates into a digital object repository ecosystem, but which does not provide any enhanced user interface (or, which are not intended for usage by humans). Within this category fall serverless functions, microservices, configuration management templates, and virtualization utilities.

### Samvera Administration

Projects categorized for Samvera Administration typically provide some function related to community management (such as [this repository](https://github.com/samvera/maintenance)), [static websites](https://github.com/samvera/samvera.github.io), or other forms of documentation.

## Maintenance Requirements

There are explicitly stated guidelines for maintaining projects within the Samvera Organization:

Samvera Core Components are defined as the following:

> The primary Samvera code repository contains the Samvera community’s current consensus on what we are using, maintaining, and recommending. Ideally, this repository only contains code modules that are being actively used and maintained.
_Please reference [A Guide for the Samvera Community](https://samvera.github.io/core_components.html) for further information._

Currently, there are twenty Samvera Core Components maintained by the community:

### Ruby Samvera Components

| Component | CircleCI Status | Ruby 3.1 Support | Ruby 3.0 Support | Ruby 2.7 Support | Ruby 2.6 Support | Rails 7.0 Support | Rails 6.1 Support | Rails 6.0 Support | Rails 5.2 Support |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| [active_fedora](https://github.com/samvera/active_fedora) | [![Build Status](https://circleci.com/gh/samvera/active_fedora.svg?style=svg)](https://circleci.com/gh/samvera/active_fedora) | | | 2.7.0 | 2.6.5 | | | 6.0.2 | 5.2.4 |
| [bixby](https://github.com/samvera/bixby) | [![Build Status](https://circleci.com/gh/samvera/bixby.svg?style=svg)](https://circleci.com/gh/samvera/bixby) | 3.1.1 | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A |
| [browse-everything](https://github.com/samvera/browse-everything) | [![Build Status](https://circleci.com/gh/samvera/browse-everything.svg?style=svg)](https://circleci.com/gh/samvera/browse-everything) | | | 2.7.5 | 2.6.9 | | | 6.0.4.7 | 5.2.4 |
| [hydra-derivatives](https://github.com/samvera/hydra-derivatives) | [![Build Status](https://circleci.com/gh/samvera/hydra-derivatives.svg?style=svg)](https://circleci.com/gh/samvera/hydra-derivatives) | | | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A |
| [hydra-editor](https://github.com/samvera/hydra-editor) | [![Build Status](https://circleci.com/gh/samvera/hydra-editor.svg?style=svg)](https://circleci.com/gh/samvera/hydra-editor) | | | 2.7.5 | 2.6.9 | | | 6.0.3.4 | 5.2.3 |
| [hydra-file_characterization](https://github.com/samvera/hydra-file_characterization) | [![Build Status](https://circleci.com/gh/samvera/hydra-file_characterization.svg?style=svg)](https://circleci.com/gh/samvera/hydra-file_characterization) | | 3.0.3 | 2.7.5 | 2.6.9 | 7.0.2.3 | 6.1.5 | 6.0.4.7 | 5.2.7 |
| [hydra-head](https://github.com/samvera/hydra-head) | [![Build Status](https://circleci.com/gh/samvera/hydra-head.svg?style=svg)](https://circleci.com/gh/samvera/hydra-head) | | | 2.7.3 | 2.6.7 | | | 6.0.3.7 | 5.2.6 |
| [hydra-pcdm](https://github.com/samvera/hydra-pcdm) | [![Build Status](https://circleci.com/gh/samvera/hydra-pcdm.svg?style=svg)](https://circleci.com/gh/samvera/hydra-pcdm) | | | 2.7.5 | 2.6.9 | | | 6.0.2 | 5.2.4 |
| [hydra-role-management](https://github.com/samvera/hydra-role-management) | [![Build Status](https://circleci.com/gh/samvera/hydra-role-management.svg?style=svg)](https://circleci.com/gh/samvera/hydra-role-management) | | | 2.7.5 | 2.6.9 | | | 6.0.2 | 5.2.4 |
| [hydra-works](https://github.com/samvera/hydra-works) | [![Build Status](https://circleci.com/gh/samvera/hydra-works.svg?style=svg)](https://circleci.com/gh/samvera/hydra-works) | | | 2.7.5 | 2.6.9 | | | 6.0.3.1 | 5.2.4.3 | [![Build Status](https://circleci.com/gh/samvera/hydra-works.svg?style=svg)](https://circleci.com/gh/samvera/hydra-works) |
| [iiif_manifest](https://github.com/samvera/iiif_manifest) | [![Build Status](https://circleci.com/gh/samvera/iiif_manifest.svg?style=svg)](https://circleci.com/gh/samvera/iiif_manifest) | | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A |
| [ldp](https://github.com/samvera/ldp) | [![Build Status](https://circleci.com/gh/samvera/ldp.svg?style=svg)](https://circleci.com/gh/samvera/ldp) | | | 2.7.5 | 2.6.9 | | | 6.0.4.4 | 5.2.0 |
| [noid-rails](https://github.com/samvera/noid-rails) | [![Build Status](https://circleci.com/gh/samvera/noid-rails.svg?style=svg)](https://circleci.com/gh/samvera/noid-rails) | | | 2.7.5 | 2.6.9 | | 6.1.3.2 | 6.0.3.2 | 5.2.4.3 |
| [questioning_authority](https://github.com/samvera/questioning_authority) | [![Build Status](https://circleci.com/gh/samvera/questioning_authority.svg?style=svg)](https://circleci.com/gh/samvera/questioning_authority) | | | 2.7.5 | 2.6.9 | | 6.1.1 | 6.0.2 | 5.2.4 |
| [rubydora](https://github.com/samvera/rubydora) | [![Build Status](https://circleci.com/gh/samvera/rubydora.svg?style=svg)](https://circleci.com/gh/samvera/rubydora) | | | 2.7.5 | 2.6.9 | | | 6.0.2 | 5.2.4 |
| [samvera.github.io](https://github.com/samvera/samvera.github.io) | [![Build Status](https://circleci.com/gh/samvera/samvera.github.io.svg?style=svg)](https://circleci.com/gh/samvera/samvera.github.io) | 3.1.1 | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A |
| [samvera-circleci-orb](https://github.com/samvera/samvera-circleci-orb) | [![Build Status](https://circleci.com/gh/samvera/samvera-circleci-orb.svg?style=svg)](https://circleci.com/gh/samvera/samvera-circleci-orb) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| [valkyrie](https://github.com/samvera/valkyrie) | [![Build Status](https://circleci.com/gh/samvera/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera/valkyrie) | | | 2.7.5 | 2.6.5 | | | 6.0.5 | 5.2.8 |

### JavaScript Samvera Components

| Component | CircleCI Status | Node.js 18.x Support | Node.js 16.x Support | Node.js 14.x Support |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------------- | -------------------- |
| [node-iiif](https://github.com/samvera/node-iiif) | [![Build Status](https://circleci.com/gh/samvera/node-iiif.svg?style=svg)](https://circleci.com/gh/samvera/node-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| [serverless-iiif](https://github.com/samvera/serverless-iiif) | [![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
### Samvera Ruby Gems

| Gem | CircleCI Status | Ruby 3.2 Support | Ruby 3.1 Support | Ruby 3.0 Support | Ruby 2.7 Support | Rails 7.0 Support | Rails 6.1 Support | Rails 6.0 Support |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|[hydra-derivatives](https://github.com/samvera/hydra-derivatives)|[![Build Status](https://circleci.com/gh/samvera/hydra-derivatives.svg?style=svg)](https://circleci.com/gh/samvera/hydra-derivatives)|||||||||
|[iiif_manifest](https://github.com/samvera/iiif_manifest)|[![Build Status](https://circleci.com/gh/samvera/iiif_manifest.svg?style=svg)](https://circleci.com/gh/samvera/iiif_manifest)|||||||||
|[ldp](https://github.com/samvera/ldp)|[![Build Status](https://circleci.com/gh/samvera/ldp.svg?style=svg)](https://circleci.com/gh/samvera/ldp)|||||||||
|[valkyrie](https://github.com/samvera/valkyrie)|[![Build Status](https://circleci.com/gh/samvera/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera/valkyrie)|||||||||

#### Under Reorganization
![under reorganization](https://img.shields.io/badge/under-reorg-yellow)

_The following Gems are being merged into other GitHub repositories, but shall remain in active maintenance and released as Gems._

|Gem |CircleCI Status|Ruby 3.2 Support|Ruby 3.1 Support|Ruby 3.0 Support|Ruby 2.7 Support|Rails 7.0 Support|Rails 6.1 Support|Rails 6.0 Support|
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|[active_fedora](https://github.com/samvera/active_fedora)|[![Build Status](https://circleci.com/gh/samvera/active_fedora.svg?style=svg)](https://circleci.com/gh/samvera/active_fedora)|||||||||
|[bixby](https://github.com/samvera/bixby)|[![Build Status](https://circleci.com/gh/samvera/bixby.svg?style=svg)](https://circleci.com/gh/samvera/bixby)|||||||||
|[hydra-editor](https://github.com/samvera/hydra-editor)|[![Build Status](https://circleci.com/gh/samvera/hydra-editor.svg?style=svg)](https://circleci.com/gh/samvera/hydra-editor)|||||||||
|[hydra-file_characterization](https://github.com/samvera/hydra-file_characterization)|[![Build Status](https://circleci.com/gh/samvera/hydra-file_characterization.svg?style=svg)](https://circleci.com/gh/samvera/hydra-file_characterization)|||||||||
|[hydra-head](https://github.com/samvera/hydra-head)|[![Build Status](https://circleci.com/gh/samvera/hydra-head.svg?style=svg)](https://circleci.com/gh/samvera/hydra-head)|||||||||
|[hydra-pcdm](https://github.com/samvera/hydra-pcdm)|[![Build Status](https://circleci.com/gh/samvera/hydra-pcdm.svg?style=svg)](https://circleci.com/gh/samvera/hydra-pcdm)|||||||||
|[hydra-role-management](https://github.com/samvera/hydra-role-management)|[![Build Status](https://circleci.com/gh/samvera/hydra-role-management.svg?style=svg)](https://circleci.com/gh/samvera/hydra-role-management)|||||||||
|[hydra-works](https://github.com/samvera/hydra-works)|[![Build Status](https://circleci.com/gh/samvera/hydra-works.svg?style=svg)](https://circleci.com/gh/samvera/hydra-works)|||||||||
|[noid-rails](https://github.com/samvera/noid-rails)|[![Build Status](https://circleci.com/gh/samvera/noid-rails.svg?style=svg)](https://circleci.com/gh/samvera/noid-rails)|||||||||
|[samvera.github.io](https://github.com/samvera/samvera.github.io)|[![Build Status](https://circleci.com/gh/samvera/samvera.github.io.svg?style=svg)](https://circleci.com/gh/samvera/samvera.github.io)|||||||||

#### Prepared for Deprecation
![prepared for deprecation](https://img.shields.io/badge/deprecated-red)

_The following Gems are no longer actively maintained, and awaiting deprecation into the [Samvera Deprecated](https://github.com/samvera-deprecated) Organization._

| Gem | CircleCI Status |
| --- | --- |
|[browse-everything](https://github.com/samvera/browse-everything)|[![Build Status](https://circleci.com/gh/samvera/browse-everything.svg?style=svg)](https://circleci.com/gh/samvera/browse-everything)|
|[questioning_authority](https://github.com/samvera/questioning_authority)|[![Build Status](https://circleci.com/gh/samvera/questioning_authority.svg?style=svg)](https://circleci.com/gh/samvera/questioning_authority)
|[rubydora](https://github.com/samvera/rubydora)|[![Build Status](https://circleci.com/gh/samvera/rubydora.svg?style=svg)](https://circleci.com/gh/samvera/rubydora)|

### Samvera JavaScript Packages

|Package|CircleCI Status|Node.js 20 Support|Node.js 19 Support|Node.js 18 Support|Node.js 16 Support|
| --- | --- | --- | --- | --- | --- |
|[node-iiif](https://github.com/samvera/node-iiif)|[![Build Status](https://circleci.com/gh/samvera/node-iiif.svg?style=svg)](https://circleci.com/gh/samvera/node-iiif)| | | | |

### Samvera Infrastructure Projects

#### CircleCI Orbs
|Application|CircleCI Status|
| --- | --- |
|[samvera-circleci-orb](https://github.com/samvera/samvera-circleci-orb)|[![Build Status](https://circleci.com/gh/samvera/samvera-circleci-orb.svg?style=svg)](https://circleci.com/gh/samvera/samvera-circleci-orb)|

#### Node.js

|Application|CircleCI Status|Node.js 20 Support|Node.js 19 Support|Node.js 18 Support|Node.js 16 Support|
| --- | --- | --- | --- | --- | --- |
|[serverless-iiif](https://github.com/samvera/serverless-iiif)|[![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif)| | | | |

## Maintenance Documentation

- [ORGS](./ORGS.md) - Reference guide for the structure of GitHub Organizations (`samvera`, `samvera-labs`, and `samvera-deprecated`)
- [TEAMS](./TEAMS.md) - Reference guide for the structure of GitHub Teams within the `samvera`, `samvera-labs`, and `samvera-deprecated` Organizations
- [RELEASES](./ruby/RELEASES.md) - Reference guide for the releasing Ruby Gem components maintained by the Samvera Community

## Samvera Component Templates
## Samvera Project Templates

[README.md](./templates/README.md) - The elements in this template should be in
every repository. Additional elements may be added.
Expand Down
Loading

0 comments on commit e99f97d

Please sign in to comment.