enh: move from yarn to npm and update docs

[lwasser]

This pr makes some small changes to the documentation for building the project. Specifically we use npm instead of yarn.

closes #839

This is also a test for me to see how CI works and how the process works here.
i did not modify the lock file with this PR but we will want to migrate from yarn.lock to a package lock.json file.

Checklist:

• Documentation
• Ready to be merged
• Added myself to contributors table.
  Bot Usage

I also need to see how linting is set up and whether I break our linter here.

[lwasser]

This addresses the linter issues - the table wasn't formatted consistently.

[lwasser]

I added instructions about using npm, and running a linter locally.

[lwasser]

@all-contributors please add @lwasser for docs

[allcontributors]

@lwasser

I've put up a pull request to add @lwasser! 🎉

[lwasser]

Hi @willingc 👋🏻 this is a more final version of the pr in my repository, but ONLY with documentation - not with the CI build for the docs!!

[willingc]

Overall, this looks good @lwasser. I would bump the node version to one that is actively maintained.

[lwasser]

Thank you @willingc
I also got the website working!! There are still some link issues to resolve, but I figured out the dueling directories!!
See:
https://www.leahwasser.com/all-contributors/

GH Pages should totally work if we deploy from this repo!! (Once I figure out the rest 🚀) 🎉
pr here: (the same one you looked at earlier)

[lwasser]

@all-contributors please add @willingc for review

[allcontributors]

@lwasser

I've put up a pull request to add @willingc! 🎉

[JimMadge]

Good stuff.

I can see some more references to yarn,

❯ rg yarn
netlify.toml
6:  command = "yarn build-with-translations"

package.json
16:    "crowdin-upload": "yarn crowdin --config crowdin.yaml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",
17:    "crowdin-download": "yarn crowdin --config crowdin.yaml download -b $(git rev-parse --abbrev-ref HEAD)",
18:    "build-with-translations": "yarn write-translations && yarn crowdin-upload && yarn crowdin-download && yarn build",

docs/cli/installation.md
21:yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli
33:yarn all-contributors init # or npx all-contributors init
42:yarn all-contributors add jfmengels doc
43:yarn all-contributors generate
70:yarn contributors:add jfmengels doc

docs/cli/usage.md
9: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 😺

The scripts in package.json and the Netlify command probably need to be updated. (Although, we might move from Netlify to GH Pages).

I think we can leave the references to yarn in the CLI docs though, because that is another repository. We might want to move that to npm in the future but no need to do that now.

[JimMadge]

Forgot to say in my review, the "Docs" link on the landing page directs to /docs/ which returns 404. /docs/en/ also returns 404. I assume we would want both of these to resolve to /docs/en/overview, or the same for another language.

[lwasser]

Forgot to say in my review, the "Docs" link on the landing page directs to /docs/ which returns 404. /docs/en/ also returns 404. I assume we would want both of these to resolve to /docs/en/overview, or the same for another language.

@JimMadge ! Thank you for all of the feedback! I am going to work on responding / fixing things over the weekend but I saw this comment and had a question. I didn't fix the docs link because I don't understand yet how translations are setup and whether it should default to english or where that link / how that links work relative to translations.

The other issue related to translations is that they are hosted on crowdin. It translations are on crowdin, how does that work with the Docusaurus site here (all in english). It could be better to move / sync them here with a github action.

Because now, anything we change, won't have a current translation.

Does my question make sense? I don't know how to handle that docs link in the short question and wondered if you did. The entire index page is pure html 🙃 . So fixing links is easy but there is a translation interface to consider!

[JimMadge]

@JimMadge ! Thank you for all of the feedback! I am going to work on responding / fixing things over the weekend but I saw this comment and had a question. I didn't fix the docs link because I don't understand yet how translations are setup and whether it should default to english or where that link / how that links work relative to translations.

Actually, it occurred to me afterwards that the redirection based on language was probably done by Netlify so I'm not sure we should expect it to work when serving locally.

[JimMadge]

Looks good. I there is a lot of work here, we can look at updating or replacing dependencies in other PRs to avoid this snowballing.

[lwasser]

Looks good. I there is a lot of work here, we can look at updating or replacing dependencies in other PRs to avoid this snowballing.

I'd love that. I think right now, trying to keep our PR's small and mergeable is a great idea. Please just let me know what types of things you and the rest of the touring team want to work on and we can divy up the work. I'll go ahead and merge this PR given your approval - thank you!! There are a LOT of dependency updates to do.

Also related to your comment about translations, let's talk about that in a translation specific issue. I'll start one that is a sub issue of #843 and is specific to translations!

[lwasser]

Merging this pr!! thank you again for all of the reviews!! ❤️