Skip to content

Commit

Permalink
start develop branch
Browse files Browse the repository at this point in the history
  • Loading branch information
bahmutov committed Sep 5, 2017
1 parent 3406c3f commit 1a2298f
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
7 changes: 7 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -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')();
63 changes: 63 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 1a2298f

Please sign in to comment.