From a39e16b3095e101b57c7cbac630a6b4310e6dff3 Mon Sep 17 00:00:00 2001 From: Aaron Date: Fri, 12 Jun 2020 16:00:11 +0200 Subject: [PATCH] Fix a few typos in the documentation (#2) Signed-off-by: Aaron --- docs/embedding.md | 4 ++-- docs/loading.md | 4 ++-- docs/locations.md | 12 ++++++------ docs/sharing.md | 6 +++--- docs/usage.md | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/embedding.md b/docs/embedding.md index c7e3731..545e45a 100644 --- a/docs/embedding.md +++ b/docs/embedding.md @@ -45,7 +45,7 @@ importScripts("https://unpkg.com/replaywebpage@1.0.0/sw.js"); Thus, if the HTML snippet was added to `https://my-site.example.com/path/my-web-archive-embed.html` then the sw.js should be added such that it is at: `https://my-site.example.com/path/replay/sw.js`. -That's it! Loading `https://my-site.example.com/path/my-web-archive-embed.html` should now load the web arhive. +That's it! Loading `https://my-site.example.com/path/my-web-archive-embed.html` should now load the web archive. (Be sure to add sizes to the `` tag as needed to size the embed). @@ -70,7 +70,7 @@ Another alternative would be: These URLs point to a specific version of ReplayWeb.page software released on NPM, eg. `1.0.0`, meaning that your replay should stay stable, even if ReplayWeb.page is updated. -You can choose another of ReplayWeb.page (or even try different versions) to ensure that you have tbest available replay. +You can choose another of ReplayWeb.page (or even try different versions) to ensure that you have the best available replay. This addresses the potential issue of older sites breaking when web archive replay software is updated. diff --git a/docs/loading.md b/docs/loading.md index 6e42839..9e460f7 100644 --- a/docs/loading.md +++ b/docs/loading.md @@ -28,7 +28,7 @@ Archives loaded by ReplayWeb.page are identified by their unique URL, which can Using the `Choose File...` button, you can pick any local archive file to load for replay. The click `Load` to load the file. -The archive is laoded in the browser directly and *not* uploaded anywhere -- it never leaves your computer! +The archive is loaded in the browser directly and *not* uploaded anywhere -- it never leaves your computer! The archive will be identified by a `file://` URL and is not accessible outside your browser. As expected, this URL is not shareable. @@ -56,7 +56,7 @@ See: [Supported Formats](formats) for more details on supported formats. ReplayWeb.page also supports loading archives directly from Google Drive. -ReplayWeb.page can be used to open .warc, .warc.gz files directly from google drive using the following steps. +ReplayWeb.page can be used to open .warc, .warc.gz files directly from Google Drive using the following steps. 1. Install [ReplayWeb.page Google Drive Integration](https://gsuite.google.com/u/2/marketplace/app/replaywebpage/160798412227) diff --git a/docs/locations.md b/docs/locations.md index 60da1cd..5fa11d6 100644 --- a/docs/locations.md +++ b/docs/locations.md @@ -9,7 +9,7 @@ permalink: /docs/locations ## Supported Location URLs -ReplayWeb.Page uses URLs to uniquely indentify web archives. +ReplayWeb.Page uses URLs to uniquely identify web archives. In addition HTTP/S, the system supports loading from additional cloud providers and via peer-to-peer decentralized services. The goal is to support loading @@ -31,7 +31,7 @@ The following is a list of currently supported URL schemes and details below: ### HTTP and HTTPS -While `https://replayweb.page` can load from any url, a site must allow access by enabling [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) +While `https://replayweb.page` can load from any URL, a site must allow access by enabling [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for the web archive. HTTP URLs may not be accessible from `https://replayweb.page` since it requires HTTPS. If you need to provide access to web archives stored on your own domain or over HTTP, consider @@ -45,15 +45,15 @@ Unlike other web archive URLs, file URLs can not be shared with others. ### Amazon S3 -The `s3://` url scheme is provided as a convenience to reference S3 URLs. The URL is converted to an HTTPS URL for access. +The `s3://` URL scheme is provided as a convenience to reference S3 URLs. The URL is converted to an HTTPS URL for access. The S3 Bucket must be public and also provide access to `https://replayweb.page` via CORS. Downloading via S3 credentials is not currently supported. ### Google Drive -The `googledrive://` url scheme is used when accessing a web archive shared over google drive. It provides a unique identifier -provided via Google Drive. When accessing a google drive URL, the user will be asked to authenticate to be able to access the file. +The `googledrive://` URL scheme is used when accessing a web archive shared over Google Drive. It provides a unique identifier +provided via Google Drive. When accessing a Google Drive URL, the user will be asked to authenticate to be able to access the file. ### IPFS @@ -63,7 +63,7 @@ Help Wanted {: .label .label-yellow } -The `ipfs://` url scheme is provide as a convenience and resolves to using the Cloudflare IPFS Gateway to download archives from IPFS. +The `ipfs://` URL scheme is provide as a convenience and resolves to using the Cloudflare IPFS Gateway to download archives from IPFS. A better implementation with IPFS directly is also possible. diff --git a/docs/sharing.md b/docs/sharing.md index 06e8c42..555e099 100644 --- a/docs/sharing.md +++ b/docs/sharing.md @@ -10,11 +10,11 @@ permalink: /docs/sharing ReplayWeb.page links are designed to be shareable with others, as long as they have access. -You can share links to any view, including Page or Page Resoures search, or Replay view. +You can share links to any view, including Page or Page Resources search, or Replay view. ReplayWeb.page encodes the web archive source and view parameters in the URL query and hash string. -Simply copy the entire location url, and you can share with others! +Simply copy the entire location URL, and you can share with others! ReplayWeb.page will parse the URL, load the source web archive, then load the view or replay from that archive. @@ -44,7 +44,7 @@ A future goal is to provide an option to share local web archives peer-to-peer v ### Sharing Google Drive Archives -An archive loaded from google drive can be shared with others, as long as they have access. +An archive loaded from Google Drive can be shared with others, as long as they have access. Google Drive Archive will have a `source=googledrive://...`. diff --git a/docs/usage.md b/docs/usage.md index 5a22916..e1c7b7e 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -21,7 +21,7 @@ ReplayWeb.page provides the following features: - High-Fidelity replay of web archives in [several formats](formats) and from [various locations](locations) directly in the browser. -- Several way to [explore web archives](explore): story view, page search and url search. +- Several way to [explore web archives](explore): story view, page search and URL search. - On-demand, incremental [loading of large archives](loading#loading-large-files-full-vs-on-demand-loading/).