From eaaa76893c7480476f5e976c3c851db653cea9c1 Mon Sep 17 00:00:00 2001 From: Dan Ballard Date: Tue, 24 May 2022 17:32:03 -0700 Subject: [PATCH] README add node instructions and our deployment instructions --- README.md | 36 ++++++++++++++++++++++++++---------- static/img/favicon.ico | Bin 3626 -> 0 bytes 2 files changed, 26 insertions(+), 10 deletions(-) delete mode 100644 static/img/favicon.ico diff --git a/README.md b/README.md index aaba2fa1..f5c10126 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,29 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta $ yarn ``` +or + +install [NVM](https://github.com/nvm-sh/nvm) to manage multiple and new NodeJS versions, and then install NodeJS 16 + +``` +$ nvm install 16 +$ nvm use 16 +``` + +*nvm only works in bash shell* + ### Local Development ``` $ yarn start ``` +or + +``` +$ npm run start +``` + This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. ### Build @@ -22,20 +39,19 @@ This command starts a local development server and opens up a browser window. Mo $ yarn build ``` +or + +``` +$ npm run build +``` + This command generates static content into the `build` directory and can be served using any static contents hosting service. ### Deployment -Using SSH: +Using git.openprivacy.ca to manage but deployment by push is to a seperate docs server. Add your key to the docusaurus account's .ssh/authorized_keys and then ``` -$ USE_SSH=true yarn deploy +$ git remote add docs docusaurus@docs.cwtch.im:/home/docusaurus/git/docs.cwtch.im +$ git push docs main ``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/static/img/favicon.ico b/static/img/favicon.ico deleted file mode 100644 index c01d54bcd39a5f853428f3cd5aa0f383d963c484..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3626 zcmb`Je@s(X6vrR`EK3%b%orErlDW({vnABqA zcfaS{d+xbU5JKp0*;0YOg+;Fl!eT)XRuapIwFLL`=imZCSon$`se`_<%@MB=M~KG+ z=EW^FL`w|Bo>*ktlaS^(fut!95`iG5u=SZ8nfDHO#GaTlH1-XG^;vsjUb^gWTVz0+ z^=WR1wv9-2oeR=_;fL0H7rNWqAzGtO(D;`~cX(RcN0w2v24Y8)6t`cS^_ghs`_ho? z{0ka~1Dgo8TfAP$r*ua?>$_V+kZ!-(TvEJ7O2f;Y#tezt$&R4 zLI}=-y@Z!grf*h3>}DUL{km4R>ya_I5Ag#{h_&?+HpKS!;$x3LC#CqUQ8&nM?X))Q zXAy2?`YL4FbC5CgJu(M&Q|>1st8XXLZ|5MgwgjP$m_2Vt0(J z&Gu7bOlkbGzGm2sh?X`){7w69Y$1#@P@7DF{ZE=4%T0NDS)iH`tiPSKpDNW)zmtn( zw;4$f>k)4$LBc>eBAaTZeCM2(iD+sHlj!qd z2GjRJ>f_Qes(+mnzdA^NH?^NB(^o-%Gmg$c8MNMq&`vm@9Ut;*&$xSD)PKH{wBCEC z4P9%NQ;n2s59ffMn8*5)5AAg4-93gBXBDX`A7S& zH-|%S3Wd%T79fk-e&l`{!?lve8_epXhE{d3Hn$Cg!t=-4D(t$cK~7f&4s?t7wr3ZP z*!SRQ-+tr|e1|hbc__J`k3S!rMy<0PHy&R`v#aJv?`Y?2{avK5sQz%=Us()jcNuZV z*$>auD4cEw>;t`+m>h?f?%VFJZj8D|Y1e_SjxG%J4{-AkFtT2+ZZS5UScS~%;dp!V>)7zi`w(xwSd*FS;Lml=f6hn#jq)2is4nkp+aTrV?)F6N z>DY#SU0IZ;*?Hu%tSj4edd~kYNHMFvS&5}#3-M;mBCOCZL3&;2obdG?qZ>rD|zC|Lu|sny76pn2xl|6sk~Hs{X9{8iBW zwiwgQt+@hi`FYMEhX2