Skip to content

Commit 5f3dd7d

Browse files
authored
Add links to files #59
1 parent 7724531 commit 5f3dd7d

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

MAINTAINING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The description of "options" is produced from all "public setter-methods", in th
4444

4545
The option's name is produced by cutting away the "set" from the methods name, leaving "BatchSize" which is then lowercased. The parameter of this option is generated from the parameter type of the method - here an "int"eger.
4646

47-
To add new example links to the playground or the metafacture runner or adjust existing links as well as the links to the JAVA code you have to update the flux example tsv: linksAndExamples.tsv
47+
To add new example links to the playground or the metafacture runner or adjust existing links as well as the links to the JAVA code you have to update the flux example tsv: [`linksAndExamples.tsv`](https://github.com/metafacture/metafacture-documentation/blob/master/linksAndExamples.tsv).
4848

4949
```tsv
5050
flux-commands code-link example
@@ -63,13 +63,13 @@ Steps:
6363
- Unzip the downloaded runner distribution.
6464
- Check out the metafacture-documentation repo.
6565
- Change into that directory.
66-
- Run the runner in the this directory without arguments:./metafacture-core/flux.sh (note that the links will only generated if the git repo metafacture-documentation is checked out and the file linksAndExamples.tsv is accessible).
66+
- Run the runner in the this directory without arguments:./metafacture-core/flux.sh (note that the links will only generated if the git repo metafacture-documentation is checked out and the file [`linksAndExamples.tsv`](https://github.com/metafacture/metafacture-documentation/blob/master/linksAndExamples.tsv) is accessible).
6767
- Copy the generated output to [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md), modify the documentation spefic arrangements (i.e. the header) and commit it to http://metafacture.github.io/metafacture-documentation/docs/flux/flux-commands.html.
6868

6969
## how to publish the changes for the fix documentation
7070

7171
Check the README of the released metafacture-core tag: e.g. https://github.com/metafacture/metafacture-core/blob/metafacture-core-8.0.1/README.md#functions-and-cookbook
7272

73-
Copy the `Best practices and guidelines for working with Metafacture Fix` and `Glossary` section to the corresponding section in `docs/fix/Fix-User-Guide.md` and the `Functions` section to `docs/fix/Fix-functions.md`.
73+
Copy the `Best practices and guidelines for working with Metafacture Fix` and `Glossary` section to the corresponding section in `docs/fix/Fix-User-Guide.md` and the `Functions` section to `docs/fix/Fix-functions.md`. Adjust whitespaces and links if needed.
7474

7575
Commit the the changes and let it review before merging it to the master. The master of the documentation repo should always correpond with the status of current release and its features. Therefore only changes before a release that improve the documentation are allowed but none that refer to unreleased features.

0 commit comments

Comments
 (0)