search

fcrepo-exts / fcrepo-camel-toolbox

A collection of ready-to-use messaging applications with fcrepo-camel
Apache License 2.0
13 stars 26 forks source link

README updates for FCREPO-3696 #172

Closed Geoffsc closed 2 years ago

Geoffsc commented 2 years ago

JIRA Ticket: https://jira.lyrasis.org/projects/FCREPO/issues/FCREPO-3696?filter=allopenissues

demiankatz commented 2 years ago

Some general notes:

1.) At least a couple of properties are missing descriptions. Can anybody fill those in?

2.) I don't think the "Values" column has much value, as it's almost always either empty or redundant. Can we eliminate that too?

3.) Can we remove the "not currently available" note on Fixity Checking Service?

4.) Are there any legacy services still here that need to be removed?

Geoffsc commented 2 years ago

Another component that has a README that I didn't see mentioned here is the Fedora Camel Service -- does this need to be included as well?

dbernstein commented 2 years ago

I'm not sure if I'm looking at this correctly, but it appears that the formatting is still off for the Active MQ and Fixity Services. Also it looks like the fixity title still says "Not Working" or something like that. It should be removed.

One other thing: Serializer section should be removed since this is no longer included in the toolbox.

Geoffsc commented 2 years ago

I couldn't reply to @dbernstein 's last comment for some reason. I went ahead and fixed the Fixity title and removed the Serializer section -- I didn't see anything obvious wrong with the ActiveMQ and Fixity formatting but happy to continue the discussion tomorrow since I very well may have missed something :)

demiankatz commented 2 years ago

@Geoffsc, you couldn't reply to @dbernstein's comment because he posted a general comment to the PR, rather than attaching a note to a specific line of code. Only code annotations give a threaded conversation, for some reason. (Though on similar lines, I'm not sure why the "resolve" button doesn't seem to be available on code discussion threads here -- maybe it's just a repository-level setting, though).

Regarding the comment on formatting of the ActiveMQ and Fixity sections, I also don't see anything wrong with the layout -- @dbernstein, are you seeing issues in the code or in the rendering?

I did notice one small typo while reviewing the formatting, though: "disabless" should be "disables."

Geoffsc commented 2 years ago

Another thing I didn't include in this PR was deleting all the individual Service/Component READMEs. Not sure if that should be included or a separate PR.