Merge pull request #1248 from ethereum/contributing

Contributing reorg [Fixes #1103 + #1247]

Author: samajammin

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Ethereum.org contributors
+Copyright (c) 2019 ethereum.org contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -9,130 +9,25 @@
   <p>👋 Welcome to ethereum.org!</p>
 </h1>
 
-[Ethereum.org](https://ethereum.org) is a primary online resource for the Ethereum community. The purpose of the site is to _“Be the best portal to Ethereum for our growing global community"_ - read more about what this means [here](https://github.com/ethereum/ethereum-org-website/blob/dev/purpose.md).
+[ethereum.org](https://ethereum.org) is a primary online resource for the Ethereum community. The purpose of the site is to _“Be the best portal to Ethereum for our growing global community"_ - read more about what this means [here](https://ethereum.org/en/about/).
 
-[Ethereum.org](https://ethereum.org) is improved and changed over time through the contributions of community members who submit content, give feedback, or volunteer their time to managing its evolution. If you’re interested in helping to improve [ethereum.org](https://ethereum.org), start here. This contribution guide will help you get started.
+[ethereum.org](https://ethereum.org) is improved and changed over time through the contributions of community members who submit content, give feedback, or volunteer their time to managing its evolution. If you’re interested in helping to improve [ethereum.org](https://ethereum.org), find out [how to contribute](https://ethereum.org/en/contributing/).
 
-<br/>
+## The contribution process
 
-## Core Principles
-
-Ethereum.org’s design and content is guided by three core principles:
-
-**🌏 1. Ethereum.org is a portal to resources created by the community**
-
-- It will never be “encyclopedia ethereum” - we can’t add every link, or cover every topic
-- Rather, its purpose is to direct people to community-built resources
-- Ethereum.org trends toward minimal native-content
-
-**🛠 2. Ethereum.org is a work in progress, because Ethereum is a work in progress**
-
-- It will change over time, as Ethereum evolves and the community evolves with it
-- To accommodate long-term changes, the site has a simple design system & modular structure
-- Changes to the site are iterative, as we learn more about how people use it and what the community wants from it
-- Changes can be proposed by anyone, and we aim to cultivate a community of open-source contributors
-
-**🦄 3. Ethereum.org is not a typical product website**
-
-- Ethereum is multifaceted. It's a project, a platform, a product, a vision of the future, a set of ideologies, a community, and much more.
-- The site won't look like every other product site, because Ethereum isn't like every other product.
-
-## How can I contribute?
-
-Keeping in mind the above core principles, there are many ways you can get involved in improving the website!
-
-- Check out our [open issues](https://github.com/ethereum/ethereum-org-website/issues) and see if there are any you can help with
-- Join our [Translation Program](https://ethereum.org/en/languages/#ethereum-org-translation-program)
-- Add information or links to specific sections that are incomplete, by submitting a pull request
-- Identify out-of-date information on ethereum.org (or linked to from ethereum.org) and submit a pull request
-- Submit new designs for the front-page HERO image - contact us at website@ethereum.org
-- Suggest improvements to our [user persona research](https://www.notion.so/efdn/Ethereum-org-User-Persona-Memo-b44dc1e89152457a87ba872b0dfa366c)
-- Suggest ideas for new pages, new content, or other ways to improve ethereum.org by [opening an issue](https://github.com/ethereum/ethereum-org-website/issues/new/choose)
-- Follow progress and collaborate with our team on new features with us in our [Discord server](https://discord.gg/CetY6Y4)
-
-Learn how to submit a pull request in the [Development Lifecycle](#deployment-lifecycle) section.
-
-### Content contributions
-
-As mentioned in [ethereum.org's core principles](#core-principles), the goal is for ethereum.org to serve as a portal to resources created by the community. We strive to direct people to community-built resources vs. replace them. While we trend towards minimal native-content, we have received feedback from the community that it's valuable for us to have some.
-
-When proposing a new page or updating an existing page, keep in mind the goal is not to be a comprehensive encyclopedia of Ethereum but rather to be a stepping stone for someone’s journey into Ethereum. Each page should provide a story: e.g. introducing a topic, answering a question & providing next steps for the visitor to learm more or take a particular action.
-
-#### Notes on specific kinds of contributions
-
-When proposing new items to Ethereum.org we ask contributors to add their new addition(s) to the bottom of each section/list. This helps keep things fair for all contributors. In the future, we may consider adding a ranking system for the sections but for now this is the practice we are employing.
-
-#### I want to add a developer tool or project
-
-Developer tool submissions will be assessed by the following criteria:
-
-- Is it meaningfully differentiated from tools already listed?
-  - New categories or types of tools
-  - New features compared to existing similar tools
-  - Targeted at a distinct use-case not covered by existing similar tools
-- Is the tool well documented?
-  - Does documentation exist?
-  - Is it sufficient to use the tool?
-  - Has it been recently updated?
-- Is the tool widely used?
-  - We will consider metrics such as GitHub stars, download statistics, and whether it is used by known companies or projects
-- Is the tool of sufficient quality?
-  - Are there recurring bugs?
-  - Is the tool reliable?
-
-#### I want to add an educational article or resource
-
-Learning resources will be assessed by the following criteria:
-
-- Is the content up to date?
-- Is the information accurate? Is it factual or opinion-based?
-- Is the author credible? Do they reference their sources?
-- Does this content add distinct value that existing resources/links don't cover?
-- Which [user persona](https://www.notion.so/efdn/Ethereum-org-User-Persona-Memo-b44dc1e89152457a87ba872b0dfa366c) does this content serve?
-
-#### I want to add an Ethereum-based application
-
-Dapp submissions will be assessed on the following criteria:
-
-- Is the dapp a "user" application? This page is targeted at a new user, which means it wouldn't be appropriate to list a dev tool or app targeted at sophisticated technical users.
-- Does the application have a good user on-boarding process, such that a user can follow the link, and find all the instructions they need to get started?
-- Does the application "round out" the list by adding a new kind of application not already present?
-- Is there evidence that the application is popular and well established?
-
-[Read the full policy](https://ethereum.org/en/contributing/adding-products/).
-
-### Translation Program
-
-Ethereum is a global project, and we believe it's critical that Ethereum.org is accessible to everyone, regardless of their nationality or language. Our community has been working hard to make this vision a reality.
-
-**Looking for a specific translation?**
-
-We're constantly working to add additional language support & to keep our existing translations up to date. You can [view available translations and the progress of all our translations here](https://ethereum.org/languages/).
-
-**Looking to join our community of translators?**
+How updates are made to ethereum.org
 
-Great! We'd love to get you involved. [Follow the instructions here](https://ethereum.org/en/languages/#ethereum-org-translation-program) and join our [Discord server](https://discord.gg/CetY6Y4) to collaborate with other community memebers in the #translations channel. Thank you in advance for your participation!
+### Submit an issue
 
-## 🤔 How are decisions about the site made?
+- Create a [new issue](https://github.com/ethereum/ethereum-org-website/issues/new/choose)
 
-Decisions about individual PRs, design evolution, and major upgrades to the website are made by a team of people from across the Ethereum ecosystem. This team includes project managers, developers, designers, marketing and communications, and subject matter experts. Community input informs every decision: raising questions in issues, submitting PRs, or contacting the team at website@ethereum.org is helpful!
+### Fork the repo
 
-This team currently includes:
+If you're not sure, here's how to [fork the repo](https://help.github.com/en/articles/fork-a-repo)
 
-- Anuj Gupta (Ethereum Foundation)
-- Amanda Gutterman (ConsenSys)
-- Hudson Jameson (Ethereum Foundation Devops)
-- Taeyeon Kim (Ethereum Foundation)
-- Jamie Pitts (Ethereum Foundation Devops)
-- Sam Richards (Ethereum Foundation)
-- Joseph Schweitzer (Ethereum Foundation)
-- Josh Stark (L4, ETHGlobal, Ethereum Foundation)
-- Charles St. Louis (MakerDAO & Ethereum Cat Herders)
-- Evan Van Ness (ConsenSys & Ethereum Foundation)
-- Alan Woo (Independent designer & developer)
-- Ryan Cordell (Ethereum Foundation)
+### Set up your local environment (optional)
 
-## Local development
+If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.
 
 1. [Set up your development environment](https://www.gatsbyjs.org/tutorial/part-zero/)
 
@@ -156,41 +51,36 @@ $ yarn
 yarn start
 ```
 
-### Learning Gatsby
-
-Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
-
-- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
-
-- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
+### Submit your PR
 
-## Deployment Lifecycle
-
-How updates are made to ethereum.org
-
-### Submit
-
-- Create a [new issue](https://github.com/ethereum/ethereum-org-website/issues/new/choose)
-- Submit a pull request (PR) to the `dev` branch (you'll need to [fork the repo](https://help.github.com/en/articles/fork-a-repo) in order to submit a PR)
-  - In your PR commit message, reference the issue it resolves
-    - e.g. `Add height to sidebar for scroll [Fixes #185]`
-    - Read [Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords) for more information
+- Make your changes and submit a pull request (PR) to the `dev` branch
+- In your PR commit message, reference the issue it resolves
+  - e.g. `Add height to sidebar for scroll [Fixes #185]`
+  - Read [Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords) for more information
 - Netlify (our hosting service) deploys all PRs to a publicly accessible preview URL, e.g.:
   ![Netlify deploy preview](./netlify-deploy-preview.png)
 - Confirm your Netlify preview deploy looks & functions as expected
 
-### Review
+### Wait for review
 
-- The [website team](https://github.com/ethereum/ethereum-org-website#-how-are-decisions-about-the-site-made) reviews every PR
-- See [how decisions are made on content changes](https://github.com/ethereum/ethereum-org-website#notes-on-individual-sub-pages)
+- The website team reviews every PR
+- See [how decisions are made on content changes](https://ethereum.org/en/contributing/#how-decisions-about-the-site-are-made)
 - Acceptable PRs will be approved & merged into the `dev` branch
 
 ### Release
 
-- `master` is continually synced to Netlify and will automatically deploy new commits to etheruem.org
-- The [website team](https://github.com/ethereum/ethereum-org-website#-how-are-decisions-about-the-site-made) will periodically merge `dev` into `master` (typically multiple times per week)
+- `master` is continually synced to Netlify and will automatically deploy new commits to ethereum.org
+- The [website team](https://ethereum.org/en/contributing/#how-decisions-about-the-site-are-made) will periodically merge `dev` into `master` (typically multiple times per week)
 - You can [view the history of releases](https://github.com/ethereum/ethereum-org-website/releases), which include PR highlights
 
+## Learn about Gatsby
+
+Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
+
+- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
+
+- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
+
 ## Contributors
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

gatsby-config.js

@@ -8,7 +8,7 @@ const defaultLanguage = `en`
 module.exports = {
   siteMetadata: {
     // `title` & `description` pulls from respective ${lang}.json files in PageMetadata.js
-    title: `Ethereum.org`,
+    title: `ethereum.org`,
     description: `Ethereum is a global, decentralized platform for money and new kinds of applications. On Ethereum, you can write code that controls money, and build applications accessible anywhere in the world.`,
     url: "https://ethereum.org",
     siteUrl: "https://ethereum.org",
@@ -38,8 +38,8 @@ module.exports = {
     {
       resolve: `gatsby-plugin-manifest`,
       options: {
-        name: `Ethereum.org`,
-        short_name: `Ethereum.org`,
+        name: `ethereum.org`,
+        short_name: `ethereum.org`,
         start_url: `/en/`,
         background_color: `#fff`,
         theme_color: `#1c1ce1`,

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ethereum-org-website",
   "version": "2.2.0",
-  "description": "Website of Ethereum.org",
+  "description": "Website of ethereum.org",
   "main": "index.js",
   "repository": "git@github.com:ethereum/ethereum-org-website.git",
   "author": "Sam Richards <sam.richards@ethereum.org>",
@@ -53,9 +53,10 @@
     "pretty-quick": "^2.0.1"
   },
   "scripts": {
-    "build": "yarn build:app && yarn build:lambda",
+    "build": "yarn copy-contributors && yarn build:app && yarn build:lambda",
     "build:app": "gatsby build",
     "build:lambda": "netlify-lambda build src/lambda",
+    "copy-contributors": "node src/scripts/copyContributors.js",
     "format": "prettier --write \"**/*.{js,jsx,json,md}\"",
     "generate-heading-ids": "node src/scripts/generateHeadingIDs.js",
     "start": "gatsby develop",

purpose.md

@@ -57,10 +57,14 @@ const ActionCard = ({
   children,
   className,
 }) => {
+  const isImageURL = typeof image === "string" && image.includes("http")
   return (
     <Card to={to} className={className} hideArrow={true}>
       <ImageWrapper className="action-card-image-wrapper">
-        <Image fixed={image} alt={alt} />
+        {!isImageURL && <Image fixed={image} alt={alt} />}
+        {isImageURL && (
+          <img src={image} alt={alt} className="action-card-image" />
+        )}
       </ImageWrapper>
       <Content className="action-card-content">
         <h3>{title}</h3>

src/components/ActionCard.js

@@ -0,0 +1,51 @@
+import React from "react"
+import styled from "styled-components"
+
+import ActionCard from "./ActionCard"
+import data from "../data/contributors.json"
+
+const Container = styled.div`
+  display: flex;
+  flex-wrap: wrap;
+`
+
+const ContributorCard = styled(ActionCard)`
+  max-width: 132px;
+  margin: 0.5rem;
+
+  .action-card-image-wrapper {
+    min-height: 100px;
+  }
+  .action-card-image {
+    width: 132px;
+    height: 132px;
+  }
+  .action-card-content {
+    padding: 1rem;
+    h3 {
+      font-size: ${(props) => props.theme.fontSizes.m};
+    }
+    p {
+      margin-bottom: 0;
+    }
+  }
+`
+
+const Contributors = () => {
+  return (
+    <Container>
+      {data.contributors.map((contributor, idx) => {
+        return (
+          <ContributorCard
+            key={idx}
+            image={contributor.avatar_url}
+            to={contributor.profile}
+            title={contributor.name}
+          />
+        )
+      })}
+    </Container>
+  )
+}
+
+export default Contributors

src/components/Contributors.js

@@ -222,6 +222,11 @@ const Footer = () => {
           text: "footer-about-us",
           shouldDisplay: true,
         },
+        {
+          to: "/en/contributing/",
+          text: "Contributing",
+          shouldDisplay: contentVersion > 1.1,
+        },
         {
           to: "/en/languages/",
           text: "language-support",