docs: add website (#153)

* Initial commit * Update README.md * first commit * docs: add ci badge * docs: add license * infra: use nvm locally * ci: correct deploy key * docs: all contributors * docs: badge space * ci: fix cache key * docs: contributing * ci: fix working dir * ci: website build path * docs: arrange badges * docs: all contributors specification * docs: badge not flat square * docs: switch to all-contributors org (#1) * docs: update all-contributors link * docs: switch org * docs: chat on slack * docs: use google analytics * feat: add branding (#3) * docs: update all-contributors link * feat: add branding * docs: add tbenning as a contributor (#4) * docs: update README.md * docs: update .all-contributorsrc * docs: say hello to @all-contributors bot * docs: links & grammar * docs: sync with master repo (drops atom plugin recommendation) * docs: add Greenkeeper badge 🌴 (#5) * docs(readme): add Greenkeeper badge * Update README.md * docs(overview): added new maintenance category (#6) This goes hand in hand with [all-contributors-cli#142](all-contributors/cli#142). * docs: document bot and cli tools (#8) * docs: update all-contributors link * docs: wip * docs: tweaks * new homepage * docs: wip * docs: first pass * docs: tweaks * docs: fix some grammar (#13) * docs: grammar tweaks * docs: use github star button * docs: the problem section for CLI * docs: cli docs * docs: wording on motivation * docs: description wrong * docs: enable search * docs: update contributing with search * chore: added commitizen (#9) * chore(package): added commitizen * docs(readme): added the cz badge * chore(yarn): updated yarn.lock * chore: removed all-contributors-cli * feat: add translations (#14) * translation: first pass * translation: first pass * brew * docs: add translations * infra: write translations in ci * infra: drop ci for branches * valid * docs: add Jongjineee as a contributor (#18) * docs: update README.md * docs: update .all-contributorsrc * docs: add robertlluberes as a contributor (#19) * docs: update README.md * docs: update .all-contributorsrc * docs(emoji-key): added missing `business` and `content` (#20) * docs(emoji-key): added missing `business` and `content` I added the missing types and removed the uneeded `npx` call in the `commit` NPM script. * docs(emoji-key): removed 'N/I' line * docs: switch to Portuguese, Brazilian * docs: switch to Portuguese, Brazilian * docs: enable chinese simplified zh-CN * docs: enable chinese simplified zh-CN * docs: add Berkmann18 as a contributor (#21) * docs: update README.md * docs: update .all-contributorsrc * docs: update README.md * docs: update .all-contributorsrc * docs: add MarsXue as a contributor (#22) * docs: update README.md * docs: update .all-contributorsrc * docs: update README.md * docs: update .all-contributorsrc * docs: add MatheusRC as a contributor (#25) * docs: update README.md * docs: update .all-contributorsrc * Revert "docs: add MatheusRC as a contributor (#25)" (#26) This reverts commit b20eae0cec2e4333089886e66ab4877c2cd05366. * docs: add MatheusRV as a contributor (#27) * docs: update README.md * docs: update .all-contributorsrc * docs: update README.md * docs: update .all-contributorsrc * doc: doc fix (#24) * docs(emoji-key): added missing `business` and `content` I added the missing types and removed the uneeded `npx` call in the `commit` NPM script. * docs: improvements and fixes Made some bits more comprehensible and fixed some typos * infra: fix ci * feat: support translations, drop example files * docs(cli-usage): use inline code to specify the command "generate" (#28) * docs: add MarsXue as a contributor (#29) * docs: update README.md * docs: update .all-contributorsrc * docs: add Berkmann18 as a contributor (#31) * docs: update README.md * docs: update .all-contributorsrc * docs: add greenkeeper as a contributor (#32) * docs: update README.md * docs: update .all-contributorsrc * docs: add allcontributors as a contributor (#33) * docs: update README.md * docs: update .all-contributorsrc * docs: add root pages for languages * docs: remove greenkeeper (#36) * docs: add Greenkeeper[bot] as a contributor (#37) * docs: update README.md * docs: update .all-contributorsrc * feat: new homepage (#15) * Added HTML structure for the Index page. * added base styles, css variables, and a grid. Modified some of the HTML. * changed a few css rules * added normalize, continued styling * added image files, continued styling, modified some of the copy for how to * fixed the wavey background css * started adding media queries fixing styling issues * More css tweaks and adjustments * couple more styling tweaks, making it responsive * fixed some flexbox issues. made it more responsive * feat: add github badge button * styled the added the github stars widget to live in the nav and float in mobile * added the icons and styled them for the quick links * added logos and some styling, might need a last pass on the styles * changed some copy on buttons, made links open in new tab * fixing last responsive details on user logos * wip * feat: missing files + open graph data * fix: switch styles over to main.css * fix: site name * fixed the issues that the docs css was creating, should be good to go on mobile responsiveness (#43) docs :fixing CSS * feat: add 404 page (#44) * fixed the issues that the docs css was creating, should be good to go on mobile responsiveness * created a 404 page * added in / for 404 page * docs: fix link in 404 page (#45) * docs: add maryampaz as a contributor (#46) * docs: update README.md * docs: update .all-contributorsrc * feat: add analytics tracking to root pages, and 404s (#47) * docs: hawaii banner for conference (#50) * feat: link to jsconfhi * infra: add 404 check for CI (#52) * infra: add 404 check for CI * ci * background * sleep less * check 404s only after release * infra: smart sleep * infra: smart sleep * formik 404 * docs: locallized badge * docs: switch badge around * docs: link to build workflow * docs: few fixes and tweaks (#54) * aloha, remove use of h1 * docs: move over docs, style footer * docs: typo fixes (#53) * docs(emoji-key): added missing `business` and `content` I added the missing types and removed the uneeded `npx` call in the `commit` NPM script. * docs: improvements and fixes Made some bits more comprehensible and fixed some typos * docs(repository-maintainers): fixed minor typo * docs(bot): fixed a typo Fixed the typo in the _overview_ page to the _usage_ one * docs: fix readme * website uses allcontributrs.org * build * lock file and checkout
5admi2t5m · Feb 4, 2019 · ff017c2 · ff017c2
1 parent 8ba9380
commit ff017c2
Show file tree

Hide file tree

Showing 99 changed files with 7,185 additions and 597 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -1,15 +1,10 @@
 {
   "projectName": "all-contributors",
-  "projectOwner": "kentcdodds",
+  "projectOwner": "all-contributors",
   "files": [
-    "README.md",
-    "docs/es-ES/README.md",
-    "docs/fr-FR/README.md",
-    "docs/ko-KR/README.md",
-    "docs/pt-BR/README.md"
+    "README.md"
   ],
   "imageSize": 100,
-  "commit": false,
   "contributors": [
     {
       "login": "kentcdodds",
@@ -23,6 +18,79 @@
         "talk"
       ]
     },
+    {
+      "login": "jfmengels",
+      "name": "Jeroen Engels",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3869412?v=3",
+      "profile": "https://github.com/jfmengels",
+      "contributions": [
+        "doc",
+        "review",
+        "tool"
+      ]
+    },
+    {
+      "login": "jakebolam",
+      "name": "Jake Bolam",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/3534236?v=4",
+      "profile": "https://jakebolam.com",
+      "contributions": [
+        "doc",
+        "tool",
+        "infra",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "tbenning",
+      "name": "tbenning",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/7265547?v=4",
+      "profile": "https://github.com/tbenning",
+      "contributions": [
+        "design",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "sinchang",
+      "name": "Jeff Wen",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/3297859?v=4",
+      "profile": "https://sinchang.me",
+      "contributions": [
+        "maintenance"
+      ]
+    },
+    {
+      "login": "Berkmann18",
+      "name": "Maximilian Berkmann",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/8260834?v=4",
+      "profile": "http://maxcubing.wordpress.com",
+      "contributions": [
+        "translation",
+        "doc",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "MatheusRV",
+      "name": "Matheus Rocha Vieira",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/23284276?v=4",
+      "profile": "http://matheu.srv.br",
+      "contributions": [
+        "translation",
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "robertlluberes",
+      "name": "Robert Lluberes",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/13991439?v=4",
+      "profile": "https://robertlluberes.com",
+      "contributions": [
+        "translation"
+      ]
+    },
     {
       "login": "bogas04",
       "name": "Divjot Singh",
@@ -52,17 +120,6 @@
         "doc"
       ]
     },
-    {
-      "login": "jfmengels",
-      "name": "Jeroen Engels",
-      "avatar_url": "https://avatars.githubusercontent.com/u/3869412?v=3",
-      "profile": "https://github.com/jfmengels",
-      "contributions": [
-        "doc",
-        "review",
-        "tool"
-      ]
-    },
     {
       "login": "chrissimpkins",
       "name": "Chris Simpkins",
@@ -155,57 +212,6 @@
         "doc"
       ]
     },
-    {
-      "login": "MatheusRV",
-      "name": "Matheus Rocha Vieira",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/23284276?v=4",
-      "profile": "http://matheu.srv.br",
-      "contributions": [
-        "translation",
-        "code",
-        "doc"
-      ]
-    },
-    {
-      "login": "robertlluberes",
-      "name": "Robert Lluberes",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/13991439?v=4",
-      "profile": "https://robertlluberes.com",
-      "contributions": [
-        "translation"
-      ]
-    },
-    {
-      "login": "jakebolam",
-      "name": "Jake Bolam",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/3534236?v=4",
-      "profile": "https://jakebolam.com",
-      "contributions": [
-        "doc",
-        "tool",
-        "maintenance"
-      ]
-    },
-    {
-      "login": "tbenning",
-      "name": "tbenning",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/7265547?v=4",
-      "profile": "https://github.com/tbenning",
-      "contributions": [
-        "design"
-      ]
-    },
-    {
-      "login": "Berkmann18",
-      "name": "Maximilian Berkmann",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/8260834?v=4",
-      "profile": "maxcubing.wordpress.com",
-      "contributions": [
-        "doc",
-        "translation",
-        "maintenance"
-      ]
-    },
     {
       "login": "Jongjineee",
       "name": "이종진",
@@ -235,12 +241,30 @@
       ]
     },
     {
-      "login": "sinchang",
-      "name": "Jeff Wen",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/3297859?v=4",
-      "profile": "https://sinchang.me",
+      "login": "allcontributors",
+      "name": "allcontributors[bot]",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/46843839?v=4",
+      "profile": "https://github.com/all-contributors/all-contributors-bot",
       "contributions": [
-        "maintenance"
+        "doc"
+      ]
+    },
+    {
+      "login": "Greenkeeper[bot]",
+      "name": "Greenkeeper[bot]",
+      "avatar_url": "https://avatars3.githubusercontent.com/in/505?v=4",
+      "profile": "https://github.com/apps/greenkeeper",
+      "contributions": [
+        "infra"
+      ]
+    },
+        {
+      "login": "maryampaz",
+      "name": "Maryam Pazirandeh",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/30090413?v=4",
+      "profile": "https://github.com/maryampaz",
+      "contributions": [
+        "doc"
       ]
     }
   ],

diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -27,28 +27,77 @@ jobs:
     <<: *docker_defaults
     working_directory: ~/repo
     steps:
-      - prep_env
+      # - prep_env
+      - checkout:
+          path: ~/repo
       - run: cat package.json | jq 'del(.scripts.postinstall)' > package.json.tmp && mv package.json.tmp package.json
       - run: yarn install --frozen-lockfile
       - save_env_cache
-  deploy:
+  build:
+    <<: *docker_defaults
+    working_directory: ~/repo
+    steps:
+      - prep_env
+      - run:
+          name: Build website
+          command: yarn build
+  deploy_website:
     <<: *docker_defaults
     working_directory: ~/repo
     steps:
       - prep_env
-      - run: yarn run semantic-release
+      - add_ssh_keys:
+          fingerprints:
+            - "17:59:4f:3f:42:ec:3c:e0:9f:55:88:c7:4d:b8:30:70"
+      - run:
+          name: Install crowdin
+          command: |
+              sudo apt-get install default-jre
+              wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+              sudo dpkg -i crowdin.deb
+      - run:
+          name: Setup git user and deploy website
+          command: |
+            git config --global user.email "[email protected]"
+            git config --global user.name "CircleCI All Contributors Website"
+            yarn write-translations
+            yarn crowdin-upload
+            yarn crowdin-download
+            CUSTOM_COMMIT_MESSAGE="[skip ci]" USE_SSH=true yarn publish-gh-pages
+      - run:
+          name: Semantic release to NPM and GitHub releases
+          command: yarn run semantic-release
+
+  check_404s:
+    <<: *docker_defaults
+    working_directory: ~/repo
+    steps:
+      - prep_env
+      - run:
+          name: Wait to hit CDN edges
+          command: sleep 60
+      - run:
+          name: Check 404s production
+          command: yarn blc https://all-contributors.js.org -ro
+
 workflows:
   version: 2
-  test_and_deploy:
+  build_and_deploy:
     jobs:
       - node_modules
-      - deploy:
+      - build:
           requires:
             - node_modules
+      - deploy_website:
+          requires:
+            - build
           filters:
             branches:
               only:
                 - master
+      - check_404s:
+          requires:
+            - deploy_website
 
 experimental:
   notify:

diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,8 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# Website
+website/build
+website/i18n
+website/translated_docs
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016 Kent C. Dodds
+Copyright (c) 2016 Kent C. Dodds, 2019 Jake Bolam
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -17,4 +17,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@
 </table>
 
 [![Build Status](https://img.shields.io/circleci/project/all-contributors/all-contributors/master.svg)](https://circleci.com/gh/all-contributors/all-contributors)
+[![Crowdin](https://d322cqt584bo4o.cloudfront.net/all-contributors/localized.svg)](https://crowdin.com/project/all-contributors)
 [![Greenkeeper badge](https://badges.greenkeeper.io/all-contributors/all-contributors.svg)](https://greenkeeper.io/)
 [![version](https://img.shields.io/npm/v/all-contributors.svg)](https://www.npmjs.com/package/all-contributors)
 

diff --git a/crowdin.yaml b/crowdin.yaml
@@ -0,0 +1,21 @@
+project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
+api_key_env: CROWDIN_DOCUSAURUS_API_KEY
+base_path: "./"
+preserve_hierarchy: true
+
+files:
+  -
+    source: '/docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: &anchor
+      locale:
+        'es-ES': 'es-ES'
+        'fr': 'fr'
+        'ko': 'ko'
+        'pt-BR': 'pt-BR'
+        'zh-CN': 'zh-CN'
+
+  -
+    source: '/website/i18n/en.json'
+    translation: '/website/i18n/%locale%.json'
+    languages_mapping: *anchor
diff --git a/docs/assets/app-install.png b/docs/assets/app-install.png
diff --git a/docs/assets/bot-usage.png b/docs/assets/bot-usage.png
diff --git a/docs/assets/configure-repositories.png b/docs/assets/configure-repositories.png
diff --git a/docs/assets/edit-this-page.png b/docs/assets/edit-this-page.png
diff --git a/docs/bot/configuration.md b/docs/bot/configuration.md
@@ -0,0 +1,43 @@
+---
+id: configuration
+title: Bot Configuration
+sidebar_label: Configuration
+---
+
+You can configure the all-contributors bot behaviour by updating the `.all-contributorsrc` JSON file.
+The data used to generate the contributors list will be stored in there, and you
+can configure how you want `@all-contributors` to generate the list.
+
+> You are viewing the 🤖Bot Configuration, which is similar to the [CLI Configuration](../cli/configuration)
+
+These are the keys you can specify:
+
+| Option                | Description                                                                                         | Example/Default                                                                                             |
+| --------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| `files`               | Array of files to update.                                                                           | Default: `['README.md']`                                                                                    |
+| `imageSize`           | Size (in px) of the user's avatar.                                                                  | Default: `100`                                                                                            |
+| `contributorsPerLine` | Maximum number of columns for the contributors table.                                               | Default: `7`                                                                                                |
+| `badgeTemplate`       | Define your own lodash template to generate the badge.                                              | |
+| `contributorTemplate` | Define your own lodash template to generate the contributor.                                        | |
+| `types`               | Specify custom symbols or link templates for contribution types. Can override the documented types. | |
+| `contributors`        | List of contributors for this project, this is updated by [@all-contributors add](usage#all-contributors-add) | |
+
+```json
+{
+  "files": ["README.md"],
+  "imageSize": 100,
+  "contributorsPerLine": 7,
+  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
+  "contributorTemplate": "<%= avatarBlock %><br /><%= contributions %>",
+  "types": {
+    "custom": {
+      "symbol": "🔭",
+      "description": "A custom contribution type.",
+      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
+    }
+  },
+  "contributors": []
+}
+```
+
+