metafacture / metafacture-core

Core package of the Metafacture tool suite for metadata processing.
https://metafacture.org
Apache License 2.0
71 stars 34 forks source link

Add links to flux-commands.md #509

Closed dr0i closed 10 months ago

dr0i commented 10 months ago

See #488.

The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation. If the file resides at the proper location the following is produced (snippet):

add-oreaggregation

  • description: adds ore:Aggregation to an Europeana Data Model stream. The aggregation id is set by emitting literal('aggregation_id', id)
  • signature: StreamReceiver -> StreamReceiver
  • java class: org.metafacture.linkeddata.OreAggregationAdder

add-preamble-epilogue

As shown, the link to the Playground example is only inserted if it exists, see https://github.com/metafacture/metafacture-documentation/pull/24.

blackwinter commented 10 months ago

I would prefer adding an extra line to the command details instead of "hijacking" the heading.

dr0i commented 10 months ago

You mean like in:

add-preamble-epilogue

...

dr0i commented 10 months ago

PR is good to review again. Thx for the many pointers @blackwinter . Sorry for ignoring your suggestions - overlooked them beeing github suggestions but for the last one :/

dr0i commented 10 months ago

Thx, that's more elegant! I liked the bailing out more - but I can live with Invalid command info: in the output.

dr0i commented 10 months ago

Merged and closed.