diff --git a/docs/Documentation-Maintainer-Guide.md b/docs/Documentation-Maintainer-Guide.md index 1f517f0..b17d62b 100644 --- a/docs/Documentation-Maintainer-Guide.md +++ b/docs/Documentation-Maintainer-Guide.md @@ -6,9 +6,9 @@ nav_order: 8 # Maintainer Guide -## how to change flux-commands.md +## how to change [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md) -The entries in flux-commands.md describe the usage of commands used by flux. +The entries in [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md) describe the usage of commands used by flux. flux-commands.md is fully automatically generated. To make this happen one has to fill in the proper annotations in the correponding java classes. E.g. @@ -37,7 +37,7 @@ The option's name is produced by cutting away the "set" from the methods name, l "BatchSize" which is then lowercased. The parameter of this option is generated from the parameter type of the method - here an "int"eger. -## how to publish docs/flux/flux-commands.md +## 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: @@ -53,5 +53,4 @@ Open the generated flux-commands.md and remove some boilerplate at the beginning 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. - The [publishing process will be automated with an github action](https://github.com/metafacture/metafacture-core/issues/368).