metafacture/metafacture-core

Provide examples for every flux-command

dr0i opened this issue · 11 comments

dr0i commented

Every flux command should link to an example.

Proposal:

  • 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
  • when creating flux-commands.md by doing ./flux.sh > flux-commands.md these links shall be included into the resulting md
dr0i commented

functional review: @dr0i
code review: @katauber

TobiasNx commented

I added examples for every flux command in the documentation repo see here: metafacture/metafacture-documentation#24

TobiasNx commented

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

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

TobiasNx commented

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

dr0i commented

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

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

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

dr0i commented

Can you post the recipe (like #488 (comment) )?

TobiasNx commented

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

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