https://github.com/greenelab/meta-review
Raw File
Tip revision: 58ea23c7335e63ca89353cb44cb79194b62b3c83 authored by Daniel Himmelstein on 25 May 2020, 15:06:53 UTC
PR #265 to update Rootstock on 2020-05-25
Tip revision: 58ea23c
README.md
# Output directory containing the formatted manuscript

The [`gh-pages`](https://github.com/greenelab/meta-review/tree/gh-pages) branch hosts the contents of this directory at <https://greenelab.github.io/meta-review/>.
The permalink for this webpage version is <https://greenelab.github.io/meta-review/v/2482af490804891c7f00b248c4e7ef7f356a0730/>.
To redirect to the permalink for the latest manuscript version at anytime, use the link <https://greenelab.github.io/meta-review/v/freeze/>.

## Files

This directory contains the following files, which are mostly ignored on the `master` branch:

+ [`index.html`](index.html) is an HTML manuscript.
+ [`manuscript.pdf`](manuscript.pdf) is a PDF manuscript.

The `v` directory contains directories for each manuscript version.
In general, a version is identified by the commit hash of the source content that created it.

### Timestamps

The `*.ots` files in version directories are OpenTimestamps which can be used to verify manuscript existence at or before a given time.
[OpenTimestamps](https://opentimestamps.org/) uses the Bitcoin blockchain to attest to file hash existence.
The `deploy.sh` script run during continuous deployment creates the `.ots` files through its `manubot webpage` call.
There is a delay before timestamps get confirmed by a Bitcoin block.
Therefore, `.ots` files are initially incomplete and should be upgraded at a later time, so that they no longer rely on the availability of a calendar server to verify.
The `manubot webpage` call during continuous deployment identifies files matched by `webpage/v/**/*.ots` and attempts to upgrade them.
You can also manually upgrade timestamps, by running the following in the `gh-pages` branch:

```shell
ots upgrade v/*/*.ots
rm v/*/*.ots.bak
git add v/*/*.ots
```

Verifying timestamps with the `ots verify` command requires running a local bitcoin node with JSON-RPC configured, at this time.

## Source

The manuscripts in this directory were built from
[`2482af490804891c7f00b248c4e7ef7f356a0730`](https://github.com/greenelab/meta-review/commit/2482af490804891c7f00b248c4e7ef7f356a0730).
back to top