Commit Graph

71 Commits

Author SHA1 Message Date
Lasse Jørgensen
90feb7e72b fix(docs): correct link to prod-current in docs table (#53136) 2024-01-12 06:24:31 +01:00
Shaun Hamilton
2f77d61ba7 feat(docs): add missing highlighting (#52246) 2023-11-06 23:20:33 +07:00
Oliver Eyton-Williams
7fd74c8f5c fix(tools): manage PM2 globally 2023-07-17 16:45:37 +05:30
Naomi Carrigan
f9d148890f docs: general cleanup and maintenance (#50473)
Co-authored-by: Sem Bauke <semboot699@gmail.com>
2023-05-26 16:19:27 +05:30
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
fe4de8dfe6 docs(devops): correct build command for updates (#49646) 2023-03-10 09:19:50 +02:00
Oliver Eyton-Williams
3864d36e35 fix: remove use-node-version + update devops docs (#49636)
* fix: drop use-node-version + explain npmrc config

* docs(devops): go back to installing node directly

* docs(devops): update scripts + cleanup

* docs: add note about updating node

---------

Co-authored-by: Mrugesh Mohapatra <1884376+raisedadead@users.noreply.github.com>
2023-03-09 14:09:13 +00:00
Oliver Eyton-Williams
16dec4ef86 feat: use pnpm to manage pm2 (#49574)
* fix(api): use pnpm to manage pm2

This means that pm2 will get the correct NODE_PATH environment variable.
Also, if we use pnpm to manage node, this ensure that pm2 will use that
node version.

* docs(devops): update api install and update docs

* feat: set node version via npmrc

This means that all scripts (pnpm run ...) will use this node version.
The only way to get other node versions is to invoke `node` directly.

* fix(docs): update api docs for pnpm installation

* feat: use pm2 from root

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>
2023-03-07 14:54:31 -08:00
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
Mrugesh Mohapatra
9377e085c1 docs: update reload instructions (#49379)
* docs: update reload instructions

* Update docs/devops.md

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

* Update docs/devops.md

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

* fix: remove errant spaces

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

---------

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
Co-authored-by: Naomi Carrigan <nhcarrigan@gmail.com>
2023-02-19 19:04:05 +05:30
Sem Bauke
869e08e7e0 chore(docs): update chinese hyperlinks (#46207)
* chore(docs): update chine hyperlinks

* Apply suggestions from code review

Co-authored-by: Kristofer Koishigawa <scissorsneedfoodtoo@gmail.com>

* chore: remove file that has been moved

* chore: formating

Co-authored-by: Kristofer Koishigawa <scissorsneedfoodtoo@gmail.com>
Co-authored-by: Mrugesh Mohapatra <1884376+raisedadead@users.noreply.github.com>
Co-authored-by: Mrugesh Mohapatra <hi@mrugesh.dev>
2022-11-09 16:45:17 -06:00
Oliver Eyton-Williams
1f06c8cd13 fix(docs): sync devops manual with pipelines (#47845) 2022-10-05 11:27:31 +01:00
Mrugesh Mohapatra
c15fd16ffe docs: update devops documents for client (#47358)
* docs: update devops documents for client

* chore: apply suggestions from code review

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

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
2022-09-12 19:25:45 +05:30
Naomi Carrigan
1a4044a3b9 docs: change rocket chat links to discord (#46514) 2022-06-16 08:23:15 +04:00
Oliver Eyton-Williams
f8e41d0f65 docs(devops): update reload api command (#46404) 2022-06-08 15:40:37 +02:00
Mrugesh Mohapatra
c59f5748d7 docs(API): update command for spinning an instance (#46013) 2022-05-17 09:37:15 -05:00
sidemt
4fe2271f74 fix(docs): fix typo for IP address (#45060) 2022-02-09 20:44:53 +01:00
Oliver Eyton-Williams
7216ca55cc refactor: organise TypeScript config and migrate helpers (#44747)
* feat: allow more 1000 steps to be created at once

* refactor: start migrating to typescript

* refactor: delete-step to ts

* refactor: migrated some helpers

* refactor: migrate create-empty-steps

* refactor: migrate create-step-between

* refactor: finish migrating to TS

* refactor: migrate tests

* fix: ensure mock.restore is done after each test

* fix: prevent double-tscing

* fix: repair the tests

* chore: use ts-node for scripts

We don't need the performance boost of incremental compilation and
ts-node is easier to work with

* refactor: consolidate tsconfigs

* refactor: replace gulp

* fix: use ts-node for build-curriculum

* fix: allow ts compilation of config

* feat: create and use create:config script

* fix: add /config to eslint projects

* fix: remove gulp script
2022-01-25 11:34:16 +01:00
Mrugesh Mohapatra
3f62615f8d docs(devops): update npm version to v8 (#44455) 2021-12-10 17:26:21 +00:00
Oliver Eyton-Williams
2a286d3fc6 chore(docs): add contributor tools update instructions (#44393) 2021-12-07 21:46:38 +05:30
Mrugesh Mohapatra
d409194dd8 docs: update instructions (#44267)
* docs: update instructions

* docs: update instructions

* Update docs/devops.md

Co-authored-by: Nicholas Carrigan (he/him) <nhcarrigan@gmail.com>

Co-authored-by: Nicholas Carrigan (he/him) <nhcarrigan@gmail.com>
2021-11-24 17:41:11 +00:00
Nicholas Carrigan (he/him)
5e7aafc7b1 docs: fix up verbiage (#44102)
* docs: fix up verbiage

* chore: else............if

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

* chore: apply kris' review suggestions

Co-authored-by: Kristofer Koishigawa <scissorsneedfoodtoo@gmail.com>

Co-authored-by: Shaun Hamilton <shauhami020@gmail.com>
Co-authored-by: Kristofer Koishigawa <scissorsneedfoodtoo@gmail.com>
2021-11-22 12:51:18 +00:00
Ahmad Abdolsaheb
2dd29a8f68 docs: add news theme docs (#44092) 2021-11-02 15:57:06 +05:30
Nicholas Carrigan (he/him)
8535c23b08 fix: address crowdin issues (#43021) 2021-07-26 19:43:15 +01:00
Aileen
db79a0a29a fix(docs): replaced DANGER with ATTENTION (#42615) 2021-06-24 11:19:31 +02:00
Mrugesh Mohapatra
0d483049f0 docs: remove duplicate code block (#42109) 2021-05-12 10:05:44 +02:00
Nicholas Carrigan (he/him)
b3f296fab2 feat(docs): document email tool (#41722)
Add documentation for using the email blast tool to send out the
weekly newsletter.
2021-04-02 14:25:57 +03:00
Oliver Eyton-Williams
8521823831 docs: fix npm to v6 (#41607) 2021-03-27 10:19:48 +05:30
Nicholas Carrigan (he/him)
8305cad79a fix: address crowdin issues (#41517) 2021-03-18 16:31:05 +01:00
Oliver Eyton-Williams
4ea2ad881b docs: change node alias from stable to lts (#41503) 2021-03-18 05:39:27 -07:00
Michael Padilla
6f6c4f9081 Fix: Redundant word on english devops.md (#41505) 2021-03-16 14:27:21 +01:00
Randell Dawson
a3f6a2a904 fix(docs): Added missing word to sentence in devops.md (#41455) 2021-03-12 07:31:49 -08:00
Mrugesh Mohapatra
2cc38f6cc5 docs: update devops flight-manuals (#41446)
Co-authored-by: Nicholas Carrigan (he/him) <nhcarrigan@gmail.com>
2021-03-12 10:21:57 +05:30
Mrugesh Mohapatra
58a74023ef docs: update prod commands for api-server (#41274) 2021-02-26 13:29:33 -08:00
Mrugesh Mohapatra
b5f4754e2a fix: re-revert the API decoupling (#41263)
* fix(api): decouple api from curriculum

This reverts commit 8f0e441644 and
introduces the implementations from #40703.

* fix(gitpod): add curriculum build to GitPod

This reverts commit 706d70f58d and
introduces implementations from #41234.

* docs: update DevOps manual for api change (#41259)

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
2021-02-25 12:02:35 -08:00
Oliver Eyton-Williams
654afae0cf docs: s/maim/main/g (#41262) 2021-02-25 07:05:20 -08:00
Nicholas Carrigan (he/him)
6bf33efc99 fix: small typo (#41230) 2021-02-23 09:32:38 +05:30
Mrugesh Mohapatra
3bbf96e495 chore: update devops docs (#41037) 2021-02-10 16:20:14 +05:30
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
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)
7317b8057a fix(docs): Replace Travis with GH Actions (#40580)
Replaces the references to the old Travis CI
flow with updated information for the GitHub
actions flow, and handles a couple of typo fixes.

Signed-off-by: nhcarrigan <nhcarrigan@gmail.com>
2020-12-29 11:15:12 +05:30
Nicholas Carrigan (he/him)
2d0bba3097 docs: Replace Gitter/Discord links (#40514) 2020-12-22 12:00:00 +05:30
Mrugesh Mohapatra
0fa965849e fix(docs): remove subfolders because we use relative linking (#39812)
* fix(docs): remove subfolders because we use relative linking

* fix(docs): links to chinese section should be direct
2020-10-08 18:16:44 +01:00
Himanshu maurya
0082e99f62 Update devops.md (#39237)
Fixed some typos.
2020-07-12 22:37:05 -07:00
Mrugesh Mohapatra
4326864fdc docs: update notes abut auth page 2020-05-14 17:06:34 +05:30
Mrugesh Mohapatra
3c81587924 feat(docs): jazz up the docs site (#38594) 2020-04-21 06:56:45 +05:30
Jordan Liu
8396b2bc8f "artefact" to "artifact" (#38528) 2020-04-11 20:45:22 -05:00
Mrugesh Mohapatra
09cd14fd22 feat(docs): host docs with docsify 2020-04-06 20:50:40 +05:30
Mrugesh Mohapatra
ac5e966877 docs(devops): add status badges 2020-03-28 19:34:00 +05:30
Mrugesh Mohapatra
f6978d1d40 docs: update links and grammar 2020-03-27 14:06:53 +05:30