6375baf5ea
Bumps [@crowdin/cli](https://github.com/crowdin/crowdin-cli) from 3.6.3 to 3.6.4. - [Release notes](https://github.com/crowdin/crowdin-cli/releases) - [Changelog](https://github.com/crowdin/crowdin-cli/blob/cli3/CHANGELOG.md) - [Commits](https://github.com/crowdin/crowdin-cli/compare/3.6.3...3.6.4) --- updated-dependencies: - dependency-name: "@crowdin/cli" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| versioned_docs/version-3.4 | ||
| versioned_sidebars | ||
| .gitignore | ||
| .node-version | ||
| crowdin.yml | ||
| docusaurus.config.js | ||
| netlify.toml | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| versions.json | ||
| yarn.lock | ||
How to build these docs
We use Docusaurus 2 for our docs, a modern static website generator.
Requirements
Assuming you have Node.js 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.
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
masterbranch - 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.
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) and 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.