Set up docs deployment process with Netlify (#2567)

* Set up docs deployment process with Netlify

* make steps a bit more clear (#2568)

Node.js is fully needed for Docusaurus things (package verifying, etc.).

* Update the docs ReadMe for Yarn Installation (#2569)

* Update the package.json manifest (#2570)

Co-authored-by: Thad Guidry <thadguidry@gmail.com>
Co-authored-by: Kush Trivedi <44091822+kushthedude@users.noreply.github.com>
This commit is contained in:
Antonin Delpeuch 2020-04-20 12:17:38 +02:00 committed by GitHub
parent da5bdcfdad
commit b361df227f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 2 deletions

28
docs/README.md Normal file
View File

@ -0,0 +1,28 @@
How to build these docs
=======================
We use [Docusaurus](https://docusaurus.io/) for our docs. Assuming you have [Node.js](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
```
Once you have installed yarn, navigate to docs directory & set-up the dependencies.
```sh
cd docs
yarn
```
Once this is done, generate the docs with:
```sh
yarn build
```
You can also spin a local web server to serve the docs for you, with auto-refresh when you edit the source files, with:
```sh
yarn start
```

View File

@ -1,4 +1,9 @@
{
"name": "OpenRefine-Documentation",
"version": "1.0.0",
"description": "Documentation for OpenRefine",
"license": "BSD-3-Clause",
"author": "OpenRefine",
"scripts": {
"examples": "docusaurus-examples",
"start": "docusaurus-start",

View File

@ -4,8 +4,8 @@
const siteConfig = {
title: 'OpenRefine', // Title for your website.
tagline: 'A power tool for working with messy data.',
url: 'https://openrefine.github.io/',
baseUrl: '/docs-prototype/',
url: 'https://docs.openrefine.org/',
baseUrl: '/',
projectName: 'OpenRefine',
organizationName: 'OpenRefine',