Jelajahi Sumber

Document how to work on the site

Kevin van Zonneveld 9 tahun lalu
induk
melakukan
a39f0c4f8b
3 mengubah file dengan 39 tambahan dan 37 penghapusan
  1. 15 23
      Makefile
  2. 24 2
      README.md
  3. 0 12
      website/README.md

+ 15 - 23
Makefile

@@ -2,36 +2,28 @@ SHELL          := /usr/bin/env bash
 ghpages_repo   := "transloadit/uppy"
 ghpages_branch := "gh-pages"
 
-.PHONY: all
-all: install build deploy
-
-.PHONY: install
-install:
-	@echo "--> Installing dependencies.."
-	cd website && npm install
-
-.PHONY: build-site
-build-site:
-	@echo "--> Building site.."
-	cd website && ./node_modules/.bin/hexo generate
-
-.PHONY: build
-build: build-site
-	@echo "--> Building all.."
-	@echo "Done :)"
-
 .PHONY: pull
 pull:
 	@echo "--> Running pull.."
 	@git pull
 
-.PHONY: preview
-preview: install build
+.PHONY: website-install
+website-install:
+	@echo "--> Installing dependencies.."
+	@cd website && npm install
+
+.PHONY: website-build
+website-build:
+	@echo "--> Building site.."
+	@cd website && ./node_modules/.bin/hexo generate
+
+.PHONY: website-preview
+website-preview: website-install website-build
 	@echo "--> Running preview.."
-	cd website && ./node_modules/.bin/hexo server
+	@cd website && ./node_modules/.bin/hexo server
 
-.PHONY: deploy
-deploy: pull build
+.PHONY: website-deploy
+website-deploy: pull website-build
 	@echo "--> Deploying to GitHub pages.."
 	@mkdir -p /tmp/deploy-$(ghpages_repo)
 

+ 24 - 2
README.md

@@ -17,7 +17,7 @@ A work in progress - nothing to see here.
 
 Check [open issues](https://github.com/transloadit/uppy/milestones/Minimum%20Viable%20Product) for our Minimum Viable Product. 
 
-## Local Development
+## Uppy Development
 
 First clone and install the project:
 
@@ -36,8 +36,30 @@ npm run preview
 This will `npm run build` the project into `./build`, and then serve that
 directory using a simple static http server.
 
+## Website Development
 
-## What does Travis do?
+We keep the [uppyjs.io](http://uppyjs.io) website in `./website` for now so it's very easy to keep docs & code in sync as we're still 
+iterating at high velocity.
+
+This site is built with [hexo](http://hexo.io/). And deployed onto GitHub pages (`gh-pages` branch is of the `uppy` repo is overrwitten at every deploy. Site content is written in Markdown format located in `./website/src`. Pull requests welcome!
+  
+The website is currently a clone of the [Vue.js](http://vuejs.org/) website - just so we can hit the ground rolling in terms of setting up Haxo etc. Obviously as soon as possible, we should start rolling out our own layout & content.
+
+For local previews on `localhost:4000` type:
+
+```bash
+make website-preview
+```
+
+To deploy your work type
+
+```bash
+make website-deploy
+```
+
+## FAQ
+
+### What does Travis do?
 
 Travis should:
 

+ 0 - 12
website/README.md

@@ -1,12 +0,0 @@
-# uppyjs.io
-
-This site is built with [hexo](http://hexo.io/). Site content is written in Markdown format located in `src`. Pull requests welcome!
-
-## Developing
-
-Start a dev server at `localhost:4000`:
-
-```
-$ npm install
-$ ./node_modules/.bin/hexo server
-```