Add some docs info #3114
Merged
Add some docs info #3114
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
assigned 
stefannibrasil
force-pushed
the
some-documentation-improvement
branch
from
2d6b84e to
4d5b4e4
Compare
Generated by 🚫 Danger |
jywarren
reviewed
Jul 23, 2018
doc/TESTING.md
Outdated
|
|
||
| ## Solr tests | ||
|
|
||
| Solr (search) tests (generally not recommended!) require [installing the Solr search engine](#solr-search-engine) (see above). Once you've done that, you still need to turn it off in development mode before running tests, with `rake sunspot:solr:stop`. Read more about [this issue here](https://github.com/publiclab/plots2/issues/832#issuecomment-249695309). | ||
| Solr (search) tests (generally not recommended!) require [installing the Solr search engine](#solr-search-engine) (see above). Once you've done that, you still need to turn it off in development mode before running tests, with `rake sunspot:solr:stop`. Read more about [this issue here](https://github.com/publiclab/plots2/issues/832#issuecomment-249695309). |
There was a problem hiding this comment.
We can remove this whole section on Solr - as we've stopped using it! Thank you!!!!
jywarren
reviewed
Jul 23, 2018
doc/TESTING.md
Outdated
| @@ -60,10 +60,18 @@ And to run just a single test within a file: | |||
|
|
|||
| `ruby -I test test/functional/some_file.rb --name=name_of_test` | |||
|
|
|||
| ### Testing mails in development envirmoment | |||
| ### Testing mails in development environment | |||
jywarren
reviewed
Jul 23, 2018
| Same links would work, no modification in links are required. | ||
| It will also show us how our actual mail will look like. | ||
| Mail will be same as actual mail we will get in production. | ||
|
|
||
| ## Testing branches |
jywarren
reviewed
Jul 23, 2018
doc/TESTING.md
Outdated
| a stable and an unstable. Those last two are used to test new code before sending | ||
| them to production. | ||
| If you need to use the stable or the unstable branch, | ||
| please ask if someone else is already using it. |
There was a problem hiding this comment.
...in the chatroom (https://publiclab.org/chat) would be great!
stefannibrasil
force-pushed
the
some-documentation-improvement
branch
from
4d5b4e4 to
23b69d1
Compare
|
hi @jywarren thanks for the tips, I updated the files with them just now :) |
|
hi @jywarren do you think there s still something to add here? :) |
5 tasks
|
OK! Merging!!! Glad that testing bug got fixed! 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3115
@publiclab/reviewers could you give me more tips to add to those docs?
When @milaaraujo and I were reading and studying the code a few weeks ago, we found some space for improvement. Would appreciate if you could give more tips here. For example, we don't know exactly how to explain more about the stable and unstable branches and how to use them.
Thanks!
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
rake test@publiclab/reviewersfor help, in a comment belowIf tests do fail, click on the red
Xto learn why by reading the logs.Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software
We have a loose schedule of reviewing and pulling in changes every Tuesday and Friday, and publishing changes on Fridays.
Thanks!