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

document download server's API in installation docs #218

Closed
jennifer-shehane opened this issue Nov 3, 2017 · 0 comments · Fixed by #221
Closed

document download server's API in installation docs #218

jennifer-shehane opened this issue Nov 3, 2017 · 0 comments · Fixed by #221

Comments

@jennifer-shehane
Copy link
Member

jennifer-shehane commented Nov 3, 2017

cypress-io/cypress#866 (comment)

These are all accessed on host: https://download.cypress.io

Desktop App Routes

GET /desktop                   ## downloads latest desktop app
GET /desktop?platform=p        ## downloads latest desktop app for specific platform
GET /desktop.json              ## returns desktop manifest.json
GET /desktop/:version          ## downloads desktop app by version
GET /desktop/:version?platform=p    ## downloads desktop app by version for specific os

You don't need to provide platform as Cypress will automatically figure that out. It also supports an arch query param but that's not useful until we build 32 and 64 bit binaries.

MarcLoupias added a commit to MarcLoupias/cypress-documentation that referenced this issue Nov 4, 2017
closes cypress-io#200, closes cypress-io#218 and closes cypress-io/cypress#866

* npm install section clarification

- what is the npm package
- best practice highlighted

* direct download section precisions

- what is exactly downloaded as the user didn't knew it exactly

* new CDN Structure section

- CDN url pattern
- it give to the user enough informations to download Cypress in the wanted
version for the wanted platform (could download a linux Cypress version from
a windows workstation)
- example

* Advanced section

- warning added about CLI output when running cypress
MarcLoupias added a commit to MarcLoupias/cypress-documentation that referenced this issue Nov 4, 2017
closes cypress-io#200, closes cypress-io#218 and closes cypress-io/cypress#866

* npm install section clarification

- what is the npm package
- best practice highlighted

* direct download section precisions

- what is exactly downloaded as the user didn't knew it exactly

* new CDN Structure section

- CDN url pattern
- it give to the user enough informations to download Cypress in the wanted
version for the wanted platform (could download a linux Cypress version from
a windows workstation)
- example

* Advanced section

- warning added about CLI output when running cypress
jennifer-shehane pushed a commit that referenced this issue Nov 6, 2017
* Installing Cypress  guide improvment

closes #200, closes #218 and closes cypress-io/cypress#866

* npm install section clarification

- what is the npm package
- best practice highlighted

* direct download section precisions

- what is exactly downloaded as the user didn't knew it exactly

* new CDN Structure section

- CDN url pattern
- it give to the user enough informations to download Cypress in the wanted
version for the wanted platform (could download a linux Cypress version from
a windows workstation)
- example

* Advanced section

- warning added about CLI output when running cypress

* updates to new advanced instructions

- Some wording changes
- Moved CDN section into section called ‘Hosting’ within the Advanced
install instructions.
- Added the download table (we only want to expose our
download.cypress.io endpoint, not the cdn directly)
- update platforms to correct os names.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant