-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Provide examples for every flux-command #488
Comments
I added examples for every flux command in the documentation repo see here: metafacture/metafacture-documentation#24 |
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. |
I cannot find a documentation how to use the fix-runner. Can you advice me? |
There are multiple explanations how to use the runner: e.g.: https://github.com/metafacture/metafacture-fix/releases/tag/0.6.1 |
And the commands are provided in the same way as in core. Just run the runner without arguments |
Thx. For further reference, if someone uses the search in github: ./gradlew installDist
./metafix-runner/build/install/metafix-runner/bin/metafix-runner |
There is a standalone runner that you can use. You do not need that runner. |
Can you post the recipe (like #488 (comment) )? |
You do not need to build the runner. You also can download the latest runner here: https://github.com/metafacture/metafacture-fix/releases Unix: |
The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation.
The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation.
The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation.
The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation.
The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation.
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. |
Takes into acount #24 based on metafacture/metafacture-core#488.
Every flux command should link to an example.
Proposal:
flux-commands
into playgroundadd-oreaggregation
flux-commands.md
by doing./flux.sh > flux-commands.md
these links shall be included into the resulting mdThe text was updated successfully, but these errors were encountered: