Skip to content

Commit

Permalink
Update Documentation-Maintainer-Guide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TobiasNx committed May 6, 2024
1 parent 59f4895 commit 0f52245
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/Documentation-Maintainer-Guide.md
Expand Up @@ -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:
Expand All @@ -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).

0 comments on commit 0f52245

Please sign in to comment.