Documentation: Inventory sub-projects, and potential version

Created on 6 Apr 2016 · 36Comments · Source: Islandora/documentation

Our ONE REPO TO RULE THEM ALL is getting large, and we need to start thinking about breaking things out.

Identify all sub-projects
Identify all sub-projects versioning schema

documentation

Source

ruebot

Most helpful comment

CLAWnadians

ruebot on 28 Apr 2016

😄2

All 36 comments

One argument to start pulling the one repo to rule them all apart; we need to release artifacts for Java repos.

https://issues.sonatype.org/browse/OSSRH-18137

ruebot on 19 Apr 2016

Camel:
- commands
- component
- indexing
- karaf
- pom.xml
- services
- sync
drupal
- islandora
- islandora_apachesolr
- islandora_basic_image
- islandora_collection
- islandora_dc
- islandora_delete_by_fedora_uri_service
- islandora_medium_size_service
- islandora_mods
- islandora_rdf_mapping_service
- islandora_tn_service
docs
vagrant

ruebot on 22 Apr 2016

Based on the above:

docs could be put into it's own repo, but if we do that, our documentation links we have publicized will break. Do we care?
vagrant could be tossed aside, we have ansible now, along with docker
camel could be it's own repo, and get a maven central release. however, we need to decide if that is all one repo, or separate repos.
drupal, leave them in here, and this is where all the drupal modules live moving forward? or just the islandora drupal module lives here, and everything else breaks apart.

We'll need to talk this out a lot, and should not rush any of it. I'll put this on the next few tech calls. But, it would be really good to have @daniel-dgi's input, and I don't think we'll get that until around July.

ruebot on 22 Apr 2016

Version schema; everything non-Drupal is semantic.

ruebot on 22 Apr 2016

@whikloj makes a good point. I completely forgot the sprint-002 branch, which means I forgot the microservices.

ruebot on 27 Apr 2016

I'll write up a proposal of how to proceed, as per today's CLAW call discussion.

ruebot on 27 Apr 2016

Organize Thyself;

A CLAW GitHub Restructuring Proposal

Islandora-CLAW/CLAW

Remains as the canonical repository for the project. This includes ticketing (issues, milestones), wiki, and documentation. This repository would largely consist of git submodules. Core releases for the project would be done here. Each sub-project can have its own release, and we will follow semantic versioning where possible.

Documentation would be in the main CLAW repo

Islandora-CLAW/CLAW/docs
- User documentation
- Technical documentation
- Installation documentation
- Contributing documentation
- Migration documentation
- Use MkDocs & ghpages; point to an islandora.ca sub-domain, ex: docs.future.islandora.ca
- Will be licensed CC-BY

Structure would include all related sub-projects that would be apart of a release.

Sub-projects

Islandora-CLAW/alpaca (single project, that would be released on Maven Central)
- commands
- component
- indexing
- islandora-indexing-triplestore
- karaf
- services
- sync
- Will be licensed MIT
Islandora-CLAW/crayfish
- CollectionService
- ResourceService
- TransactionService
- islandora-indexing-triplestore
- Will be licensed MIT
Islandora-CLAW/islandora
- A single Drupal module consisting of Drupal sub-modules
- Will be released on Drupal.org
- Will be licensed GPLv2
Islandora-CLAW/claw-ansible
- Will supersede the current vagrant directory
- Licensed MIT
Islandora-CLAW/claw-docker (et al)
- Containerized Islandora CLAW
- Licensed MIT
Islandora-CLAW/chullo
- Licensed MIT
Islandora-CLAW/xpath_field
- Need to determine status; depends on Drupal 7 vs Drupal 8
- We should contribute our changes back upstream to alxp
Islandora-CLAW/claw-service-scripts
- Nigel gave us this.
- Need to determine status; depends on Drupal 7 vs Drupal 8
Islandora-CLAW/claw_install_profile
- Nigel gave us this.
- Need to determine status; depends on Drupal 7 vs Drupal 8

Ok! @Islandora-CLAW/7-x-2-x-committers + @nigelgbanks, @manez, @edf, @br2490, @dltj, I'd love your feedback on this. Tear it apart if need be :smile:

