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

Fix mistakes or add clarification in tutorial #29

Open
amitaibu opened this issue Nov 23, 2015 · 3 comments
Open

Fix mistakes or add clarification in tutorial #29

amitaibu opened this issue Nov 23, 2015 · 3 comments
Assignees

Comments

@amitaibu
Copy link
Member

Some great suggestions from @dokumori:

Page URL: http://shoov.io/tutorials/lesson1-install/

Problem: Installation of shoov-webdrivercss failed on OSX 10.11.1 even with 'sudo'. The component had to be installed separately by running 'sudo npm install --save shoov-webdrivercss'

Problem: the tutorial assumes that one has nodejs installed on her/his machine already.
Suggestion: Add a brief description that nodejs is required: https://nodejs.org/en/download/

Problem: The following description is unclear

'5. Get the ~/.shoov.json file by following the copy/ pasting the code in your terminal. This file holds your Shoov access token, and the BrowserStack credentials which will be automatically picked up when doing visual monitoring'


Page URL: http://shoov.io/tutorials/lesson3-static-page/

Problem: at the top it says "we just need to adapt the following piece of code", but it is not clear where the code is stored.
Suggestion: make the filepath explicit in the documentation

Problem: The code shown on the page is not identical to what is in the directory

Example on the website: it('should show the static page',function(done) {

The actual code: it('should show the home page',function(done) {

Suggestion: update the code on the page

@amitaibu amitaibu self-assigned this Nov 23, 2015
@ordavidil
Copy link

@amitaibu
There is also a broken link on http://shoov.io/tutorials/lesson3-static-page/

lesson_3_-_first_baseline_image_ _shoov_io

@amitaibu
Copy link
Member Author

@ordavidil can you create a PR please for the broken link.

@ordavidil
Copy link

Sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants