Skip to content

Commit

Permalink
Link to "Update flux-commands"
Browse files Browse the repository at this point in the history
  • Loading branch information
dr0i authored Sep 26, 2024
1 parent 916cbd1 commit e44a0bd
Showing 1 changed file with 1 addition and 12 deletions.
13 changes: 1 addition & 12 deletions docs/Documentation-Maintainer-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,6 @@ parameter type of the method - here an "int"eger.
## how to publish [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md)

If you have updated some of these annotations, say "description", and these changes are
merged into the master branch, generate a new flux-commands.md like this:

Go to metafacture-core, checkout master and build a distribution and start flux.sh:
```bash
$ ./gradlew installDist
$ cd ./metafacture-runner/build/install/metafacture-core/
$ flux.sh > flux-commands.md
```

Open the generated flux-commands.md and remove some boilerplate at the beginning of the
file manually. Add the naviagtion part of the page, save it, copy it [here](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md), commit and push.

merged into the master branch, generate a new flux-commands.md like explained in https://github.com/metafacture/metafacture-fix/wiki/Maintainer-Guidelines#update-flux-commands.

The [publishing process will be automated with an github action](https://github.com/metafacture/metafacture-core/issues/368).

0 comments on commit e44a0bd

Please sign in to comment.