_editing as needed with feedback_

ruebot on 28 Apr 2016

dromedary instead of chameau?

Might this be a good time to deprecate the CLAW part of the name, at least for repositories?

Was there an intentional decision to move away from Confluence for user documentation?

dltj on 28 Apr 2016

Might this be a good time to deprecate the CLAW part of the name, at least for repositories?

No. Islandora CLAW is the name the project, as agreed to by the Roadmap Committee.

Was there an intentional decision to move away from Confluence for user documentation?

Yes. We control the namespace, look and feel, and the documentation lives with the code.

ruebot on 28 Apr 2016

Also throwing some tags here for @MarcusBarnes and @mark-cooper as sometimes CLAWdians. CLAWdiators? CLAWnadians?

manez on 28 Apr 2016

👍1

CLAWnadians

ruebot on 28 Apr 2016

😄2

Seems fine to me, a repo per artifact. My only thought is when extracting into separate repos, avoid reusing existing project names like islandora-claw/drupal, as if someone wants to fork it, and they already got a fork of drupal/drupal, then it gets odd names like drupal-1 in the users account, so something like islandora-claw/claw-drupal would work better.

nigelgbanks on 29 Apr 2016

👍1

Also doc's probably doesn't need to be a sub project, could still live on where it currently does (it'll be simpler to update that way).

nigelgbanks on 29 Apr 2016

👍1

@nigelgbanks good stuff. I'll ammend the proposal to put docs back into the main repo. That does seem like the best place for it.

ruebot on 29 Apr 2016

Suggestions on what we should call the "Drupal" repo? "claw-drupal" make sense? Or something else since the intention would be this is what goes on Drupal.org.

ruebot on 29 Apr 2016

Will that repo contain all the various Drupal modules? Because I think Drupal.org only cares about the actual module names, no?
So I am fine with claw-drupal or islandora-claw-drupal, etc

whikloj on 29 Apr 2016

Yeah. My proposal is to only have one Drupal module, and that module would have all the sub-modules. Kinda like Islandora Scholar. Then, we would only have on module on Drupal.org.

ruebot on 29 Apr 2016

Will research on this for Drupal 8.
Diego Pino Navarro
Krayon Media
Pedro de Valdivia 575
Pucón - Chile
F:+56-45-2442469

On Apr 29, 2016, at 4:13 PM, Nick Ruest [email protected] wrote:

Yeah. My proposal is to only have one Drupal module, and that module would have all the sub-modules. Kinda like Islandora Scholar. Then, we would only have on module on Drupal.org.

—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly or view it on GitHub https://github.com/Islandora-CLAW/CLAW/issues/182#issuecomment-215852028

DiegoPino on 29 Apr 2016

I have a name(s) for the php microservices; crawfish, crawdads, freshwater lobsters, or mudbugs. Little lobsters!

ruebot on 6 May 2016

My options: crawfish (which sounds like crowd...and i like it!) + mudbugs also!

DiegoPino on 9 May 2016

'crayfish' would be the Canadian version. It's also the colloquial name for the little shrimp-looking critters that crowd around to see if you're dead if you swim at the beaches around here, so I'm fond of it 😄

manez on 9 May 2016

👍1

@DiegoPino @whikloj: Here is a proof-of-concept for moving everything out, and keeping the history of just those files: https://github.com/ruebot/crayfish.

ruebot on 10 May 2016

Crayfish looks already good! Thanks @ruebot. I would just add composer as dependency and make sure people type "composer install" or "composer update" on the clone's root before trying to run the services.

DiegoPino on 10 May 2016

👍1

👍 to crayfish

whikloj on 10 May 2016

Crawfish is done. I'll create a pull request for yank services from the CLAW repo here shortly, and get Crayfish setup on Packagist.

https://github.com/islandora-claw/crayfish

ruebot on 12 May 2016

👍1

https://github.com/Islandora-CLAW/CLAW/pull/223

ruebot on 12 May 2016

👍1

Alpaca is done: https://github.com/Islandora-CLAW/Alpaca
https://github.com/Islandora-CLAW/CLAW/pull/224