Sprint 002 Issue 211, documentation of micro services.

[br2490]

This PR addresses documentation issue #211. See commit history for versioning of the document - 1) intial conversion 2) changing ports to reflect php microservices and added link to original document.

Also, @8282, whomever you are, please ignore this and my commit message ;) 👍 .

[br2490]

and tagging @Islandora-CLAW/7-x-2-x-committers

[ruebot]

Looks good to me.

@DiegoPino, @whikloj do you want to take it in as is, then start hacking at it? Or hack at it now, then take it in?

[whikloj]

Sorry I must have missed this conversation. We have documentation as README.md files for each service in the services directory. Is this meant to bring that information into one location? 'Cause we'll have to maintain it in two places.

Top Level Services Directory
ResourceService
TransactionService
CollectionService

[DiegoPino]

@whikloj, this goes into: docs/technical-documentation/islandora-middleware-services-api.md
i feel it's complimentary to each readme.md. @ruebot do you know if .md files allow includes, or can be generated from external ones? Maybe we could in the future split this into the individual readme files and then make a composite one (this one) in that feeds from them? That could solve your concern Jared?

[br2490]

#211 was a task simply to copy-pasta the original by Danny to MD so it
could be worked on more actively. If Diego's suggestion is the way to go
++, but I'm afraid I might not know what to do in terms of linking or
transforming many docs to one.

On Sun, May 1, 2016 at 12:04 PM, Diego Pino Navarro <
notifications@github.com> wrote:

@whikloj https://github.com/whikloj, this goes into:
docs/technical-documentation/islandora-middleware-services-api.md
i feel it's complimentary to each readme.md. @ruebot
https://github.com/ruebot do you know if .md files allow includes, or
can be generated from external ones? Maybe we could in the future split
this into the individual readme files and then make a composite one (this
one) in that feeds from them? That could solve your concern Jared?

—
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
#216 (comment)

Benjamin Rosner

Instructional Applications Developer
Library and Academic Information Services
Sulzberger Hall Annex, Barnard College
p: 212-854-9005

[whikloj]

@DiegoPino there doesn't seem to be any way to include the content (see issue here).

I don't want to create a long drawn out conversation over this. So you are welcome to merge this as is.

[ruebot]

We'll sort this out as we sort through documentation in #182

[ruebot]

Related to #120