فهرست منبع

Move content out of the README.md -> into the open (website)

Kevin van Zonneveld 9 سال پیش
والد
کامیت
f697e630d8
3فایلهای تغییر یافته به همراه57 افزوده شده و 57 حذف شده
  1. 0 57
      README.md
  2. 37 0
      website/src/guide/contributing.md
  3. 20 0
      website/src/guide/faq.md

+ 0 - 57
README.md

@@ -7,60 +7,3 @@ Interesting places if you want to dig in:
  - Architecture in [`website/src/api/index.md`](website/src/api/index.md)
  - Contributor's guide in [`website/src/guide/contributing.md`](src/guide/contributing.md)
  - [Open issues](https://github.com/transloadit/uppy/milestones/Minimum%20Viable%20Product) before having a Minimum Valuable Product. 
-
-## Uppy Development
-
-First clone and install the project:
-
-```bash
-git clone git@github.com:transloadit/uppy.git
-cd uppy
-npm install
-```
-
-Our website's examples section is also our playground. To get it to run locally type:
-
-```bash
-make web-preview
-```
-
-## Website Development
-
-We keep the [uppyjs.io](http://uppyjs.io) website in `./website` for so it's easy to keep docs & code in sync as we're still iterating at high velocity. For those reading this screaming murder, [HashiCorp does this](https://github.com/hashicorp/terraform/tree/master/website) for all their projects, and it's working well for them on a scale vastly more impressive than :dog:'s.
-
-The site is built with [Hexo](http://hexo.io/), and Travis automatically deploys this onto GitHub Pages (it overwrites the [`gh-pages`](https://github.com/transloadit/uppy/tree/gh-pages) branch with Hexo's build at every change to `master`). The content is written in Markdown and located in [`./website/src`](website/src). Feel free to fork & hack!  
-
-Even though bundled in this repo, the website is regarded as a separate project. So it has its own `package.json` and we aim keep the surface where the two projects interface as small as possible. [`./website/update.js`](website/update.js) is called during website builds to inject the Uppy knowledge into the site.
-
-### Getting started
-
-It's recommended to exclude `./website/public/` from your editor if you want efficient searches.
-
-For local previews on http://127.0.0.1:4000 type:
-
-```bash
-make web-preview
-```
-
-This will start Hexo and rebuilds the site as you save. If you also want to work on examples / Uppy itself you then open a second tab in which you type:
-
-```bash
-make watch
-```
-
-## FAQ
-
-### Why does your site look like vuejs.org?
-
-The website is currently a clone of Yuxi Evan You's wonderful [Vue.js](http://vuejs.org/) website ([view license](website/VUEORG_LICENSE)) - just so we can hit the ground running in terms of Haxo boilerplate, etc. Obviously as soon as possible, we'll start rolling out our own layout & content and make this place our own. We'll keep the Vue website MIT license & credit in the footer in tact of course.
-
-### What does Travis do?
-
-Travis should:
-
-- [x] check out code 
-- [x] build project
-- [ ] run unit tests
-- [ ] run acceptance tests
-- [x] copy/install the built project into any `examples/*/`
-- [x] deploy the examples to our hackathon S3 bucket in a folder named by branch (http://hackathon.transloadit.com/uppy/master/index.html), so we can all play with the current state of the project & examples per branch, without installing everything locally.

+ 37 - 0
website/src/guide/contributing.md

@@ -4,6 +4,18 @@ order: 20
 title: "Contributing Guidelines"
 ---
 
+## Uppy Development
+
+First clone and install the project:
+
+```bash
+git clone git@github.com:transloadit/uppy.git
+cd uppy
+npm install
+```
+
+Our website's examples section is also our playground, read "Website Development"'s "Getting Started" section to get up and running.
+
 ## CSS Guidelines
 
 The CSS standards followed in this project closely resemble those from [Medium's CSS Guidelines](https://gist.github.com/fat/a47b882eb5f84293c4ed). If it's not mentioned here, follow their guidelines.
@@ -106,3 +118,28 @@ h1 {
   width: 940px;
 }
 ```
+
+
+## Website Development
+
+We keep the [uppyjs.io](http://uppyjs.io) website in `./website` for so it's easy to keep docs & code in sync as we're still iterating at high velocity. For those reading this screaming murder, [HashiCorp does this](https://github.com/hashicorp/terraform/tree/master/website) for all their projects, and it's working well for them on a scale vastly more impressive than Uppy's.
+
+The site is built with [Hexo](http://hexo.io/), and Travis automatically deploys this onto GitHub Pages (it overwrites the `gh-pages` branch with Hexo's build at every change to `master`). The content is written in Markdown and located in `./website/src`. Feel free to fork & hack!  
+
+Even though bundled in this repo, the website is regarded as a separate project. So it has its own `package.json` and we aim keep the surface where the two projects interface as small as possible. `./website/update.js` is called during website builds to inject the Uppy knowledge into the site.
+
+### Getting Started
+
+It's recommended to exclude `./website/public/` from your editor if you want efficient searches.
+
+For local previews on http://127.0.0.1:4000 type:
+
+```bash
+make web-preview
+```
+
+This will start Hexo and rebuilds the site as you save. If you also want to work on examples / Uppy itself you then open a second tab in which you type:
+
+```bash
+make watch
+```

+ 20 - 0
website/src/guide/faq.md

@@ -0,0 +1,20 @@
+---
+type: guide
+order: 21
+title: "FAQ"
+---
+
+## Why does your site look like vuejs.org?
+
+The website is currently a clone of Yuxi Evan You's wonderful [Vue.js](http://vuejs.org/) website ([view license](website/VUEORG_LICENSE)) - just so we can hit the ground running in terms of Haxo boilerplate, etc. Obviously as soon as possible, we'll start rolling out our own layout & content and make this place our own. We'll keep the Vue website MIT license & credit in the footer in tact of course.
+
+## What does Travis do?
+
+Travis should:
+
+- [x] check out code 
+- [x] build project
+- [ ] run unit tests
+- [ ] run acceptance tests
+- [x] copy/install the built project into any `examples/*/`
+- [x] deploy the examples to our hackathon S3 bucket in a folder named by branch (http://hackathon.transloadit.com/uppy/master/index.html), so we can all play with the current state of the project & examples per branch, without installing everything locally.