Commit Graph

37 Commits

Author SHA1 Message Date
Shaun Hamilton
2f77d61ba7 feat(docs): add missing highlighting (#52246) 2023-11-06 23:20:33 +07:00
S A G A R
e2879397fd fix(docs): minor grammatical and typographical fixes in files (#52120)
Co-authored-by: Jeremy L Thompson <jeremy@jeremylt.org>
Co-authored-by: Huyen Nguyen <25715018+huyenltnguyen@users.noreply.github.com>
2023-10-27 10:13:33 +02:00
Christine Belzie
471c2ed789 docs: revising typos and adding clarity to steps for creating a PR (#51490) 2023-09-06 17:50:06 +05:30
Ben DaGloria Rifleman
0e8e7bf232 fix(docs): replace exclusionary language, add punctuation (#50318) 2023-05-09 12:17:30 +03:00
Kolade Chris
d614c4173f docs: update pnpm commands, fix typos and grammar (#49990
* fix: improving the docs

* fix: did some more typos and gramos fixes

* fix: fixed typographical and grammatical errors, capitalized headings, made adjustments to the directories to run pnpm run create-project.

* Implemented Shaun's suggested changes

* Removed duplicate lines from my end

* Fixed a few "open-source" and "open source" confusion
2023-04-10 15:15:26 +05:30
Oliver Eyton-Williams
d7848ae01a feat: migrate to pnpm for better workspace DX (#49293)
* feat: npm -> pnpm 

This resolves the issues with the gatsby client (gatsby-plugin-pnpm
deals with the fact that gatsby is relying on its own dependencies
being de-duped)
and challenge-editor (which doesn't seem to want to automatically install
codemirror and needed its own eslint config)

* fix: correct mocha path for curriculum tests

* fix: use select workspace with -F not -w

* fix: reorganise packages and restrict hoisting

pnpm works best if the workspaces keep their own dependencies, since
dependencies are not flattened and then what node resolves from a
require is predictable.

@types seem to be a special case and more care is required to prevent
them getting smushed together in the root (hence the .npmrc)

* fix: add types for tools + root

* fix: decouple challenge-auditor from client

* fix: add ui-components types

* fix(client): use the latest types for react 16

* fix: prettify

* fix: prettierignore pnpm-lock

* fix: relax hoisting

Turns out pnpm works just fine with types. I don't know what was going
wrong before, but there are no-longer any type conflicts.

* fix: add @redux-saga/core to fix eslint issue

It seems to only be redux-saga that import/named can't cope with, so it
is probably okay to work around this one.

* chore: add chai to tools/scripts/build

* fix: add store to root for cypress

* fix: allow cypress to download binaries

If we want to keep preventing cypress from downloading binaries, we can
figure out a workaround, but I'm allowing it to ease the transition to
pnpm.

My guess about why this is happening is that npm triggers Cypress's
postinstall script, but pnpm does not (because pnpm install only
installs if necessary, perferring to link)

* chore: re-enable pre/post scripts

* fix: update build scripts for client

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>

* chore: update engines to use pnpm


* fix: enable choice of (super)block for tests

Only 'nix machines for now.

* chore: pin pnpm to version 7

* chore: remove last npms

Except web + curriculum-server. I'll update them when I start work on
them again.

* fix: lockfile check to catch any package-locks

* fix(action): install pnpm for upcoming tests

* chore: add nodemon to new api

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>
2023-03-02 18:17:44 +00:00
Michelle Paradis
0fd6852b86 docs: typo on how to open pull request document (#48093) 2022-10-17 19:39:34 +05:30
Mrugesh Mohapatra
00f0c2dee1 docs: clearer tone for non-native speakers (#47946)
* docs: clearer tone for non-native speakers

* chore: fix formatting
2022-10-09 15:42:05 +02:00
Mrugesh Mohapatra
4d2b5e9314 docs: add newbie guideline and template (#47834)
* docs: add newbie guideline and template

* fix: open the sidebar by default

* chore: apply review

* Apply suggestions from code review

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Ilenia <nethleen@gmail.com>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>

* Update docs/moderator-handbook.md

Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>

Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>
Co-authored-by: Ilenia <nethleen@gmail.com>
Co-authored-by: Tom <20648924+moT01@users.noreply.github.com>
2022-10-05 19:38:50 +05:30
kartik
82691be5e2 doc: change wording of PR guidance (#47070)
* TYPO: improved words

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Muhammed Mustafa <muhammed@freecodecamp.org>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Muhammed Mustafa <muhammed@freecodecamp.org>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Muhammed Mustafa <muhammed@freecodecamp.org>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Jeremy L Thompson <jeremy@jeremylt.org>

* Update docs/how-to-open-a-pull-request.md

Co-authored-by: Jeremy L Thompson <jeremy@jeremylt.org>

Co-authored-by: Muhammed Mustafa <muhammed@freecodecamp.org>
Co-authored-by: Jeremy L Thompson <jeremy@jeremylt.org>
2022-07-29 19:44:32 +00:00
Ilenia
e59d58edf1 docs: swap example pr title (#47035)
* docs: swap example pr title

* typo
2022-07-25 19:53:06 +02:00
Naomi Carrigan
1a4044a3b9 docs: change rocket chat links to discord (#46514) 2022-06-16 08:23:15 +04:00
zelf0
657aade2e5 fix(docs): Update grammar in PR documentation (#45174) 2022-02-21 08:42:25 +05:30
Huyen Nguyen
22ac598f6e docs: fix a typo in the contributing guide (#45045) 2022-02-07 17:01:15 -08:00
sidemt
5dc3e31cba docs: add missing & in 'Compare & pull request' (#44985) 2022-02-01 11:12:06 -08:00
Oliver Eyton-Williams
c8d7f0a782 feat(tools): remove eslint-plugin-prettier for prettier (#42438)
* feat: remove eslint-plugin-prettier for prettier

This removes the annoying lint warnings when all that needs to change is
formatting

* fix: use .js lint-staged config to ignore properly

* fix: lint everything if a lot of files are changed

It's faster than making lots of individual linter calls

* chore: apply prettier

* fix: ignore code in curriculum-file-structure
2021-10-06 21:02:21 +05:30
Eric Cheng
1f880a552d fix(docs): modified grammar and phrasing in docs and comments (#43682)
* docs: fixed minor typos in how-to-open-a-pull-request.md

* docs: grammar fixes in FAQ.md

* refactor: streamlined comments in multiple TS files

* fix: linting issues
2021-10-02 23:43:14 +01:00
Ilenia
1d0a6a5673 Changing documentation links for i18n ease (#43274)
* fixing links for i18n ease

* fixing links for i18n ease

* revert brain fart

* hopefully now the link works

* changing links for ease of translation
2021-08-26 10:59:44 +02:00
Mrugesh Mohapatra
77973d9c6c fix(docs): broken link to translations 2021-07-08 16:33:19 +05:30
Nicholas Carrigan (he/him)
f60fa14d3e fix(docs): repair image links (#41231) 2021-02-23 10:47:03 +05:30
Nicholas Carrigan (he/him)
bebd599e62 fix(docs): typo (#41137)
Resolves a missing word mentioned in a Crowdin comment.
2021-02-16 08:08:43 -07:00
Nicholas Carrigan (he/him)
b2526c855a fix(docs): additional i18n notes (#41084)
* fix(docs): note about PR language

Adds a note that PR title, body, commits, and code should all be
in English.

* feat(docs): additional notes

Adds note about setting Crowdin to show HTML tags instead of number
tags, and note about what to do when overriding a QA check.

* fix: apply review suggestions

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
2021-02-12 11:54:24 -07:00
Nicholas Carrigan (he/him)
ff181c3258 docs: tweaks for translations (#40806)
Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com>
2021-02-07 22:17:40 +05:30
Talla Giridhar
c1f9cd93f5 general educational fixes in some files (#40800)
Co-authored-by: Ilenia <nethleen@gmail.com>
Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com>
Co-authored-by: nhcarrigan <nhcarrigan@gmail.com>
2021-02-03 15:17:56 +05:30
Nicholas Carrigan (he/him)
e5b43edf84 docs: master -> main (#40857)
Updates the docs to reflect the change from `master` to `main` as our
primary branch.

Signed-off-by: nhcarrigan <nhcarrigan@gmail.com>
2021-02-01 19:55:24 +05:30
Nicholas Carrigan (he/him)
2d0bba3097 docs: Replace Gitter/Discord links (#40514) 2020-12-22 12:00:00 +05:30
Luis H. Ball Jr
bbbc03c379 docs(cypress): create how-to-add-cypress-tests doc (#40262)
Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
2020-11-21 23:34:13 +05:30
Nicholas Carrigan (he/him)
fa2d5c687c Fix broken Discord link (#40035)
* Fix broken Discord link

* Change links across translations
2020-10-20 00:11:08 +05:30
Quincy Larson
e21e6c1ce6 Streamline copy and remove gitter references (#40015)
Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
Co-authored-by: Shaun Hamilton <51722130+Sky020@users.noreply.github.com>
Co-authored-by: freeCodeCamp <freecodecamp@MacBook-Pro.local>
Co-authored-by: Mrugesh Mohapatra <1884376+raisedadead@users.noreply.github.com>
2020-10-19 18:27:37 +05:30
Ashik Paul
9aa04199fc Fixed a minor typo (#39227) 2020-07-10 17:57:25 -05:00
Lasse Jørgensen
198c051d0e fix(doc): Correct link for "making changes and syncing" (#38956)
Fixing localhost link.
2020-05-31 08:06:00 -05:00
Beau Carnes
bf1cbd1eb0 docs: fixed command in guidelines (#38688) 2020-04-30 00:19:14 +05:30
Mrugesh Mohapatra
54bf2074e4 docs: add pr conflict guidelines (#38686) 2020-04-29 22:09:03 +05:30
Mrugesh Mohapatra
09cd14fd22 feat(docs): host docs with docsify 2020-04-06 20:50:40 +05:30
Jamie Strusz
cc9c86bd72 Update docs/how-to-open-a-pull-request.md for grammar and readability (#37235)
* Fix minor grammar errors

* Rephrase keyword section

* Add keyword documentation link for learners

* Reword for clarity and fix grammar

* fix: make suggested changes

* fix: removed comma
2019-11-25 10:09:30 -06:00
mrugesh
a5b176be88 docs: update contributing guides (#36816) 2019-09-20 23:56:56 +05:30
The Coding Aviator
f0d907be66 docs: make scope and naming of Pull Requests clearer (#35272)
Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com>
Co-authored-by: mrugesh mohapatra <1884376+raisedadead@users.noreply.github.com>
2019-03-05 21:38:26 +05:30