Documentation contributions

We use Docusaurus for our docs. The repository for those docs is OpenRefine/openrefine.org. For small documentation changes, you should be able to edit the Markdown files directly and submit them as a pull request. Each documentation page has a link at the bottom to help you do this in a few clicks. Once you submit your pull request, a preview of the docs will be generated automatically.

But it is also possible to preview your changes locally. We used Yarn to install Docusaurus, see docs/yarn.lock; or see Docusaurus installation for how to seed a new docusaurus project.

You need to have Node.js installed, which includes npm. You also need to install Yarn before you can build the site:

npm install -g yarn

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

cd docs
yarn

Once this is done, generate the docs with:

yarn build

You can also spin a local web server to serve the docs for you. A browser window will open at http://localhost:3000 and will auto-refresh when you edit the source files:

yarn start