Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add instructions how to run the binary by itself, close #1781 #1783

Merged
merged 4 commits into from Jun 19, 2019

Conversation

2 participants
@bahmutov
Copy link
Collaborator

commented Jun 17, 2019

Changes made to documentation were also copied over to other languages (copying English text is ok).

  • only English docs
  • Japanese docs in /source/ja.
  • Chinese docs in /source/zh-cn.
  • Not applicable (this is not a change to an en doc content).

@bahmutov bahmutov requested a review from jennifer-shehane Jun 17, 2019

Rearrange some of the debugging areas - create new 'Hacking on Cypres…
…s' section

- Add intro to hacking on Cypress
- Add an area about ‘Contributing’
@jennifer-shehane

This comment has been minimized.

Copy link
Member

commented Jun 18, 2019

Had our Cypress not start on one of our test runs :(


[15:25:55]  Verifying Cypress can run /root/.cache/Cypress/3.3.1/Cypress [started]
[15:25:55]  Verifying Cypress can run /root/.cache/Cypress/3.3.1/Cypress [failed]
Cypress failed to start.

This is usually caused by a missing library or dependency.

The error below should indicate which dependency is missing.

https://on.cypress.io/required-dependencies

If you are using Docker, we provide containers with all required dependencies installed.

----------

Command failed: /root/.cache/Cypress/3.3.1/Cypress/Cypress --smoke-test --ping=729

----------

Platform: linux (Debian - 9.9)
Cypress Version: 3.3.1
@jennifer-shehane
Copy link
Member

left a comment

I updated the debugging to move your 2 most recent sections into a 'Hacking on Cypress' header - this separates it from the more common debugging needed to fix/log issues with Cypress.

The main question I'm left with for both 'Run the Cypress app by itself' and 'Edit the installed Cypress code' is, why would I want to do this?

A good start for copy for these section could be...

You may want to run the Cypress app without the CLI module. Some common situtations on why you would want to do this are:

  1. reason
  2. reason
    ...

Can you add this to the intro for these sections?

@bahmutov

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 18, 2019

Done @jennifer-shehane I hope you find these reasons meaningful

@jennifer-shehane jennifer-shehane self-requested a review Jun 19, 2019

@jennifer-shehane jennifer-shehane merged commit ab7a92a into develop Jun 19, 2019

3 checks passed

ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: docs-tests Your tests passed on CircleCI!
Details
license/cla Contributor License Agreement is signed.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.