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

Fleshes out documentation for reproducibility purposes; other minor doc fixes. Resolves #282. #283

Merged
merged 1 commit into from Apr 11, 2019

Conversation

Projects
None yet
4 participants
@ianmilligan1
Copy link
Member

ianmilligan1 commented Apr 10, 2019

What does this Pull Request do?

This pull request fleshes out our documentation in a few places.

The main addition is to add reference to the "most-recent version of the Archives Unleashed Toolkit." This is exposed through linking to the release pages. It also adds an explicit section in the FAQ noting around reproducibility concerns.

I also made some minor changes that supported this:

  • Highlighting the FAQ on the documentation page so that people could better discover that page;
  • Minor typo fix
  • Updating 2018 -> 2019

How should this be tested?

TravisCI should turn green. Somebody should read to make sure I haven't introduced any typos or weird grammatical constructions.

Interested parties

@ruebot @SamFritz

@ianmilligan1 ianmilligan1 requested review from ruebot and SamFritz Apr 10, 2019

@codecov-io

This comment has been minimized.

Copy link

codecov-io commented Apr 10, 2019

Codecov Report

Merging #283 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #283   +/-   ##
=======================================
  Coverage   96.22%   96.22%           
=======================================
  Files          35       35           
  Lines         557      557           
=======================================
  Hits          536      536           
  Misses         21       21

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55b8aed...384ea6a. Read the comment docs.

@ruebot

ruebot approved these changes Apr 10, 2019

@SamFritz
Copy link
Member

SamFritz left a comment

Looks great! Thanks @ianmilligan1

@ianmilligan1

This comment has been minimized.

Copy link
Member Author

ianmilligan1 commented Apr 11, 2019

Great, thanks for your reviews @SamFritz @ruebot! Should be good to merge if it checks out on all of your ends.

@ruebot ruebot merged commit 8e5e65b into master Apr 11, 2019

3 checks passed

codecov/patch Coverage not affected when comparing 55b8aed...384ea6a
Details
codecov/project 96.22% remains the same compared to 55b8aed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ruebot ruebot deleted the issue-282 branch Apr 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.