Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add links to flux-commands.md #509

Merged
merged 4 commits into from
Nov 21, 2023
Merged

Add links to flux-commands.md #509

merged 4 commits into from
Nov 21, 2023

Conversation

dr0i
Copy link
Member

@dr0i dr0i commented Nov 20, 2023 •
edited
Loading

See #488.

The tsv to enrich the flux-commands.md is taken from the repo metafacture/metafacture-documentation.
If the file resides at the proper location the following is produced (snippet):

add-oreaggregation

  • description: adds ore:Aggregation to an Europeana Data Model stream. The aggregation id is set by emitting literal('aggregation_id', id)
  • signature: StreamReceiver -> StreamReceiver
  • java class: org.metafacture.linkeddata.OreAggregationAdder

add-preamble-epilogue

As shown, the link to the Playground example is only inserted if it exists, see metafacture/metafacture-documentation#24.

@dr0i dr0i mentioned this pull request Nov 20, 2023
Merged
@blackwinter
Copy link
Member

I would prefer adding an extra line to the command details instead of "hijacking" the heading.

@dr0i
Copy link
Member Author

dr0i commented Nov 20, 2023

You mean like in:

add-preamble-epilogue

...

@dr0i dr0i marked this pull request as draft November 20, 2023 14:33
@dr0i dr0i force-pushed the 488-addLinksToPgToFluxCommands branch from b378ba4 to 26ae944 Compare November 20, 2023 15:01
blackwinter
blackwinter requested changes Nov 20, 2023
View reviewed changes
Copy link
Member

@blackwinter blackwinter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some remarks.

Also, checks are still failing.

metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java Outdated Show resolved Hide resolved
metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java Outdated Show resolved Hide resolved
metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java Outdated Show resolved Hide resolved
metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java Outdated Show resolved Hide resolved
metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java Outdated Show resolved Hide resolved
metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinter.java Outdated Show resolved Hide resolved
@blackwinter blackwinter assigned dr0i and unassigned blackwinter Nov 20, 2023
@dr0i dr0i force-pushed the 488-addLinksToPgToFluxCommands branch 2 times, most recently from 3f6fa3e to 75a9c7d Compare November 21, 2023 10:55
@dr0i
Add links to flux-commands.md (#488)
3498dc8 
The tsv to enrich the flux-commands.md is taken from the repo
metafacture/metafacture-documentation.
@dr0i dr0i force-pushed the 488-addLinksToPgToFluxCommands branch from 75a9c7d to 3498dc8 Compare November 21, 2023 11:01
@dr0i dr0i marked this pull request as ready for review November 21, 2023 11:05
@dr0i dr0i assigned blackwinter and unassigned dr0i Nov 21, 2023
@dr0i @blackwinter
Update metafacture-flux/src/main/java/org/metafacture/flux/HelpPrinte…
ab656cb 
…r.java

Co-authored-by: Jens Wille <jens.wille@hbz-nrw.de>
@dr0i dr0i force-pushed the 488-addLinksToPgToFluxCommands branch from 973d392 to ab656cb Compare November 21, 2023 11:07
@dr0i
Copy link
Member Author

dr0i commented Nov 21, 2023

PR is good to review again. Thx for the many pointers @blackwinter . Sorry for ignoring your suggestions - overlooked them beeing github suggestions but for the last one :/

@blackwinter blackwinter assigned dr0i and unassigned blackwinter Nov 21, 2023
@dr0i dr0i assigned blackwinter and unassigned dr0i Nov 21, 2023
@blackwinter
Future-proof additional command info; print warning instead of throwi…
25a2779 
…ng an exception for invalid/incomplete entries. (#509)
@blackwinter blackwinter assigned dr0i and unassigned blackwinter Nov 21, 2023
blackwinter
blackwinter approved these changes Nov 21, 2023
View reviewed changes
Copy link
Member

@blackwinter blackwinter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proceed as you see fit.

@dr0i
Copy link
Member Author

dr0i commented Nov 21, 2023

Thx, that's more elegant! I liked the bailing out more - but I can live with Invalid command info: in the output.

@dr0i dr0i merged commit 52e4141 into master Nov 21, 2023
1 check passed
@dr0i dr0i deleted the 488-addLinksToPgToFluxCommands branch November 21, 2023 15:43
@dr0i
Copy link
Member Author

dr0i commented Nov 21, 2023

Merged and closed.

blackwinter added a commit to metafacture/metafacture-fix that referenced this pull request Nov 23, 2023
@blackwinter
Change link text for playground examples. (#339)
a22c122 
To be more in line with Flux commands; see metafacture/metafacture-core#509.
@blackwinter blackwinter mentioned this pull request Nov 27, 2023
Open
3 tasks
blackwinter added a commit that referenced this pull request Dec 20, 2023
@blackwinter
Fix visibility of HelpPrinter constant PATH_TO_EXAMPLES. (#509, 349…
a99fba9 
…8dc8)

Referenced in JavaDoc:

warning - #PATH_TO_EXAMPLES (referenced by @value tag) is an unknown reference.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blackwinter blackwinter blackwinter approved these changes

Assignees

@dr0i dr0i

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@dr0i @blackwinter