Merge branch 'dev' into bread-crumbs-refactor

Author: pettinarip

.all-contributorsrc

@@ -76,6 +76,7 @@ yarn-error.log
 src/data/contributors.json
 # These files are generated by `yarn merge-translations` command
 src/intl/*.json
+i18n/locales
 # Auto generated code when gatsby build the site
 src/gatsby-types.d.ts
 

.babelrc

@@ -52,7 +52,7 @@ Markdown will be translated as whole pages of content, so no specific action is
 
   - _tl;dr Each individual JSON entry should be a complete phrase by itself_
 
-- This is done using the `Translation` component. However there is an alternative method for regular JS: `gatsby-theme-i18n` with `/src/utils/translations.ts`
+- This is done using the `Translation` component. However there is an alternative method for regular JS: using the `t` function from `gatsby-plugin-react-i18next`
 
   - **Method one: `<Translation />` component (preferred if only needed in JSX)**
 
@@ -63,19 +63,18 @@ Markdown will be translated as whole pages of content, so no specific action is
     ;<Translation id="language-json-key" />
     ```
 
-  - **Method two: `translateMessageId()`**
+  - **Method two: `t()`**
 
     ```tsx
-    import { useIntl } from "react-intl"
-    import { translateMessageId } from "src/utils/translations"
+    import { useTranslation } from "gatsby-plugin-react-i18next"
 
     // Utilize anywhere in JS using
-    const intl = useIntl()
-    translateMessageId("language-json-key", intl)
+    const { t } = useTranslation()
+    t("language-json-key")
     ```
 
     ```tsx
-    const siteTitle = translateMessageId("site-title", intl)
+    const siteTitle = t("site-title")
     ```
 
 ## React Hooks

.gitignore

@@ -0,0 +1,53 @@
+# Deploy and review process
+
+This documentation outlines our current processes for how we deploy the latest changes to ethereum.org, and how we prioritize items in our review process.
+
+## Deploy process
+
+Anything merged into the `dev` branch of [ethereum.org](http://ethereum.org) will go live on ethereum.org at the next release. Currently, we deploy the latest changes to [ethereum.org](http://ethereum.org) twice per week (Monday and Thursday). When deploying, we merge the `dev` branch into the `master` branch. The `master` branch is the latest live version of [ethereum.org](https://ethereum.org).
+
+Occasionally, we’ll also do a patch deploy to fix an urgent or widespread issue.
+
+## Review process
+
+### General review process
+
+We use a first-in, first-out system for reviewing pull requests. The longer a pull request has been open, the higher priority it is for our team to review. In some cases—for example, fixing a high-priority issue or merging low-hanging fruit for a deploy—we will stray from this process and use our best judgement to get higher-impact changes deployed more quickly.
+
+We aim to have every new PR merged or closed within 30 days of opening. As outlined in the following sections, different types of pull requests do have different levels of priority, and this may influence how promptly a pull request is acted on.
+
+### Translations
+
+Translation pull requests are considered high priority. These are when the translated and reviewed files from our translation management platform are submitted as a pull request. They are important to our core value of bringing Ethereum education to as many languages as possible. They also are the accumulation of months of work by translators and reviewers, and any delay to this already long process is undesirable.
+
+**Timeline:** PRs should be merged within 1-4 days of opening (by the next release).
+
+### Feature and bug fixes
+
+Any new feature correlated to an approved issue or bug fix is high-priority. Similar to translators, code contributors dedicate a large amount of their time to improving [ethereum.org](http://ethereum.org) as a resource and addressing their efforts quickly is desirable. All bug fixes should be handled swiftly, but new features that were not discussed, requested or approved do not fall under this timeline.
+
+**Timeline:** Features or bug fixes should be reviewed within 1-12 days. In the case of bugs, more severe bugs will be reviewed more promptly.
+
+### Content
+
+Content PRs are considered medium-priority. Depending on their content, they can be very high-impact but also a high effort to go through the various stages of content review to ensure the content meets the standards we aim for. Content PRs can be broken into two categories: major content (e.g. a new page) and minor content changes (e.g. a new section to an existing page). Typo or grammar fixes are considered separately.
+
+**Timeline:** Major content should be merged within 15-30 days of opening. Minor content changes within 5-15 days of opening.
+
+### Typographical and grammatical errors
+
+Typographical and grammatical errors are medium-priority as small errors of this kind can have second-order ramifications for the linguists of the ~50 languages we currently translate to. Though technically a subgroup of ‘content PRs’, typos and grammar errors take significantly less time to review and, as a result, are treated differently.
+
+**Timeline:** Typo or grammar pull requests should be merged within 1-8 days of opening.
+
+### Adding products
+
+Adding new products is currently a low-to-medium priority (depending on the type of product). These pull requests often take a long time to review as we must extensively research products to ensure we not sending our users to any dubious or unsafe products.
+
+**Timeline:** PRs should be closed or merged within 30 days of opening.
+
+### Adding tutorials
+
+Adding new tutorials to [ethereum.org](http://ethereum.org) is currently low-priority. We are currently in the middle of an epic to revamp our tutorials. As part of this, we’ll be reviewing our existing tutorials, purging outdated or low-quality tutorials, and refining our listing criteria for future tutorials to meet our increased standards. Please always create an issue to discuss the usefulness of your proposed tutorial before opening a PR.
+
+**Timeline:** PRs should be closed or merged within 30 days of opening.

README.md

@@ -9,6 +9,7 @@
   - [Gatsby Docs](https://www.gatsbyjs.org/docs/)
 - [React](https://reactjs.org/) - A JavaScript library for building component-based user interfaces
 - [Typescript](https://www.typescriptlang.org/) - TypeScript is a strongly typed programming language that builds on JavaScript
+- [Chakra UI](https://chakra-ui.com/) - A UI library (Migration in progress)
 - [GraphQL](https://graphql.org/) - A query language for APIs
 - [Algolia](https://www.algolia.com/) - Site indexing, rapid intra-site search results, and search analytics. [Learn more on how we implement Algolia for site search](./docs/ALGOLIA_DOCSEARCH.md).
   - Primary implementation: `/src/components/Search/index.ts`

docs/best-practices.md

@@ -4,10 +4,6 @@
  * See: https://www.gatsbyjs.org/docs/browser-apis/
  */
 
