Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261)
* Update docusaurus to fix security vuln in dependency Also update docusaurus config to match new version. Fixed some broken links in the documentation, but not sure if they were related to the version change. * Remove bad links * Make broken links a warning instead of error
This commit is contained in:
Tom Morris
GitHub
parent
2d74f1dd1b
commit
d3d62a62c3
@ -1,4 +1,5 @@
|
||||
---
|
||||
slug: /
|
||||
id: index
|
||||
title: OpenRefine product reference
|
||||
sidebar_label: Index
|
||||
|
||||
@ -70,7 +70,7 @@ Take note of the [extensions](#installing-extensions) you have currently install
|
||||
|
||||
### Install or upgrade Java
|
||||
|
||||
[Java Development Kit (JDK)](https://jdk.java.net/) is required to run OpenRefine and should be installed first. [OpenRefine installation packages for Mac and Windows come bundled with JDK]([https://openrefine.org/download.html](https://openrefine.org/download.html)), so you do not need to install it separately if you use those bundles.
|
||||
[Java Development Kit (JDK)](https://jdk.java.net/) is required to run OpenRefine and should be installed first. [OpenRefine installation packages for Mac and Windows come bundled with JDK](https://openrefine.org/download.html), so you do not need to install it separately if you use those bundles.
|
||||
|
||||
There are JDK packages for Mac, Windows, and Linux. We recommend you install the latest “Ready for use” version: at the time of writing, this is [JDK 14.0.1](https://jdk.java.net/14/).
|
||||
|
||||
|
||||
@ -4,6 +4,9 @@ title: How to build, test and run
|
||||
sidebar_label: How to build, test and run
|
||||
---
|
||||
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
|
||||
You will need:
|
||||
* [OpenRefine source code](https://github.com/OpenRefine/OpenRefine)
|
||||
* [Java JDK](http://java.sun.com/javase/downloads/index.jsp)
|
||||
@ -87,16 +90,16 @@ git clone https://github.com/OpenRefine/OpenRefine.git
|
||||
|
||||
In Eclipse, invoke the `Import...` command and select `Existing Maven Projects`.
|
||||
|
||||
|
||||
|
||||
|
||||
Choose the root directory of your clone of the repository. You get to choose which modules of the project will be imported. You can safely leave out the `packaging` module which is only used to generate the Linux, Windows and MacOS distributions.
|
||||
|
||||
|
||||
<img alt="Screenshot of Select maven projects to import" src={useBaseUrl('img/eclipse-import-maven-project-2.png')} />
|
||||
|
||||
To run and debug OpenRefine from Eclipse, you will need to add an execution configuration on the `server` sub-project.
|
||||
Right click on the `server` subproject, click `Run as...` and `Run configurations...`. Just pick the root directory of the project and use `exec:java` as a Maven goal.
|
||||
|
||||
|
||||
|
||||
|
||||
This will add a run configuration that you can then use to run OpenRefine from Eclipse.
|
||||
|
||||
@ -104,7 +107,7 @@ This will add a run configuration that you can then use to run OpenRefine from E
|
||||
|
||||
You can run the server tests directly from Eclipse. To do that you need to have the TestNG launcher plugin installed, as well as the TestNG M2E plugin (for integration with Maven). If you don't have it, you can get it by [installing new software](https://help.eclipse.org/2020-03/index.jsp?topic=/org.eclipse.platform.doc.user/tasks/tasks-129.htm) from this update URL http://dl.bintray.com/testng-team/testng-eclipse-release/
|
||||
|
||||
Once the TestNG launching plugin is installed in your Eclipse, right click on the source folder , select `Run As` -> `TestNG Test`. This should open a new tab with the TestNG launcher running the OpenRefine tests.
|
||||
Once the TestNG launching plugin is installed in your Eclipse, right click on the source folder "main/tests/server/src", select `Run As` -> `TestNG Test`. This should open a new tab with the TestNG launcher running the OpenRefine tests.
|
||||
|
||||
### Test coverage in Eclipse
|
||||
|
||||
@ -113,7 +116,7 @@ It is possible to analyze test coverage in Eclipse with the `EclEmma Java Code C
|
||||
### Debug with Eclipse
|
||||
Here's an example of putting configuration in Eclipse for debugging, like putting values for the Google Data extension. Other type of configurations that can be set are memory, Wikidata login information and more.
|
||||
|
||||
|
||||
|
||||
|
||||
## Building, Testing and Running OpenRefine from IntelliJ idea
|
||||
|
||||
@ -125,22 +128,22 @@ git clone https://github.com/OpenRefine/OpenRefine.git
|
||||
|
||||
Then, open the IntelliJ idea and go to `file -> open` and select the location of the cloned repository.
|
||||
|
||||
|
||||
|
||||
|
||||
It will prompt you to add as a maven project as the source code contains a pom.xml file in it. Allow `auto-import` so that it can add it as a maven project.
|
||||
If it doesn't prompt something like this then you can go on the right side of the IDE and click on maven then, click on `reimport all the maven projects` that will add all the dependencies and jar files required for the project.
|
||||
|
||||
|
||||
|
||||
|
||||
After this, you will be able to properly build, test, and run the OpenRefine project from the terminal.
|
||||
But if you will go to any of the test folders and open some file it will show you some import errors because the project isn't yet set up at the module level.
|
||||
|
||||
For removing those errors, and enjoying the features of the IDE like ctrl + click, etc you need to set up the project at the module level too. Open the different modules like `extensions/wikidata`, `main` as a project in the IDE. Then, right-click on the project folder and open the module settings.
|
||||
|
||||
|
||||
|
||||
|
||||
In the module settings, add the source folder and test source folders of that module.
|
||||
|
||||
|
||||
|
||||
|
||||
Then, do the same thing for the main OpenRefine project and now you are good to go.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
module.exports = {
|
||||
onBrokenLinks: 'warn',
|
||||
title: 'OpenRefine',
|
||||
tagline: 'A power tool for working with messy data.',
|
||||
url: 'https://docs.openrefine.org/',
|
||||
@ -13,7 +14,7 @@ module.exports = {
|
||||
alt: 'OpenRefine diamond logo',
|
||||
src: 'img/openrefine_logo.png',
|
||||
},
|
||||
links: [
|
||||
items: [
|
||||
{
|
||||
to: '/',
|
||||
activeBasePath: 'docs',
|
||||
@ -38,23 +39,6 @@ module.exports = {
|
||||
},
|
||||
style: 'dark',
|
||||
links: [
|
||||
{
|
||||
title: 'Docs',
|
||||
items: [
|
||||
{
|
||||
label: 'Style Guide',
|
||||
to: 'docs/styleguide',
|
||||
},
|
||||
{
|
||||
label: 'Technical Reference',
|
||||
to: 'docs/tech',
|
||||
},
|
||||
{
|
||||
label: 'Contributors',
|
||||
to: 'docs/contrib',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
@ -104,7 +88,6 @@ module.exports = {
|
||||
editUrl: 'https://github.com/OpenRefine/OpenRefine/edit/master/docs',
|
||||
// Equivalent to `docsUrl`.
|
||||
routeBasePath: '/',
|
||||
homePageId: 'index',
|
||||
// Remark and Rehype plugins passed to MDX. Replaces `markdownOptions` and `markdownPlugins`.
|
||||
remarkPlugins: [],
|
||||
rehypePlugins: [],
|
||||
|
||||
@ -12,10 +12,10 @@
|
||||
"deploy": "docusaurus deploy"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "^2.0.0-alpha.58",
|
||||
"@docusaurus/core": "^2.0.0-alpha.65",
|
||||
"@docusaurus/preset-classic": "^2.0.0-alpha.58",
|
||||
"clsx": "^1.1.1",
|
||||
"react": "^16.8.4",
|
||||
"react-dom": "^16.8.4"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
4089
docs/yarn.lock
4089
docs/yarn.lock
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user