Initial structure for Docusaurus docs, for #2273

docs/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+
+node_modules
+
+lib/core/metadata.js
+lib/core/MetadataBlog.js
+
+translated_docs
+build/
+yarn.lock
+i18n/*

docs/core/Footer.js

@@ -0,0 +1,107 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const React = require('react');
+
+class Footer extends React.Component {
+  docUrl(doc, language) {
+    const baseUrl = this.props.config.baseUrl;
+    const docsUrl = this.props.config.docsUrl;
+    const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`;
+    const langPart = `${language ? `${language}/` : ''}`;
+    return `${baseUrl}${docsPart}${langPart}${doc}`;
+  }
+
+  pageUrl(doc, language) {
+    const baseUrl = this.props.config.baseUrl;
+    return baseUrl + (language ? `${language}/` : '') + doc;
+  }
+
+  render() {
+    return (
+      <footer className="nav-footer" id="footer">
+        <section className="sitemap">
+          <a href={this.props.config.baseUrl} className="nav-home">
+            {this.props.config.footerIcon && (
+              <img
+                src={this.props.config.baseUrl + this.props.config.footerIcon}
+                alt={this.props.config.title}
+                width="66"
+                height="58"
+              />
+            )}
+          </a>
+          <div>
+            <h5>Docs</h5>
+            <a href={this.docUrl('install.html', this.props.language)}>
+              Install OpenRefine
+            </a>
+            <a href="http://openrefine.org/documentation.html">
+              External Resources
+            </a>
+          </div>
+          <div>
+            <h5>Community</h5>
+            <a
+              href="https://stackoverflow.com/questions/tagged/openrefine/"
+              target="_blank"
+              rel="noreferrer noopener">
+              Stack Overflow
+            </a>
+            <a
+              href="https://twitter.com/OpenRefine"
+              target="_blank"
+              rel="noreferrer noopener">
+              Twitter
+            </a>
+          </div>
+          <div>
+            <h5>More</h5>
+            <a href="https://openrefine.org/category/blog.html">Blog</a>
+            <a href="https://github.com/OpenRefine/OpenRefine">GitHub</a>
+            <a
+              className="github-button"
+              href={this.props.config.repoUrl}
+              data-icon="octicon-star"
+              data-count-href="/OpenRefine/OpenRefine/stargazers"
+              data-show-count="true"
+              data-count-aria-label="# stargazers on GitHub"
+              aria-label="Star this project on GitHub">
+              Star
+            </a>
+            {this.props.config.twitterUsername && (
+              <div className="social">
+                <a
+                  href={`https://twitter.com/${this.props.config.twitterUsername}`}
+                  className="twitter-follow-button">
+                  Follow @{this.props.config.twitterUsername}
+                </a>
+              </div>
+            )}
+            {this.props.config.facebookAppId && (
+              <div className="social">
+                <div
+                  className="fb-like"
+                  data-href={this.props.config.url}
+                  data-colorscheme="dark"
+                  data-layout="standard"
+                  data-share="true"
+                  data-width="225"
+                  data-show-faces="false"
+                />
+              </div>
+            )}
+          </div>
+        </section>
+
+        <section className="copyright">{this.props.config.copyright}</section>
+      </footer>
+    );
+  }
+}
+
+module.exports = Footer;

docs/package.json

@@ -0,0 +1,14 @@
+{
+  "scripts": {
+    "examples": "docusaurus-examples",
+    "start": "docusaurus-start",
+    "build": "docusaurus-build",
+    "publish-gh-pages": "docusaurus-publish",
+    "write-translations": "docusaurus-write-translations",
+    "version": "docusaurus-version",
+    "rename-version": "docusaurus-rename-version"
+  },
+  "devDependencies": {
+    "docusaurus": "^1.14.4"
+  }
+}

docs/sidebars.json

@@ -0,0 +1,34 @@
+{
+  "docs": {
+    "Getting Started": [
+      "index",
+      "install",
+      "user_data"
+    ],
+    "Importing Data": [
+       "importers/csv",
+       "importers/json",
+       "importers/xml"
+    ],
+    "Operations": [
+        "operations/transform",
+        "operations/add_column",
+        "operations/recon"
+    ],
+    "Facets": [
+        "facets/text",
+        "facets/numeric",
+        "facets/scatterplot"
+    ],
+    "Exporters": [
+        "exporters/csv",
+        "exporters/gsheets",
+        "exporters/ods"
+    ],
+    "GREL": [
+        "grel/cross",
+        "grel/facetCount",
+        "grel/toString"
+    ]
+  }
+}

docs/siteConfig.js

@@ -0,0 +1,81 @@
+// Documentation for these options can be found at:
+// https://docusaurus.io/docs/en/site-config
+
+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/',
+
+  projectName: 'OpenRefine',
+  organizationName: 'OpenRefine',
+
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'index', label: 'Home'},
+  ],
+
+  users: [],
+  customDocsPath: 'docs/source',
+  docsUrl: '',
+
+  /* path to images for header/footer */
+  headerIcon: 'img/openrefine_logo.png',
+  footerIcon: 'img/openrefine_logo.png',
+  favicon: 'img/openrefine_logo.png',
+
+  /* Colors for website */
+  colors: {
+    primaryColor: '#196581',
+    secondaryColor: '#5a4411',
+  },
+
+  /* Custom fonts for website */
+  /*
+  fonts: {
+    myFont: [
+      "Times New Roman",
+      "Serif"
+    ],
+    myOtherFont: [
+      "-apple-system",
+      "system-ui"
+    ]
+  },
+  */
+
+  copyright: `Copyright © ${new Date().getFullYear()} OpenRefine contributors`,
+
+  highlight: {
+    // Highlight.js theme to use for syntax highlighting in code blocks.
+    theme: 'default',
+  },
+
+  // Add custom scripts here that would be placed in <script> tags.
+  scripts: ['https://buttons.github.io/buttons.js'],
+
+  // On page navigation for the current documentation page.
+  onPageNav: 'separate',
+  // No .html extensions for paths.
+  cleanUrl: true,
+
+  // Open Graph and Twitter card images.
+  ogImage: 'img/openrefine_logo.png',
+  twitterImage: 'img/openrefine_logo.png',
+
+  // Expand/collapse the links and subcategories under categories.
+  docsSideNavCollapsible: true,
+
+  // Show documentation's last contributor's name.
+  // enableUpdateBy: true,
+
+  // Show documentation's last update time.
+  // enableUpdateTime: true,
+
+  // You may provide arbitrary config keys to be used as needed by your
+  // template. For example, if you need your repo's URL...
+  repoUrl: 'https://github.com/OpenRefine/OpenRefine',
+  twitterUsername: 'OpenRefine'
+};
+
+module.exports = siteConfig;