-import React from "react"
-import browserLang from "browser-lang"
-import { withPrefix, GatsbyBrowser } from "gatsby"
-
 import Prism from "prism-react-renderer/prism"
 ;(typeof global !== "undefined" ? global : window).Prism = Prism
 
@@ -16,53 +12,6 @@ import "@formatjs/intl-locale/polyfill"
 import "@formatjs/intl-numberformat/polyfill"
 import "@formatjs/intl-numberformat/locale-data/en"
 
-import Layout from "./src/components/Layout"
-import {
-  supportedLanguages,
-  defaultLanguage,
-  isLang,
-} from "./src/utils/languages"
-import { IS_DEV } from "./src/utils/env"
-import { Context } from "./src/types"
-
 // Default languages included:
 // https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/vendor/prism/includeLangs.js
 require("prismjs/components/prism-solidity")
-
-// Prevents <Layout/> from unmounting on page transitions
-// https://www.gatsbyjs.com/docs/layout-components/#how-to-prevent-layout-components-from-unmounting
-export const wrapPageElement: GatsbyBrowser<
-  any,
-  Context
->["wrapPageElement"] = ({ element, props }) => {
-  const { location, pageContext } = props
-  const { pathname, search } = location
-  const { originalPath } = pageContext
-
-  const [, pathLocale] = pathname.split("/")
-
-  // client side redirect on paths that don't have a locale in them. Most useful
-  // on dev env where we don't have server redirects
-  if (IS_DEV && !isLang(pathLocale)) {
-    let detected =
-      window.localStorage.getItem("eth-org-language") ||
-      browserLang({
-        languages: supportedLanguages,
-        fallback: defaultLanguage,
-      })
-
-    if (!isLang(detected)) {
-      detected = defaultLanguage
-    }
-
-    const queryParams = search || ""
-    const newUrl = withPrefix(`/${detected}${originalPath}${queryParams}`)
-    window.localStorage.setItem("eth-org-language", detected)
-    window.location.replace(newUrl)
-
-    // can't return null here, must return an element
-    return <div />
-  }
-
-  return <Layout {...props}>{element}</Layout>
-}

docs/deploy-and-review-process.md

@@ -35,24 +35,6 @@ const config: GatsbyConfig = {
     editContentUrl: `https://github.com/ethereum/ethereum-org-website/tree/dev/`,
   },
   plugins: [
-    // i18n support
-    {
-      resolve: `gatsby-theme-i18n`,
-      options: {
-        defaultLang: defaultLanguage,
-        prefixDefault: true,
-        locales: supportedLanguages.length
-          ? supportedLanguages.join(" ")
-          : null,
-        configPath: path.resolve(`./i18n/config.json`),
-      },
-    },
-    {
-      resolve: `gatsby-theme-i18n-react-intl`,
-      options: {
-        defaultLocale: `./src/intl/en.json`,
-      },
-    },
     // Web app manifest
     {
       resolve: `gatsby-plugin-manifest`,
@@ -265,6 +247,56 @@ const config: GatsbyConfig = {
         generateMatchPathRewrites: false,
       },
     },
+    // i18n support
+    {
+      resolve: `gatsby-source-filesystem`,
+      options: {
+        path: path.resolve(`./i18n/locales`),
+        name: `locale`,
+      },
+    },
+    // Wraps the entire page with a custom layout component
+    // Note: keep this before the i18n plugin declaration in order to have the
+    // i18n provider wrapping the layout component
+    {
+      resolve: `gatsby-plugin-layout`,
+      options: {
+        component: path.resolve(`./src/components/Layout`),
+      },
+    },
+    {
+      resolve: `gatsby-plugin-react-i18next`,
+      options: {
+        localeJsonSourceName: `locale`, // name given to `gatsby-source-filesystem` plugin.
+        languages: supportedLanguages,
+        defaultLanguage: defaultLanguage,
+        generateDefaultLanguagePage: true,
+        redirect: false,
+        siteUrl,
+        trailingSlash: "always",
+        // i18next options
+        i18nextOptions: {
+          fallbackLng: defaultLanguage,
+          interpolation: {
+            escapeValue: false,
+          },
+          react: {
+            transSupportBasicHtmlNodes: true,
+            transKeepBasicHtmlNodesFor: [
+              "br",
+              "strong",
+              "i",
+              "bold",
+              "b",
+              "em",
+              "sup",
+            ],
+          },
+          keySeparator: false,
+          nsSeparator: false,
+        },
+      },
+    },
   ],
   // https://www.gatsbyjs.com/docs/reference/release-notes/v2.28/#feature-flags-in-gatsby-configjs
   flags: {