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

Refactor documentation #456

Merged
merged 10 commits into from
Jul 20, 2017
Merged

Refactor documentation #456

merged 10 commits into from
Jul 20, 2017

Conversation

maxmeyer
Copy link
Member

Summary

This fixes based on this comment by @mvz. Additionally it does some minor refactorings to the README

Details

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactoring (cleanup of codebase withouth changing any existing functionality)

Checklist:

  • I've added tests for my code
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@maxmeyer maxmeyer changed the title Refactor documentation [ci skip] Refactor documentation Jul 16, 2017
### Your First Tests with "aruba"

1. Clone the "Getting Started" application and install its dependencies
2. Install the required depencies
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo depencies => dependencies


1. Create a file named "spec/spec_helper.rb" with the following content. If the
file already exists add the line to the file.
1. Add the following line to the "spec/spec_helper.rb"-file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the hyphenation in the last word. -file => file


1. Add a file named "test/test_helper.rb" with:
1. Add the following line to the "test/test_helper.rb"-file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an extra - to remove here, as well.


1. Go to your project's directory

2. Make sure, it's under version control and all changes are committed to your
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure, it's => Make sure it's

@olleolleolle
Copy link
Contributor

Cool change!

I read the text and made tiny notes where I found things that can change.

@maxmeyer
Copy link
Member Author

@olleolleolle Fixed. Did you use the review for your comments?

@olleolleolle
Copy link
Contributor

@maxmeyer No, I thought I was only adding "loose commentary" so I made Single Comments of each.

olleolleolle
olleolleolle previously approved these changes Jul 16, 2017
Copy link
Contributor

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Several issues fixed.

Using the Getting Started conventional wording helps the reader who is scanning the text quickly.

Good change!


1. Add a file named "test/test_helper.rb" with:
1. Add the following line to the "test/test_helper.rb" file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think test/test_helper.rb exists in the sample repo, does it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I forgot to push that commit. Shall be now online.

@mvz
Copy link
Contributor

mvz commented Jul 17, 2017

I'll try out the instructions as per this PR again tonight.

@maxmeyer maxmeyer merged commit e26161f into master Jul 20, 2017
@maxmeyer maxmeyer changed the title [ci skip] Refactor documentation Refactor documentation Jul 26, 2017
@maxmeyer maxmeyer added this to the 1.0.0-alpha.3 milestone Jul 26, 2017
@mvz mvz deleted the feature/refactor-documentation branch November 7, 2017 08:29
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

Successfully merging this pull request may close these issues.

3 participants