diff --git a/docs/Documentation-Maintainer-Guide.md b/docs/Documentation-Maintainer-Guide.md index faddeca..1f517f0 100644 --- a/docs/Documentation-Maintainer-Guide.md +++ b/docs/Documentation-Maintainer-Guide.md @@ -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 flux-commands.md +## how to publish 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: @@ -50,6 +50,8 @@ $ flux.sh > flux-commands.md ``` Open the generated flux-commands.md and remove some boilerplate at the beginning of the -file manually. Save it, copy it here, commit and push. +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).