From 3573f264add400dae97c9fbe335fc0cfa7f07f35 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Tue, 24 May 2016 17:10:26 -0300 Subject: [PATCH 1/8] Create intro-to-claw.md First pas. We need something for the front-end user to explain the basics of what CLAW is and why it's better. --- docs/user-documentation/intro-to-claw.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/user-documentation/intro-to-claw.md diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md new file mode 100644 index 000000000..ad6d3b9a2 --- /dev/null +++ b/docs/user-documentation/intro-to-claw.md @@ -0,0 +1,16 @@ +#Intro to Islandora CLAW + +#What is Islandora CLAW +Islandora CLAW is the project name for development of Islandora to work with Fedora 4. The current release of Islandora, known as 7.x-1.x, works as a bridge between Drupal 7.x and Fedora 3. Put simply, Islandora 7.x-1.x is middleware between Fedora 3 and Drupal 7.x, sometimes expressed as a hamburger: + +![image](https://cloud.githubusercontent.com/assets/2371345/15516210/2ac2c2ec-21c8-11e6-8d34-ce6199d169a3.png) + +Islandora CLAW (or Islandora 7.x-2.x) does more than simply replace that base layer with Fedora 4. It is a total re-architecting of the interaction between the various pieces. Rather than a hamburger, Islandora CLAW is a chimera: +![image](https://cloud.githubusercontent.com/assets/2371345/15516273/76704a5c-21c8-11e6-9ca0-8c188313dbd1.png) + +This new structure has several advantages: + +* Parcelling out the various services and dependencies allows for more horizontal scalability +* Changing the relationship between Drupal and Fedora allows for a more flexible approach to front-end management (i.e, it need not be Drupal) while also taking much greater advantage of features available from Drupal (i.e, Fedora objects are treated more like nodes, for the purposes of using Drupal contrib modules. Many Islandora 7.x-1.x modules are redundant in Islandora CLAW because they reproduce existing Drupal contrib modules that can be used out of the box in Islandora CLAW). +* Easier to keep up-to-date as not all pices must be versioned together. +* Installations tools (ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. From 4265dd49968fbb07c0c90328b10b30f970a3f54a Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Tue, 24 May 2016 17:11:06 -0300 Subject: [PATCH 2/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index ad6d3b9a2..08e1bc7ec 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -1,6 +1,6 @@ -#Intro to Islandora CLAW +# Intro to Islandora CLAW -#What is Islandora CLAW +## What is Islandora CLAW Islandora CLAW is the project name for development of Islandora to work with Fedora 4. The current release of Islandora, known as 7.x-1.x, works as a bridge between Drupal 7.x and Fedora 3. Put simply, Islandora 7.x-1.x is middleware between Fedora 3 and Drupal 7.x, sometimes expressed as a hamburger: ![image](https://cloud.githubusercontent.com/assets/2371345/15516210/2ac2c2ec-21c8-11e6-8d34-ce6199d169a3.png) From caf2d7504403ce38f053ad727fa9ee4946b49bd0 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Wed, 25 May 2016 13:02:09 -0300 Subject: [PATCH 3/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index 08e1bc7ec..c75ab194c 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -14,3 +14,18 @@ This new structure has several advantages: * Changing the relationship between Drupal and Fedora allows for a more flexible approach to front-end management (i.e, it need not be Drupal) while also taking much greater advantage of features available from Drupal (i.e, Fedora objects are treated more like nodes, for the purposes of using Drupal contrib modules. Many Islandora 7.x-1.x modules are redundant in Islandora CLAW because they reproduce existing Drupal contrib modules that can be used out of the box in Islandora CLAW). * Easier to keep up-to-date as not all pices must be versioned together. * Installations tools (ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. + +## Why Switch? + +Islandora 7.x-1.x is a tried and tested product with a vibrant user and contributor community and many tools and add-ons available to customize and expand its uses. Islandora CLAW is a major departure, representing a great deal of work both in development of the software, and to migrate and upgrade existing Islandora sites. So why make the change? + +### Fedora +The primary motive for moving to Islandora CLAW is to stay current with the repository layer of our ecosystem. Moving to Fedora 4 is vital for the long-term utility of the project. + +* Fedora 3 is End-of-Life and has not been supported since 2015. This means that there will be no improvements, bug fixes, or security patches released for the software, drastically increasing individual maintenance needs for adopters. +* Fedora 3 experiences significant slowdown when repositories reach a large (millions) number of objects. Fedora 4 is much more scalable, and is specifically engineered to be horizontally scalable in ways that Fedora 3 cannot. + +### Drupal +[Drupal 8](https://www.drupal.org/8) has been officially released and development has begun on Drupal 9. Official Drupal policy will see Drupal 7 become unsupported when Drupal 9 is released, putting it int the same precarious territory as Fedora 3. + +Current Islandora CLAW development works with Drupal 7 as a front-end, but Islandora's CLAW's structure has been built with a pivot to Drupal 8 in mind from its very inception, and work is underway to ensure that when the Islandora community is ready to switch to Drupal 8, Islandora will be there with a solid Drupal 8/Fedora 4 platform. From 60fba77b9c4e5e58e6c8e439ac400a1d24f01219 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Wed, 25 May 2016 14:29:14 -0300 Subject: [PATCH 4/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index c75ab194c..decd4aa1f 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -15,6 +15,15 @@ This new structure has several advantages: * Easier to keep up-to-date as not all pices must be versioned together. * Installations tools (ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. +### Ecosystem + +#### Alpaca +#### Chullo +#### CLAW +#### Crayfish +#### Islandora +#### PDX + ## Why Switch? Islandora 7.x-1.x is a tried and tested product with a vibrant user and contributor community and many tools and add-ons available to customize and expand its uses. Islandora CLAW is a major departure, representing a great deal of work both in development of the software, and to migrate and upgrade existing Islandora sites. So why make the change? From 4ad3019daee5865e97dea72ff286ad4019c8c51e Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Thu, 26 May 2016 12:16:29 -0300 Subject: [PATCH 5/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 31 ++++++++++++++++++------ 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index decd4aa1f..de1bd0b5d 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -1,6 +1,6 @@ # Intro to Islandora CLAW -## What is Islandora CLAW +## What is Islandora CLAW? Islandora CLAW is the project name for development of Islandora to work with Fedora 4. The current release of Islandora, known as 7.x-1.x, works as a bridge between Drupal 7.x and Fedora 3. Put simply, Islandora 7.x-1.x is middleware between Fedora 3 and Drupal 7.x, sometimes expressed as a hamburger: ![image](https://cloud.githubusercontent.com/assets/2371345/15516210/2ac2c2ec-21c8-11e6-8d34-ce6199d169a3.png) @@ -17,12 +17,23 @@ This new structure has several advantages: ### Ecosystem -#### Alpaca -#### Chullo -#### CLAW -#### Crayfish -#### Islandora -#### PDX +#### [Alpaca](https://github.com/Islandora-CLAW/Alpaca) +Event driven middleware based on Apache Camel that synchronizes a Fedora 4 with Drupal. + +#### [Chullo](https://github.com/Islandora-CLAW/chullo) +A PHP client for Fedora 4 built using Guzzle and EasyRdf. + +#### [CLAW](https://github.com/Islandora-CLAW/CLAW) +A container with references to all of the other components that make up Islandora CLAW. Also contains documentation and project discussions. + +#### [Crayfish](https://github.com/Islandora-CLAW/Crayfish) +Top level container for the various Islandora CLAW microservices. + +#### [Islandora](https://github.com/Islandora-CLAW/islandora) +The Drupal modules associated with CLAW. Work in underway to have this as a project on [drupal.org](https://www.drupal.org/). + +#### [PDX](https://github.com/Islandora-CLAW/pdx) +Top level container for the various PCDM specific Islandora CLAW microservices. ## Why Switch? @@ -38,3 +49,9 @@ The primary motive for moving to Islandora CLAW is to stay current with the repo [Drupal 8](https://www.drupal.org/8) has been officially released and development has begun on Drupal 9. Official Drupal policy will see Drupal 7 become unsupported when Drupal 9 is released, putting it int the same precarious territory as Fedora 3. Current Islandora CLAW development works with Drupal 7 as a front-end, but Islandora's CLAW's structure has been built with a pivot to Drupal 8 in mind from its very inception, and work is underway to ensure that when the Islandora community is ready to switch to Drupal 8, Islandora will be there with a solid Drupal 8/Fedora 4 platform. + +### Community-Driven Design + +The Islandora community has grown significantly since the project began, both in terms of users and contributors. For the first time, we are in a position to have a truly community-driven development process, in which any Islandora user can participate at whatever level fits their interests and abilities. Islandora CLAW has worked with the broader Islandora community to solicit use-cases, put forward prospectuses and project plans for review and editing, and has been developed with a mix of funding from Islandora Foundation members and volunteer developers working on sprints. + +Islandora CLAW is developed _by_ the Islandora community, _for_ the Islandora community. As a member of the Islandora community, you can help to steer the direction it takes. From 2136321f1ed186df948161cc1d749cdc315f05c6 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Thu, 26 May 2016 12:34:16 -0300 Subject: [PATCH 6/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index de1bd0b5d..132a19469 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -13,7 +13,7 @@ This new structure has several advantages: * Parcelling out the various services and dependencies allows for more horizontal scalability * Changing the relationship between Drupal and Fedora allows for a more flexible approach to front-end management (i.e, it need not be Drupal) while also taking much greater advantage of features available from Drupal (i.e, Fedora objects are treated more like nodes, for the purposes of using Drupal contrib modules. Many Islandora 7.x-1.x modules are redundant in Islandora CLAW because they reproduce existing Drupal contrib modules that can be used out of the box in Islandora CLAW). * Easier to keep up-to-date as not all pices must be versioned together. -* Installations tools (ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. +* Installations tools (Ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. ### Ecosystem From 1cbe554997481888a7653b2921dc3555634add23 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Thu, 26 May 2016 12:36:06 -0300 Subject: [PATCH 7/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index 132a19469..4f425ef2b 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -46,7 +46,7 @@ The primary motive for moving to Islandora CLAW is to stay current with the repo * Fedora 3 experiences significant slowdown when repositories reach a large (millions) number of objects. Fedora 4 is much more scalable, and is specifically engineered to be horizontally scalable in ways that Fedora 3 cannot. ### Drupal -[Drupal 8](https://www.drupal.org/8) has been officially released and development has begun on Drupal 9. Official Drupal policy will see Drupal 7 become unsupported when Drupal 9 is released, putting it int the same precarious territory as Fedora 3. +[Drupal 8](https://www.drupal.org/8) has been officially released and development has begun on Drupal 9. Official Drupal policy will see Drupal 7 become unsupported when Drupal 9 is released, putting it in the same precarious territory as Fedora 3. Current Islandora CLAW development works with Drupal 7 as a front-end, but Islandora's CLAW's structure has been built with a pivot to Drupal 8 in mind from its very inception, and work is underway to ensure that when the Islandora community is ready to switch to Drupal 8, Islandora will be there with a solid Drupal 8/Fedora 4 platform. From a6c3c6047f80d1529c5d0a8479f32086cee148c6 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Thu, 26 May 2016 14:51:03 -0300 Subject: [PATCH 8/8] Update intro-to-claw.md --- docs/user-documentation/intro-to-claw.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/user-documentation/intro-to-claw.md b/docs/user-documentation/intro-to-claw.md index 4f425ef2b..fb8dfef2f 100644 --- a/docs/user-documentation/intro-to-claw.md +++ b/docs/user-documentation/intro-to-claw.md @@ -13,7 +13,7 @@ This new structure has several advantages: * Parcelling out the various services and dependencies allows for more horizontal scalability * Changing the relationship between Drupal and Fedora allows for a more flexible approach to front-end management (i.e, it need not be Drupal) while also taking much greater advantage of features available from Drupal (i.e, Fedora objects are treated more like nodes, for the purposes of using Drupal contrib modules. Many Islandora 7.x-1.x modules are redundant in Islandora CLAW because they reproduce existing Drupal contrib modules that can be used out of the box in Islandora CLAW). * Easier to keep up-to-date as not all pices must be versioned together. -* Installations tools (Ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. +* Installations tools (Ansible, Docker, Vagrant) can automate uniting the pieces in a simple, clean installation process. Islandora has always beena turn-key repository solution, in the sense that it needs no customization once installed. With Islandora CLAW, that installtion process is much smoother, with automated solutions that can be used in production. ### Ecosystem @@ -55,3 +55,9 @@ Current Islandora CLAW development works with Drupal 7 as a front-end, but Islan The Islandora community has grown significantly since the project began, both in terms of users and contributors. For the first time, we are in a position to have a truly community-driven development process, in which any Islandora user can participate at whatever level fits their interests and abilities. Islandora CLAW has worked with the broader Islandora community to solicit use-cases, put forward prospectuses and project plans for review and editing, and has been developed with a mix of funding from Islandora Foundation members and volunteer developers working on sprints. Islandora CLAW is developed _by_ the Islandora community, _for_ the Islandora community. As a member of the Islandora community, you can help to steer the direction it takes. + +### Linked Data + +### Interoperability + +Islandora CLAW works with the [Portland Common Data Model](https://github.com/duraspace/pcdm/wiki), "a flexible, extensible domain model that is intended to underlie a wide array of repository and DAMS applications." What does this mean in practice? Objects stored in Islandora CLAW will have a a data model that can be recognized by Hydra and other custom Fedora 4 based repository heads, and vice versa. By working together with the Hydra and Fedora communities, we can leverage a broader community of developers, librarians, and other digital repository users to build better tools and share reosurces.