enh(infra): move from yarn to npm and update docs (#841)

* enh: move from yarn to npm and update docs

* enh(docs): linting and update docs to use npm

Update docs/project/contribute.md

Co-authored-by: Carol Willing <[email protected]>

* Enh: edits from Carol Willing

Apply suggestions from code review

Co-authored-by: Carol Willing <[email protected]>

Apply suggestions from code review

Co-authored-by: Jim Madge <[email protected]>

* docs: remove yarn from scripts too

chore: remove yarn lockfile and references

* fix: more yarn instances

---------

Co-authored-by: Carol Willing <[email protected]>
Co-authored-by: Jim Madge <[email protected]>

Author: 3 people

.circleci/config.yml

@@ -12,13 +12,13 @@ commands:
           path: ~/repo
       - restore_cache:
           name: Restore node_modules cache
-          key: all-contributors-{{ checksum "yarn.lock" }}-{{ .Branch }}
+          key: all-contributors-{{ checksum "package-lock.json" }}-{{ .Branch }}
   save_env_cache:
     description: Saves environment cache
     steps:
       - save_cache:
           name: Save node_modules cache
-          key: all-contributors-{{ checksum "yarn.lock" }}-{{ .Branch }}
+          key: all-contributors-{{ checksum "package-lock.json" }}-{{ .Branch }}
           paths:
             - node_modules/
 
@@ -28,7 +28,7 @@ jobs:
     working_directory: ~/repo
     steps:
       - prep_env
-      - run: yarn install --frozen-lockfile
+      - run: npm ci
       - save_env_cache
   publish_release:
     <<: *docker_defaults
@@ -40,7 +40,7 @@ jobs:
           command: cat package.json | jq '.scripts.postinstall = "node index.js"' > package.json.tmp && mv package.json.tmp package.json
       - run:
           name: Semantic release to NPM and GitHub releases
-          command: yarn run semantic-release
+          command: npm run semantic-release
 
   check_404s:
     <<: *docker_defaults
@@ -52,7 +52,7 @@ jobs:
           command: sleep 500
       - run:
           name: Check 404s production
-          command: yarn blc https://allcontributors.org -ro || true
+          command: npx blc https://allcontributors.org -ro || true
 
 workflows:
   version: 2

.gitignore

@@ -24,8 +24,6 @@ node_modules
 logs
 *.log
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
 
 # Website
 website/build

docs/cli/installation.md

@@ -4,7 +4,6 @@ title: CLI Installation
 sidebar_label: Installation
 ---
 
-
 ## 1. Install the CLI tool
 
 <a href="https://www.npmjs.com/package/all-contributors-cli">
@@ -18,7 +17,8 @@ This module is distributed via [npm](https://www.npmjs.com/) which is bundled wi
 should be installed as one of your project's `devDependencies`:
 
 ```console
-yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli
+npm i -D all-contributors-cli
+# If you are a yarn user: yarn add --dev all-contributors-cli
 ```
 
 Alternatively, Arch Linux users can install the [`all-contributors-cli`](https://aur.archlinux.org/packages/all-contributors-cli) package from the AUR.
@@ -30,7 +30,8 @@ Alternatively, Arch Linux users can install the [`all-contributors-cli`](https:/
 Init the project using `init` and answer a few questions
 
 ```console
-yarn all-contributors init # or npx all-contributors init 
+npx all-contributors init 
+# Or with yarn: yarn all-contributors init
 
 # Or directly execute the bin
 ./node_modules/.bin/all-contributors init
@@ -39,8 +40,8 @@ yarn all-contributors init # or npx all-contributors init
 ## 3. Add some contributors
 
 ```console
-yarn all-contributors add jfmengels doc
-yarn all-contributors generate
+npx all-contributors add jfmengels doc
+npx all-contributors generate
 ```
 
 For more on the commands see [CLI usage](usage)
@@ -64,10 +65,10 @@ For example:
 }
 ```
 
-To allow shortcuts such as
+To allow shortcuts such as:
 
 ```console
-yarn contributors:add jfmengels doc
+npx contributors:add jfmengels doc
 ```
 
 ## What's next

docs/cli/usage.md

@@ -6,7 +6,7 @@ sidebar_label: Usage
 
 > This usage documentation assumes you have already followed the [cli installation steps](installation).
 
-A quick note: Below we'll just show `all-contributors` to keep things simple, but if you're having any difficulties, then give the `yarn all-contributors` route a try 😺
+A quick note: Below we'll just show `all-contributors` to keep things simple, but if you're having any difficulties, then give the `npx all-contributors-cli init` route a try 😺.
 
 ## Commands
 

docs/emoji-key.md

@@ -8,41 +8,41 @@ sidebar_label: Emoji Key ✨
 
 > To have a contribution added when using the [Bot](bot/overview) or [CLI](cli/overview) use the keyword in the `Type` column. The bot will also use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/master/lib/parse-comment.js) to determine your contribution intent.
 
-Emoji/Type | Represents | Comments
-:---: | :---: | :---:
-🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects
-♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues
-🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project
-📝 <br /> `blog` | Blogposts | Links to the blogpost
-💼 <br /> `business` | Business Development | People who execute on the business end
-💻 <br /> `code` | Code | Links to commits by the user on this project
-🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate
-🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets)
-📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation
-🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc.
-💡 <br /> `example` | Examples | Links to the examples
+Emoji/Type | Represents | Comments |
+:---: | :---: | :---: |
+🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects |
+♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues |
+🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project |
+📝 <br /> `blog` | Blogposts | Links to the blogpost |
+💼 <br /> `business` | Business Development | People who execute on the business end |
+💻 <br /> `code` | Code | Links to commits by the user on this project |
+🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate |
+🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets) |
+📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation |
+🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc. |
+💡 <br /> `example` | Examples | Links to the examples |
 📋 <br /> `eventOrganizing` | Event Organizers | Links to event page |
-💵 <br /> `financial` | Financial Support | People or orgs who provide financial support, links to relevant page
-🔍 <br /> `fundingFinding` | Funding/Grant Finders | People who help find financial support
+💵 <br /> `financial` | Financial Support | People or orgs who provide financial support, links to relevant page |
+🔍 <br /> `fundingFinding` | Funding/Grant Finders | People who help find financial support |
 🤔 <br /> `ideas` | Ideas & Planning | |
-🚇 <br /> `infra` | Infrastructure | Hosting, Build-Tools, etc. Links to source file (like `travis.yml`) in repo, if applicable
-🚧 <br /> `maintenance` | Maintenance | People who help in maintaining the repo, links to commits by the user on this project
-🧑‍🏫 <br /> `mentoring` | Mentoring | People who mentor new contributors, links to the repo home
+🚇 <br /> `infra` | Infrastructure | Hosting, Build-Tools, etc. Links to source file (like `travis.yml`) in repo, if applicable |
+🚧 <br /> `maintenance` | Maintenance | People who help in maintaining the repo, links to commits by the user on this project |
+🧑‍🏫 <br /> `mentoring` | Mentoring | People who mentor new contributors, links to the repo home |
 📦 <br /> `platform` | Packaging | Porting to support a new platform |
-🔌 <br /> `plugin` | Plugin/utility libraries | Links to the repo home
+🔌 <br /> `plugin` | Plugin/utility libraries | Links to the repo home |
 📆 <br /> `projectManagement` | Project Management | |
 📣 <br /> `promotion` | Promotion | |
-💬 <br /> `question` | Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc.
-🔬 <br /> `research` | Research | Literature review.
+💬 <br /> `question` | Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc. |
+🔬 <br /> `research` | Research | Literature review. |
 👀 <br /> `review` | Reviewed Pull Requests | |
-🛡️ <br /> `security` | Security | Identify and/or reduce security threats, GDPR, Privacy, etc
-🔧 <br /> `tool` | Tools | Links to the repo home
-🌍 <br /> `translation` | Translation | Links to the translated content
-⚠️ <br /> `test` | Tests | Links to commits by the user on this project
-✅ <br /> `tutorial` | Tutorials | Links to the tutorial
-📢 <br /> `talk` | Talks | Links to the slides/recording/repo/etc
-📓 <br /> `userTesting` | User Testing | Links to user test notes
-📹 <br /> `video` | Videos | Links to the video
+🛡️ <br /> `security` | Security | Identify and/or reduce security threats, GDPR, Privacy, etc |
+🔧 <br /> `tool` | Tools | Links to the repo home |
+🌍 <br /> `translation` | Translation | Links to the translated content |
+⚠️ <br /> `test` | Tests | Links to commits by the user on this project |
+✅ <br /> `tutorial` | Tutorials | Links to the tutorial |
+📢 <br /> `talk` | Talks | Links to the slides/recording/repo/etc |
+📓 <br /> `userTesting` | User Testing | Links to user test notes |
+📹 <br /> `video` | Videos | Links to the video |
 
 ## What's next
 

docs/project/contribute.md

@@ -64,13 +64,49 @@ Search is by algolia, the configuration is at <https://github.com/algolia/docsea
 
 ## Running the site locally:
 
-All Contributors uses Docusaurus to maintain our documentation website. For more info visit the [Docusaurus Website](https://docusaurus.io)
+All Contributors currently uses [Docusaurus 1.x](https://docusaurus.io) for our documentation website.
 
-To get started locally:
+To build the docs locally:
 
-- `yarn install`
-- `yarn start`
-- go to `http://localhost:3000` (Refresh the page for your changes to be reflected)
+Make sure `npm` is installed on your machine. Use the [nodejs documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you aren't sure how to install `npm`.
+To check that npm is installed run the following in your favorite shell:
+
+`npm -v`
+
+Next, make sure you have at least node version 0.22 (LTS) or higher. To check the version,
+use:
+
+`node -v`
+
+If you don't have at least version `0.22` or higher, please install Node or upgrade your current version.
+
+Install docusaurus v1 (1.14.7) and all of the project dependencies using `npm install`. *Note: This project does not yet support docusaurus v2 or v3; though, we hope to do so in the future.*
+
+`npm install`
+
+Once you have completed the above, you can launch a server locally that will build and run the docs locally. In your favorite shell run:
+
+`npm run start`
+
+* Then, go to `http://localhost:3000` and you will see the all contributors website there!
+* Refresh the browser page as needed when editing markdown pages.
+
+### Make changes - linting your contribution
+
+If you make changes to a markdown file in the site, then our linting action will
+check those changes. To run the linter yourself on a file locally:
+
+First install markdownlint-cli:
+
+`npm install -g markdownlint-cli`
+
+Then run markdownlint on the file (or files) that you wish to check:
+
+`markdownlint --fix "docs/project/contribute.md"`
+
+Or you can run it on all files in the docs directory, like this:
+
+`markdownlint --fix "docs/**.md"`
 
 ## Add yourself as a contributor
 

index.js

@@ -3,6 +3,6 @@
   # HTML files and assets generated by the build. If a base directory has
   # been specified, include it in the publish directory path.
   publish = "website/build/all-contributors/"
-  command = "yarn build-with-translations"
+  command = "npm run build-with-translations"
   # functions = "api/functions/"
 

netlify.toml

@@ -13,15 +13,15 @@
     "build": "cd website && ../node_modules/.bin/docusaurus-build && cp _redirects build/all-contributors",
     "write-translations": "cd website && ../node_modules/.bin/docusaurus-write-translations",
     "crowdin": "java -jar website/crowdin/crowdin-cli.jar",
-    "crowdin-upload": "yarn crowdin --config crowdin.yaml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",
-    "crowdin-download": "yarn crowdin --config crowdin.yaml download -b $(git rev-parse --abbrev-ref HEAD)",
-    "build-with-translations": "yarn write-translations && yarn crowdin-upload && yarn crowdin-download && yarn build",
+    "crowdin-upload": "npm run crowdin -- --config crowdin.yaml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",
+    "crowdin-download": "npm run crowdin -- --config crowdin.yaml download -b $(git rev-parse --abbrev-ref HEAD)",
+    "build-with-translations": "npm run write-translations && npm run crowdin-upload && npm run crowdin-download && npm run build",
     "commit": "git-cz"
   },
   "devDependencies": {
     "broken-link-checker": "^0.7.8",
     "cz-conventional-changelog": "^2.1.0",
-    "docusaurus": "^1.7.3",
+    "docusaurus": "^1.7.4",
     "git-cz": "^4.1.0",
     "react": "^16.6.3",
     "semantic-release": "^19.0.3"