Commit Graph

116 Commits

Author SHA1 Message Date
allanaaa
72af127010 Updates to wikidata 2021-01-05 16:46:02 -05:00
allanaaa
4a4be06b24 Merge branch 'docs-formatting' of https://github.com/allanaaa/OpenRefine into docs-formatting 2021-01-05 12:07:32 -05:00
allanaaa
5d9086cc6f Update reconciling.md 2021-01-05 12:07:20 -05:00
allanaaa
c0ffed370c
Merge branch 'master' into docs-formatting 2021-01-05 12:00:48 -05:00
allanaaa
1e0c3fa34e Updates to Reconciling 2021-01-05 11:59:11 -05:00
dependabot[bot]
08d602bdaf
Bump ini from 1.3.5 to 1.3.7 in /docs (#3403)
Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.7.
- [Release notes](https://github.com/isaacs/ini/releases)
- [Commits](https://github.com/isaacs/ini/compare/v1.3.5...v1.3.7)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-12-30 09:13:33 +01:00
allanaaa
8eabec1ea5
Docs > Exporting (#3336)
* Exporting text, added link to Starting

* Expanded on custom tabular exporter

* Update exporting.md

* img problems?

* retry

* added SQL section + exporting operations

* Delete templating-exporter.PNG

* Create templating-exporter.png

* Expansion + some temporary text

* Update exporting.md

* Formatting and etc

* SQL exporter
2020-12-19 15:27:57 +01:00
allanaaa
45646d0253 More 2020-12-16 12:58:28 -05:00
allanaaa
6fa08ee264 More 2020-12-16 11:18:00 -05:00
Florian Giroud
4b6106a386
Run UI tests in continuous integration (#3393)
* Fixed flaky tests

* Refactored ui_test commans-line, added documentation

* Attempt to build a workflow with cypress

* Fixed CI UX tests build

* Changed cyprss actions for pull-request

* Merged Cypress workflow into the regular PR target workflow

* Refactored Github workflows to include Cypress Tests

* Revert Ci build to pull_request_target
2020-12-15 20:34:15 +01:00
allanaaa
61f531b6e7 Images are good 2020-12-14 16:22:13 -05:00
allanaaa
5c13397965 Links, HTML, small rewrites 2020-12-14 16:11:48 -05:00
Antonin Delpeuch
060375b007 Normalize case of documentation image extensions 2020-12-04 09:01:09 +01:00
allanaaa
699e80b94e Create expression-editor.png 2020-12-02 14:02:12 -05:00
allanaaa
dbf6434a2c Delete expression-editor.PNG 2020-12-02 14:01:58 -05:00
allanaaa
f7404799e3 Across-the-docs updates 2020-12-02 13:44:55 -05:00
allanaaa
6edfda79a3
Docs > Expressions (#3264)
* Update expressions.md

No function reference just yet, nor text for Jython and Clojure. This will all likely be split out into multiple pages, but for now, it's all one for ease of discussion.

* Adding some functions structure for discussion

* Small tweaks

* Accept edits first, duh

* Shortening shorthands

* Update expressions.md

* Tweaks forever

* Adding table of math functions

* Typos, Clojure examples, cross() recipe

* Formatting and language

* Misc clarifications

* Splitting the pages

* Update grelfunctions.md

* Formatting + resolving comments

* Removing a table hack

* Update grelfunctions.md

* Update grelfunctions.md

* Update grelfunctions.md

* Added columnName

* Update grelfunctions.md

* Update grelfunctions.md

* Update expressions.md

* Forgot to fix some links when I split the pages

* Regex updates
2020-12-02 13:08:00 +01:00
leoshrey
e08356598a
Style modifications in docusaurus docs to fix #3329 (#3365)
* Decreased padding for dropdown menu items

* Removed style code for dropdown items
2020-11-29 16:25:58 +01:00
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
Antonin Delpeuch
528f4a4976 Normalize case of image extension in docs (again) 2020-11-18 18:36:26 +01:00
Antonin Delpeuch
ed6a2fd1fe Normalize image file names in docs (lowercase extension) 2020-11-18 17:54:27 +01:00
allanaaa
e843a0ce84
Docs > Wikidata (#3203)
* Docs > Wikidata

* Cleaning up some egregious formatting

* Add section about terms in schemas

* Resolving some of Owen's comments

* Update wikidata.md

* Update docs/docs/manual/wikidata.md

Co-authored-by: Tom Morris <tfmorris@gmail.com>

* Update docs/docs/manual/wikidata.md

Co-authored-by: Tom Morris <tfmorris@gmail.com>

* Update docs/docs/manual/wikidata.md

Co-authored-by: Tom Morris <tfmorris@gmail.com>

* Update wikidata.md

* Remove wikibase bit for now

* Update docs/docs/manual/wikidata.md

Co-authored-by: Tom Morris <tfmorris@gmail.com>

* Add image, small fixes

* Removing material

* Cleanup and tweaks

* Update docs/docs/manual/wikidata.md

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>

Co-authored-by: Tom Morris <tfmorris@gmail.com>
Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
2020-11-16 19:22:46 +01:00
Tom Morris
d3d62a62c3
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
2020-10-16 20:49:57 +02:00
Owen Stephens
50d958608a
Fix image filenames and links in documentation (#3268)
* Fix case of PNG extensions

* Fix incorrect links
2020-10-16 10:26:27 +02:00
allanaaa
c7b7e26d61
Docs > Transforming data (#3103)
* Docs > Transforming data

Cell editing page is up first. Ignore the "overview" page for now.

* Add column-editing page

* Update docs/docs/manual/cellediting.md

Co-authored-by: Tom Morris <tfmorris@gmail.com>

* Vairous updates from Tom's comments

* Reconciling + Transposing

* Mistakes!

* Another mistake!

* column editing > fetching URLs

* Update cellediting.md

* Update docs/docs/manual/reconciling.md

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>

* Move + edit reconciliation page

* Update reconciling.md

* Update columnediting.md

* Edit transposing

+ fetch error message update
+ misc formatting

* Title fix

* Phrasing

Co-authored-by: Tom Morris <tfmorris@gmail.com>
Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
2020-10-08 16:23:29 +02:00
allanaaa
95983c4ac0
Updating exploring.md (#3035)
* Updating Exploring, with images

Images still need some trimming. Haven't explained logs yet.

* Typos and minor fixes

* Update exploring.md

* Expanding a bit on records mode

* Adding a caution box

* Log text, link fixes, remove infobox, fix phrasing, etc

* Whoops, missed a bracket

* Expanding the log facet section, thanks @thadguidry

And fixing some date-format information.

* Splitting into three pages

* Expanding on records mode

So helpful that we call it the "key column" in the wiki!

* Updates to all three pages

* Update facets.md

* Update sort/view

* Update exploring.md

* Update exploring.md

* Update exploring.md
2020-09-17 12:25:51 +02:00
Jathin Sreenivas
cb69a90a64
Documentation style changes (#3178)
* Fixes for Issue #3059

* Removed menuItems class for values (typed or displayed) and replaced with ` `

* Styling of various items

* Documentation style changes

* Menu Item styling

* Document Style Changes - Line Break & border color
2020-09-16 15:21:56 +02:00
dependabot[bot]
5e7c67835a
Bump prismjs from 1.20.0 to 1.21.0 in /docs
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.20.0 to 1.21.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.20.0...v1.21.0)

Signed-off-by: dependabot[bot] <support@github.com>
2020-08-08 00:09:20 +00:00
allanaaa
a70bbf122e
Update running.md (#2982)
* starting/stopping, modifications, home screen, preferences

* Update running.md

* Languages and JVM

* Changed preferences, troubleshooting, languages

* Completing the text

Which will get revisited completely as we work through Exploring (facets/filters, e.g.) but it's a first draft.

* New images, phrases/names, link fixes
2020-08-06 14:20:35 +02:00
allanaaa
8ece41309f More typos and formatting 2020-07-28 17:13:13 -04:00
allanaaa
5eb8ecf69f Some cleanup and minor typos 2020-07-28 16:35:40 -04:00
allanaaa
a14650b12f Tweaking headers 2020-07-28 11:07:57 -04:00
allanaaa
50db04781b More database rephrasing
Minor formatting, typos, language tweaks
2020-07-28 11:07:50 -04:00
allanaaa
bb72897230 Removing images
They're not useful.
2020-07-28 11:07:49 -04:00
allanaaa
019c067706 Update starting.md 2020-07-28 11:07:49 -04:00
allanaaa
8a57b4c0ee Update starting.md 2020-07-28 11:07:49 -04:00
allanaaa
ce722b557e Update starting.md
I am not at all clear on how well GitHub for Windows will handle multiple PRs pointing to the same work directory, but let's see what happens.
2020-07-28 11:07:49 -04:00
allanaaa
476a8f7d8d Simplifying the database instructions
And, because drafting is never done, tweaks to the installation section.
2020-07-28 11:07:25 -04:00
allanaaa
cebf1380d8 Update starting.md 2020-07-28 11:07:25 -04:00
allanaaa
573744f6fe Update starting.md
I am not at all clear on how well GitHub for Windows will handle multiple PRs pointing to the same work directory, but let's see what happens.
2020-07-28 11:07:25 -04:00
allanaaa
49682f9c97 Update starting.md 2020-07-28 11:06:43 -04:00
allanaaa
3e5d75acaf More database rephrasing
Minor formatting, typos, language tweaks
2020-07-28 11:06:43 -04:00
allanaaa
e32c10be2e Removing images
They're not useful.
2020-07-28 11:06:43 -04:00
allanaaa
ec9c3bb279 Update starting.md 2020-07-28 11:06:43 -04:00
allanaaa
1a2c6ee16a Simplifying the database instructions
And, because drafting is never done, tweaks to the installation section.
2020-07-28 11:06:43 -04:00
allanaaa
40b2c4bc4d Update starting.md 2020-07-28 11:06:43 -04:00
allanaaa
80a98546eb Update starting.md
I am not at all clear on how well GitHub for Windows will handle multiple PRs pointing to the same work directory, but let's see what happens.
2020-07-28 11:06:43 -04:00
allanaaa
e8ead8dfa7
Edits to Installing page (#2908)
* Edits to Installing page

Testing a wide variety of questionable formatting options.

* Testing docusaurus tip boxes

* Testing more

* Tip boxes are ... bright, aren't they

* Formatting fixes

* Update installing.md

* Update installing.md

* Adding memory allocation section and doing some more formatting experiments

* Update installing.md

* typo!

* Update installing.md

* Update installing.md

* Testing tabs

Also I was partway through writing Linux instructions.

* Testing tabs

First commit didn't go through?

* MD to MDX test

* Update installing.mdx

* Changing back!

* Remove extra line breaks

* Update installing.md

formatting and link updates and etc

* Update installing.md

* Adding horizontal lines

* More line-break issues

* Adding images

* Whoops, forgot how images work

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
2020-07-21 17:52:00 +02:00
Thad Guidry
22d10f32d5
Minor corrections to tech docs to test editing 2020-07-16 13:33:08 -05:00
Owen Stephens
09add9fa31
Added technical reference to docusaurus based on existing wiki pages (#2940) 2020-07-16 18:39:03 +02:00
dependabot[bot]
05c0f31ef0
Bump lodash from 4.17.15 to 4.17.19 in /docs
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>
2020-07-16 09:02:29 +00:00
allanaaa
ab2ec8d28f
Adding mostly-empty docs (#2892)
Skeleton and initial content for documentation
2020-07-07 15:16:27 -04:00
Thad Guidry
2a34c8b5e6
begin Docusaurus 2 migration (#2799)
* begin Docusaurus 2 migration

* Need help fixing the broken 'index'
* needs further customizing footer if we want

* fix README.md

* fixed Pages and Sidebar not loading

Yeah!

* Revert "fixed Pages and Sidebar not loading"

This reverts commit b1588387fc89d650b391c5a8883b6100c4714fbd.

* Revert "fix README.md"

This reverts commit a81509c3c62f11370df40096e55dfd544dad2f87.

* Revert "begin Docusaurus 2 migration"

This reverts commit 59d59c355b8d2a1a270a5655922d53a0577d6414.

* clean move the files for Antonin

* fix broken Navbar links

* fix wrong GitHub link pointing to Docusaurus href

* Fix the edit link for GitHub in top right corner

* Copy content from wiki into Technical Reference

* Copy pages from wiki for top level Architecture

* fix sidebar ordering for Tech

* Add colors from our logo into Infima color matrix

* add comment about colors

* shift primary color by 1 shade in matrix
2020-06-29 08:45:24 +02:00
dependabot[bot]
4a1c1e34ef
Bump websocket-extensions from 0.1.3 to 0.1.4 in /docs (#2682)
Bumps [websocket-extensions](https://github.com/faye/websocket-extensions-node) from 0.1.3 to 0.1.4.
- [Release notes](https://github.com/faye/websocket-extensions-node/releases)
- [Changelog](https://github.com/faye/websocket-extensions-node/blob/master/CHANGELOG.md)
- [Commits](https://github.com/faye/websocket-extensions-node/compare/0.1.3...0.1.4)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-06-06 10:13:02 +01:00
Antonin Delpeuch
42afe1d5ad
Add Netlify link required for a team open source account (#2589) 2020-04-24 18:58:11 +02:00
Antonin Delpeuch
55ea09d21c
Change "reference manual" to "product reference" (#2582) 2020-04-22 23:57:27 +02:00
kushthedude
98227ea60e add comments
Signed-off-by: kushthedude <kushthedude@gmail.com>
2020-04-23 01:36:27 +05:30
kushthedude
a4e8d574c2 enh: Enabling last edited time & GitHub URL View
Signed-off-by: kushthedude <kushthedude@gmail.com>
2020-04-23 01:35:28 +05:30
Thad Guidry
f11e31c342
Adds "Edit this Doc" button for each document (#2579)
* Adds "Edit this Doc" button for each document

closes #2578

* Fix editUrl

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
2020-04-21 23:13:43 +02:00
Kush Trivedi
070d16517b
feat: Move to Yarn Package Manager (#2564)
* fix: Discrepancies in lock.json after setting up docs

* Move to yarn engine from npm

* ignore lock.json
2020-04-20 13:31:52 +02:00
Antonin Delpeuch
b361df227f
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>
2020-04-20 12:17:38 +02:00
Antonin Delpeuch
20bc0462d2
Apply suggestions from Thad's review
Co-Authored-By: Thad Guidry <thadguidry@gmail.com>
2020-04-09 15:25:19 +02:00
Antonin Delpeuch
86bf6be194 Fix typo 2020-04-09 15:16:59 +02:00
Antonin Delpeuch
3d69602003 Flesh out the documentation for the key/value columnize operation.
This is just to get some agreement on the sort of documentation content we are expecting.
Related to #1215.
2020-04-09 14:42:49 +02:00
Antonin Delpeuch
195c1cb31b Move docs/source to docs/src, disable cleanUrls 2020-04-03 18:21:47 +02:00
Antonin Delpeuch
d55f1ddc90 Initial structure for Docusaurus docs, for #2273 2020-04-03 16:22:47 +02:00