Skip to content

Commit

Permalink
Fix broken references to webpage.py
Browse files Browse the repository at this point in the history
Merges #269
Follows up 188e51a

* python webpage.py -> manubot webpage
* clarify CI use of manubot webpage in deploy.sh
  • Loading branch information
rhagenson authored and dhimmel committed Sep 18, 2019
1 parent 0dc5ea8 commit 9811137
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ bash build/build.sh
# This is required to view local images in the HTML output.

# Configure the webpage directory
python build/webpage.py
manubot webpage

# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
Expand All @@ -66,7 +66,7 @@ python -m http.server
```

Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected.
The following command, while running, will trigger both the `build.sh` and `webpage.py` scripts upon content changes:
The following command, while running, will trigger both the `build.sh` script and `manubot webpage` command upon content changes:

```sh
bash build/autobuild.sh
Expand Down
2 changes: 1 addition & 1 deletion build/autobuild.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

watchmedo shell-command \
--wait \
--command='bash build/build.sh && python build/webpage.py' \
--command='bash build/build.sh && manubot webpage' \
content
4 changes: 2 additions & 2 deletions webpage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ In general, a version is identified by the commit hash of the source content tha

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.
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.
`webpage.py`, which is run during continuous deployment, identifies files matched by `webpage/v/**/*.ots` and attempts to upgrade them.
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:

```sh
Expand Down

0 comments on commit 9811137

Please sign in to comment.