Skip to content
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

Closed
2 tasks done
dr0i opened this issue Jun 5, 2023 · 11 comments
Closed
2 tasks done

Provide examples for every flux-command #488

dr0i opened this issue Jun 5, 2023 · 11 comments
Assignees

Comments

@dr0i
Copy link
Member

dr0i commented Jun 5, 2023

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
Copy link
Member Author

dr0i commented Jun 5, 2023

functional review: @dr0i
code review: @katauber

@TobiasNx
Copy link
Contributor

TobiasNx commented Nov 7, 2023

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

@TobiasNx
Copy link
Contributor

TobiasNx commented Nov 7, 2023

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
Copy link
Member Author

dr0i commented Nov 9, 2023

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

@TobiasNx
Copy link
Contributor

TobiasNx commented Nov 9, 2023

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
Copy link
Contributor

TobiasNx commented Nov 9, 2023

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

@TobiasNx TobiasNx assigned dr0i and unassigned TobiasNx Nov 9, 2023
@dr0i
Copy link
Member Author

dr0i commented Nov 9, 2023

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

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

@TobiasNx
Copy link
Contributor

TobiasNx commented Nov 9, 2023

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

@dr0i
Copy link
Member Author

dr0i commented Nov 9, 2023

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

@TobiasNx
Copy link
Contributor

TobiasNx commented Nov 9, 2023

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 added a commit that referenced this issue Nov 20, 2023
The tsv to enrich the flux-commands.md is taken from the repo
metafacture/metafacture-documentation.
dr0i added a commit that referenced this issue Nov 20, 2023
The tsv to enrich the flux-commands.md is taken from the repo
metafacture/metafacture-documentation.
dr0i added a commit that referenced this issue Nov 21, 2023
The tsv to enrich the flux-commands.md is taken from the repo
metafacture/metafacture-documentation.
dr0i added a commit that referenced this issue Nov 21, 2023
The tsv to enrich the flux-commands.md is taken from the repo
metafacture/metafacture-documentation.
dr0i added a commit that referenced this issue Nov 21, 2023
The tsv to enrich the flux-commands.md is taken from the repo
metafacture/metafacture-documentation.
@dr0i
Copy link
Member Author

dr0i commented Nov 21, 2023

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.

@dr0i dr0i closed this as completed Nov 21, 2023
dr0i added a commit to metafacture/metafacture-documentation that referenced this issue Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants