Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wetneb/new-openrefine-website
Temporary repository to host a tentative new website for OpenRefine
https://github.com/wetneb/new-openrefine-website
Last synced: 29 days ago
JSON representation
Temporary repository to host a tentative new website for OpenRefine
- Host: GitHub
- URL: https://github.com/wetneb/new-openrefine-website
- Owner: wetneb
- Created: 2022-11-17T20:23:57.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-19T19:03:04.000Z (about 2 years ago)
- Last Synced: 2024-10-13T14:15:17.430Z (2 months ago)
- Language: HTML
- Homepage: https://wetneb.github.io/new-openrefine-website/
- Size: 9.11 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
How to build these docs
=======================
We use [Docusaurus 2](https://v2.docusaurus.io/) for our docs, a modern static website generator.
### Requirements
Assuming you have [Node.js (LTS recommended)](https://nodejs.org/en/download/) installed (which includes npm), you can install Docusaurus with:
You will need to install [Yarn](https://yarnpkg.com/getting-started/install) before you can build the site.
```sh
npm install -g yarn
```
### Installation
Once you have installed yarn, navigate to docs directory & set-up the dependencies.
```sh
cd docs
yarn
```
### Local Development
```sh
yarn start
```
This command starts a local development server and opens up a browser window. Usually at the URL
Most changes are reflected live without having to restart the server.
If you get an error starting yarn mentioning `update.latest` such as
```sh
>yarn start
if (notifier.update && semver.gt(this.update.latest, this.update.current)) {
TypeError: Cannot read property 'latest' of undefined
at Object. (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
```sh
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:
1. Git checkout our `master` branch
2. Edit files under `docs/docs/`
3. Preview changes with the URL kept pointing to which will automatically
show changes live with yarn after you save a file.
### Build
```sh
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](https://docusaurus.io/docs/cli#docusaurus-serve-sitedir)) the static content in the `build` directory (in case you don't have access to a hosting service) by using:
```sh
yarn serve
```
or to build and then serve locally with one command:
```sh
yarn serve --build
```
### Deployment
```sh
GIT_USER= 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](https://docs.openrefine.org/) via the
Crowdin platform:
Unfortunately, unlike Weblate, we need to manually invite anyone who
wants to contribute translations. Feel free to request an invite by emailing us at [email protected]
We can also add languages, depending on interest.
Your translations will not be immediately published on , it will take a few days
(at the next commit on the master branch).
The translated pages will first appear under (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.
### License
This documentation is published under the [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).