docs/source/exporters/csv.md

@@ -0,0 +1,7 @@
+---
+id: csv
+title: Exporting to CSV/TSV
+sidebar_label: CSV/TSV
+---
+
+

docs/source/exporters/gsheets.md

@@ -0,0 +1,6 @@
+---
+id: gsheets
+title: Exporting to Google Sheets
+sidebar_label: Google Sheets
+---
+

docs/source/exporters/ods.md

@@ -0,0 +1,6 @@
+---
+id: ods
+title: Exporting to ODS
+sidebar_label: ODS
+---
+

docs/source/facets/numeric.md

@@ -0,0 +1,7 @@
+---
+id: numeric
+title: Numeric Facets
+sidebar_label: Numeric
+---
+
+Numeric facets lets you inspect the distribution of numeric values in a column.

docs/source/facets/scatterplot.md

@@ -0,0 +1,7 @@
+---
+id: scatterplot
+title: Scatterplot Facets
+sidebar_label: Scatterplot
+---
+
+

docs/source/facets/text.md

@@ -0,0 +1,7 @@
+---
+id: text
+title: Text Facets
+sidebar_label: Text
+---
+
+Text facets list the different values found in a column, with their occurence counts.

docs/source/grel/cross.md

@@ -0,0 +1,6 @@
+---
+id: cross
+title: The cross function
+sidebar_label: cross
+---
+

docs/source/grel/facetCount.md

@@ -0,0 +1,6 @@
+---
+id: facetCount
+title: The facetCount function
+sidebar_label: facetCount
+---
+

docs/source/grel/toString.md

@@ -0,0 +1,6 @@
+---
+id: toString
+title: The toString function
+sidebar_label: toString
+---
+

docs/source/importers/csv.md

@@ -0,0 +1,7 @@
+---
+id: csv
+title: Importing CSV/TSV files
+sidebar_label: CSV/TSV
+---
+
+Comma-Separated Values (CSV) and Tab-Separated Values (TSV) are widespread formats to represent tables.

docs/source/importers/json.md

@@ -0,0 +1,7 @@
+---
+id: json
+title: Importing JSON files
+sidebar_label: JSON
+---
+
+JSON (JavaScript Object Notation) is a hierarchical data format commonly used on the Web.

docs/source/importers/xml.md

@@ -0,0 +1,7 @@
+---
+id: xml
+title: Importing XML files
+sidebar_label: XML
+---
+
+

docs/source/index.md

@@ -0,0 +1,9 @@
+---
+id: index
+title: OpenRefine reference manual
+sidebar_label: Index
+---
+
+This site is just a prototype to propose a basic publishing infrastructure for OpenRefine's new reference manual.
+
+The structure on the left hand side is just a placeholder, as are the contents of all pages.

docs/source/install.md

@@ -0,0 +1,17 @@
+---
+id: install
+title: Installing OpenRefine
+sidebar_label: Installing
+---
+
+OpenRefine is available for Windows, Mac OS and Linux. The install process depends on the platform.
+
+# Windows
+
+# Mac OS
+
+# Linux
+
+# Using Docker
+
+

docs/source/operations/add_column.md

@@ -0,0 +1,7 @@
+---
+id: add_column
+title: Add Column Based on This Column
+sidebar_label: Add Column
+---
+
+This operation lets you create a new column, whose values are computed using GREL or another expression language.

docs/source/operations/recon.md

@@ -0,0 +1,7 @@
+---
+id: recon
+title: Reconcile
+sidebar_label: Reconcile
+---
+
+Reconciliation is the process of matching names to unique identifiers in third-party databases.

docs/source/operations/transform.md

@@ -0,0 +1,7 @@
+---
+id: transform
+title: Transforming Columns
+sidebar_label: Transform
+---
+
+Transforming a column lets you derive new column values using expressions in GREL or other languages.

docs/source/user_data.md

@@ -0,0 +1,17 @@
+---
+id: user_data
+title: Backing Up Workspace Data
+sidebar_label: Workspace Data
+---
+
+OpenRefine stores its workspace locally. The exact location depends on the operating system.
+
+# Windows
+
+# Mac OS
+
+# Linux
+
+# Using Docker
+
+

docs/static/css/custom.css

@@ -0,0 +1,2 @@
+/* custom CSS can be added here */
+