Skip to content
This repository has been archived by the owner on Jun 30, 2021. It is now read-only.

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

Merged
merged 1 commit into from Apr 11, 2019

Conversation

ianmilligan1
Copy link
Member

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

@codecov-io
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.

Copy link
Member

@SamFritz SamFritz left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks @ianmilligan1

@ianmilligan1
Copy link
Member Author

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
@ruebot ruebot deleted the issue-282 branch April 11, 2019 16:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants