From 1a2298ffb5dfe2a6ff0a93678343f9ebe5c182e3 Mon Sep 17 00:00:00 2001 From: Gleb Bahmutov Date: Tue, 5 Sep 2017 16:19:15 -0400 Subject: [PATCH] start develop branch --- index.js | 7 +++++++ readme.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 readme.md diff --git a/index.js b/index.js index f713aa8de6..75713dbf2c 100644 --- a/index.js +++ b/index.js @@ -1 +1,8 @@ +process.on('unhandledRejection', function (reason, p) { + /* eslint-disable no-console */ + console.error('Unhandled Rejection at: Promise ', p) + console.error('reason: ', reason) + process.exit(-1) +}); + require('hexo-cli')(); diff --git a/readme.md b/readme.md new file mode 100644 index 0000000000..81fbed5c55 --- /dev/null +++ b/readme.md @@ -0,0 +1,63 @@ +# Cypress Documentation + +The code for Cypress' Documentation including Guides, API, Examples, Dashboard & FAQ. + +* https://docs.cypress.io + +## Contributing + +Please see our [Documentation Contributing Guideline](/CONTRIBUTING.md) + +### Installing Dependencies + +```shell +npm install + +npm run build +``` + +### Starting the server + +```shell +npm start +``` + +Visit [http://localhost:2222/](http://localhost:2222/) + +### Writing Docs + +#### Links + +Links are all handled through our [cypress.on](https://github.com/cypress-io/cypress-on) api. + +Link all pages but their name (property key) in `source/_data/sidebar.yml` + +- https://on.cypress.io/NAME_OF_PAGE +- https://on.cypress.io/and +- https://on.cypress.io/visit +- https://on.cypress.io/unit-testing-recipe +- https://on.cypress.io/introduction-to-cypress +- https://on.cypress.io/writing-your-first-test +- https://on.cypress.io/general-questions-faq + +### Linting + +Danger 📛: because we are minifying client side code using Hexo plugin which in turn calls +`uglify`, the code should be strictly ES5. Thus everything inside the `theme` should +be linted with ES5 settings and not upgraded to ES6. + +### Deploying + +#### Preferred: deploy from CI + +Look at `circle.yml` file in the root of the repo. It should have +`deploy-docs-staging` and `deploy-docs-production` jobs, which only are triggered for right +branch and only after tests pass. + +#### Should not be required: manual deploy + +```shell +npm run deploy +``` + +Look at scripts in `cy_scripts` folder for deployment steps.