How to build these docs

We use Docusaurus 2 for our docs, a modern static website generator.

Requirements

Assuming you have Node.js (LTS recommended) installed (which includes npm), you can install Docusaurus with:

You will need to install Yarn before you can build the site.

npm install -g yarn

Installation

Once you have installed yarn, navigate to docs directory & set-up the dependencies.

cd docs
yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Usually at the URL http://localhost:3000 Most changes are reflected live without having to restart the server.

If you get an error starting yarn mentioning update.latest such as

>yarn start

if (notifier.update && semver.gt(this.update.latest, this.update.current)) {
TypeError: Cannot read property 'latest' of undefined
    at Object.<anonymous> (E:\GitHubRepos\OpenRefine\docs\node_modules\@docusaurus\core\bin\docusaurus.js:49:46)
error Command failed with exit code 1.

then it is likely that you will need to first run

yarn upgrade

which will update all dependencies and store them in the yarn.lock file to also be committed.

Next version of OpenRefine docs

If you wish to work on the next version of docs for OpenRefine (master branch) then you will need to:

Git checkout our master branch
Edit files under docs/docs/
Preview changes with the URL kept pointing to http://localhost:3000/next which will automatically show changes live with yarn after you save a file.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

(Optional) Test Build Locally

You can locally test (with parameters) the static content in the build directory (in case you don't have access to a hosting service) by using:

yarn serve

or to build and then serve locally with one command:

yarn serve --build

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Translations

It is now possible to translate the OpenRefine docs via the Crowdin platform:

https://crowdin.com/project/openrefine

Unfortunately, unlike Weblate, we need to manually invite anyone who wants to contribute translations. Feel free to request an invite by emailing us at openrefine-dev@googlegroups.com We can also add languages, depending on interest.

Your translations will not be immediately published on https://docs.openrefine.org, it will take a few days (at the next commit on the master branch). The translated pages will first appear under https://docs.openrefine.org/next/ (the documentation for the development version). When we publish a version, the translations for that version, we will take a snapshot of the translations during that time. We will trial this process for 3.5.

3.2 KiB Raw Blame History