-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve DOCX environment variable documentation
[ci skip] This build is based on 8c1a803. This commit was created by the following CI build and job: https://github.com/greenelab/jake_dissertation/commit/8c1a803748961dcf6b7e8ed4d5ec8f8ce6d5a2a9/checks https://github.com/greenelab/jake_dissertation/actions/runs/5894857672
- Loading branch information
0 parents
commit 854f647
Showing
25 changed files
with
11,349 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Output directory containing the formatted manuscript | ||
|
||
The [`gh-pages`](https://github.com/greenelab/jake_dissertation/tree/gh-pages) branch hosts the contents of this directory at <https://greenelab.github.io/jake_dissertation/>. | ||
The permalink for this webpage version is <https://greenelab.github.io/jake_dissertation/v/8c1a803748961dcf6b7e8ed4d5ec8f8ce6d5a2a9/>. | ||
To redirect to the permalink for the latest manuscript version at anytime, use the link <https://greenelab.github.io/jake_dissertation/v/freeze/>. | ||
|
||
## Files | ||
|
||
This directory contains the following files, which are mostly ignored on the `main` 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 | ||
[`8c1a803748961dcf6b7e8ed4d5ec8f8ce6d5a2a9`](https://github.com/greenelab/jake_dissertation/commit/8c1a803748961dcf6b7e8ed4d5ec8f8ce6d5a2a9). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.