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.

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

Document the command line app. #51

Merged
merged 3 commits into from Apr 7, 2020
Merged

Document the command line app. #51

merged 3 commits into from Apr 7, 2020

Conversation

@ruebot
Copy link
Member

ruebot commented Apr 7, 2020

@lintool @ianmilligan1 @SamFritz here is a first crack at documenting the command line app. Please let me know how this approach works.

- Resolves #14
- Documents archivesunleashed/aut#431
@ruebot ruebot requested review from lintool, ianmilligan1 and SamFritz Apr 7, 2020
@ruebot

This comment has been minimized.

Copy link
Member Author

ruebot commented Apr 7, 2020

Copy link
Member

SamFritz left a comment

@ruebot, this is looking really good! I like the flow you've given to all the documentation. I have a few surface level suggestions. My only major comment is related to how to start off with the scripts - hopefully I'm not overthinking things.

Look forward to working with this more! :)

current/aut-spark-submit-app.md Outdated Show resolved Hide resolved
current/aut-spark-submit-app.md Outdated Show resolved Hide resolved
@@ -0,0 +1,128 @@
# Using the Toolkit with spark-submit

This comment has been minimized.

Copy link
@SamFritz

SamFritz Apr 7, 2020

Member

Do these configuration options need to be used with a specific launch of the toolkit (e.g. package, uberjar, etc.)? At first glance, I guess I'm a little unsure of where to start or in terms of workflow, when this script would be introduced (e.g. use within or outside of sparkshell?)

This comment has been minimized.

Copy link
@ruebot

The extration jobs have a basic outline of:

`spark-submit --class io.archivesunleashed.app.CommandLinAppRunner PATH_TO_AUT_JAR --extractor EXTRACTOR --input INPUT DIRECTORY --output OUTPUT DIRECTORY`

This comment has been minimized.

Copy link
@SamFritz

SamFritz Apr 7, 2020

Member

is it possible to put in an example of how this script would look if one of us were to run it, below the basic outline? I find that when I have an example it's a bit easier to see what needs to be changed in line.

This comment has been minimized.

Copy link
@ruebot

ruebot Apr 7, 2020

Author Member

That's what all the examples are below.

This comment has been minimized.

Copy link
@SamFritz

SamFritz Apr 7, 2020

Member

Oh yeah, I realize the examples further down are more detailed - I just was going down a different line of thinking, so disregard my original comment

current/aut-spark-submit-app.md Show resolved Hide resolved
@ianmilligan1 ianmilligan1 merged commit dbe71c3 into master Apr 7, 2020
2 checks passed
2 checks passed
delivery
Details
delivery
Details
@ianmilligan1 ianmilligan1 deleted the issue-14 branch Apr 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants
You can’t perform that action at this time.