Provide examples for every flux-command - Githubissues

metafacture / metafacture-core

Core package of the Metafacture tool suite for metadata processing.

https://metafacture.org

Apache License 2.0

69 stars 34 forks source link

Provide examples for every flux-command #488

Closed dr0i closed 7 months ago

dr0i commented 1 year ago

Every flux command should link to an example.

Proposal:

[x] add for every command an entry to a submenu flux-commands into playground
- Note: name these entries exactly as the flux-command , e.g. add-oreaggregation
[x] when creating flux-commands.md by doing ./flux.sh > flux-commands.md these links shall be included into the resulting md

dr0i commented 1 year ago

functional review: @dr0i code review: @katauber

TobiasNx commented 8 months ago

I added examples for every flux command in the documentation repo see here: https://github.com/metafacture/metafacture-documentation/pull/24

TobiasNx commented 8 months ago

Due to the additional fix commands for metafacture the metafacture runner the documentations page is build with the result of the fix runner.

Also the list of examples provide links to all source code of each function for further inspections.

dr0i commented 8 months ago

I cannot find a documentation how to use the fix-runner. Can you advice me?

TobiasNx commented 8 months ago

There are multiple explanations how to use the runner: e.g.: https://github.com/metafacture/metafacture-fix/releases/tag/0.6.1 or https://metafacture.org/getting-started.html

TobiasNx commented 8 months ago

And the commands are provided in the same way as in core. Just run the runner without arguments

dr0i commented 8 months ago

Thx. For further reference, if someone uses the search in github:

 ./gradlew installDist
 ./metafix-runner/build/install/metafix-runner/bin/metafix-runner

TobiasNx commented 8 months ago

There is a standalone runner that you can use. You do not need that runner.

dr0i commented 8 months ago

Can you post the recipe (like https://github.com/metafacture/metafacture-core/issues/488#issuecomment-1803427068 )?

TobiasNx commented 8 months ago

You do not need to build the runner.

You also can download the latest runner here: https://github.com/metafacture/metafacture-fix/releases Unzip the downloaded metafix-runner distribution to run the runner without arguments:

Unix: ./bin/metafix-runner or Windows: ./bin/metafix-runner.bat.

dr0i commented 7 months ago

I think we are done here. Releases can now be build like described in https://github.com/metafacture/metafacture-core/issues/502 , i.e. by also providing a nice flux-commands.md with links to Java classes and to Playground examples.