cryptoeconomics-study / cryptoeconomics-study/website

Surge Publishing Guide

Open
#49 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
HTML
Stars
70
Forks
15
PR merge metrics
No merged PRs in 30d

Description

We are not publishing to [gh-pages via Docusaurus](https://docusaurus.io/docs/en/publishing). We are publishing via [surge.sh](https://surge.sh) because it allows us to more easily setup sub domains for the [forum](https://forum.cryptoeconomics.study/). The process to push updates to [cryptoeconomics.study](https://cryptoeconomics.study/) is as follows:

> ⚠️ Do not change the surge publishing parameters in `siteConfig.js`

## Working on the website
- `git clone` this repo
- do stuff in the `website` repo
- make sure that your changes build locally (`$ cd website && yarn`, then `yarn start`
- this should build the website locally and deploy it to localhost:3000 and open that up in your browser

> Note: this repo is called `website`, but there is _also_ a directory within this repo titled `website`. You need to be in the website directory within the website repo (`website/website`) in order to use yarn to run or build updates.

## Publishing the website
- when you're ready to publish, navigate to the `website` directory and run `yarn build`
- then navigate to the newly built repo (`website/build/cryptoeconomics-study`)
- install surge: `npm i -g surge`
- run `surge` in the directory of the most recent build: `surge`
- login to surge (must be a Gerbil with admin access)
- the default will be to publish the current directory: hit `enter` to accept
- for the domain delete whatever surge recommends and enter `cryptoeconomics.study`
- wait for it to do it's thing, then go to cryptoeconomics.study to see the results (should be almost instant after surge finishes)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the documentation file for the website publishing process; the issue does not name one. Review siteConfig.js and the existing website directory structure, then verify that the guide accurately reflects the yarn build and surge publishing steps. Done means the Surge-based process is documented without changing the publishing parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.