You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Documentation-Maintainer-Guide.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ nav_order: 8
6
6
7
7
# Maintainer Guide
8
8
9
-
## how to change [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md)
9
+
## How to change [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md)
10
10
11
11
The entries in [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md) describe the usage of commands used by flux.
12
12
flux-commands.md is fully automatically generated. To make this happen one has to
@@ -37,9 +37,23 @@ The option's name is produced by cutting away the "set" from the methods name, l
37
37
"BatchSize" which is then lowercased. The parameter of this option is generated from the
38
38
parameter type of the method - here an "int"eger.
39
39
40
-
## how to publish [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/28-use-jekyll-theme/docs/flux/flux-commands.md)
40
+
## How to publish [docs/flux/flux-commands.md](https://github.com/metafacture/metafacture-documentation/blob/master/docs/flux/flux-commands.md)
41
41
42
42
If you have updated some of these annotations, say "description", and these changes are
43
-
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.
43
+
merged into the master branch, generate a new flux-commands.md:
44
+
go to the metafacture-core repo, build a distribution and start the flux script by doing:
45
+
46
+
```
47
+
cd git/metafacture-core # go to the mf-core repo
48
+
./gradlew metafacture-runner:signArchive # make a standalone distribution
49
+
find . -name "metafacture-core*dist.tar.gz" # find the distribution
50
+
tar xfz $pathToDst # unpack the distribution
51
+
find . -name "flux.sh" # find the start script
52
+
bash $pathToFlux.sh
53
+
```
54
+
55
+
Modify the generated output (i.e. the header), copy it to docs/flux/flux-commands.md and commit it.
56
+
57
+
Note that the example links to playground will only be generated if the "metafacture-documentation" repo is checked out and the file "linksAndExamples.tsv" is accessible via "../linksAndExamples.tsv" from the "metafacture-core" repo.
44
58
45
59
The [publishing process will be automated with an github action](https://github.com/metafacture/metafacture-core/issues/368).
Copy file name to clipboardExpand all lines: docs/flux/flux-commands.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,10 @@ parent: Flux
5
5
nav_order: 2
6
6
---
7
7
8
-
Available flux commands (with release 1.2.0)
8
+
Available flux commands on master branch
9
9
=======================
10
10
11
+
11
12
add-oreaggregation
12
13
------------------
13
14
- description: adds ore:Aggregation to an Europeana Data Model stream. The aggregation id is set by emitting literal('aggregation_id', id)
@@ -133,7 +134,7 @@ decode-html
133
134
decode-json
134
135
-----------
135
136
- description: Decodes JSON to metadata events. The 'recordPath' option can be used to set a JsonPath to extract a path as JSON - or to split the data into multiple JSON documents.
0 commit comments