RandomSec/docs
Florian Giroud 7950d764ff
Architecture for front end browser-based UI tests, issue #733 (#3340)
* Added Cypress tests to OpenRefine
* Installed Cypress
* Added a few tests to cover basic OR features
Y

* Enriched langage Tests

* Enriched project_create tests

* Refactored and enriched undo/redo tests, added extract & apply

* Upgraded Cypress to 5.6.0

* Removed the cypress-dot-env plugin, as Cypress now supports nice configuration capabilities

* Added UX tests documentation

* Improved functional tests documentation, added license and description to tests package.json
2020-11-23 18:18:12 +01:00
..
docs Architecture for front end browser-based UI tests, issue #733 (#3340) 2020-11-23 18:18:12 +01:00
src Documentation style changes (#3178) 2020-09-16 15:21:56 +02:00
static Normalize case of image extension in docs (again) 2020-11-18 18:36:26 +01:00
.gitignore begin Docusaurus 2 migration (#2799) 2020-06-29 08:45:24 +02:00
docusaurus.config.js Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00
package.json Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00
README.md begin Docusaurus 2 migration (#2799) 2020-06-29 08:45:24 +02:00
sidebars.js Architecture for front end browser-based UI tests, issue #733 (#3340) 2020-11-23 18:18:12 +01:00
yarn.lock Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00

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. Most changes are reflected live without having to restart the server.

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.