Update Quick Start docs #296
Conversation
docs/yourbase-ruby.md
Outdated
| YOURBASE_DOWNLOAD_TOKEN=<enter token> | ||
| bundle add yourbase-rspec --git "https://$YOURBASE_DOWNLOAD_TOKEN:[email protected]/yourbase/yourbase-rspec-skipper-engine.git" | ||
|
|
||
| bundle install |
There was a problem hiding this comment.
I recommend following the advice in https://www.vidarholen.net/contents/blog/?p=958:
| YOURBASE_DOWNLOAD_TOKEN=<enter token> | |
| bundle add yourbase-rspec --git "https://$YOURBASE_DOWNLOAD_TOKEN:x-oauth-basic@github.com/yourbase/yourbase-rspec-skipper-engine.git" | |
| bundle install | |
| bundle add yourbase-rspec --git "https://${YOURBASE_DOWNLOAD_TOKEN?}:x-oauth-basic@github.com/yourbase/yourbase-rspec-skipper-engine.git" && | |
| bundle install |
There was a problem hiding this comment.
I like this! Very clear.
docs/yourbase-ruby.md
Outdated
| 1 examples, 0 failures, 1 skipped with YourBase🚀 | ||
| ``` | ||
|
|
||
| To get additional details, please use -f, --formatter [p]rogress | [d]ocumentation] |
There was a problem hiding this comment.
This seems like it's supposed to include a documentation link?
| ``` | ||
|
|
||
| Run your tests with the same command you typically use. You should see a rocket ship at the beginning the RSpec test section. | ||
|
|
There was a problem hiding this comment.
We should have a section about Spring here, because it's the most common reason they won't see the rocketship.
Right now, they need to run spring stop from the command line to turn it off, but it would be better if we could figure out if manually requiring yourbase-rspec at the top of the spec_helper.rb gets around the incompatibility, so that we could tell them to do that instead of having to stop Spring. Stopping Spring is definitely fine in the CI but is a little kludgier for local dev where Spring does actual useful things, including shorten the spin-up time for "loading the rails environment" for specs.
There was a problem hiding this comment.
Ok. Have this in my notes but wanted to try it out first. Will add it.
There was a problem hiding this comment.
I think for now it is sufficient to say that if you do not see the rocketship but ARE running Spring, that it should be turned off to accelerate the tests.
|
Thx for the feedback @clausti! |
|
For the email, I added "[email protected]". We also have "[email protected]". I was torn between the two. Happy to discuss. |
docs/yourbase-ruby.md
Outdated
| 1. Add `gem 'yourbase-rspec', '~> 0.5.6',` to your Gemfile. If you have a `:test` group, add it there. | ||
| 2. `bundle install` from the command line. | ||
| 3. If you are not in a Rails project, you will also need to `require 'yourbase-rspec` your spec_helper (or at the top of the spec file you want to run). | ||
|
|
||
| Once you have a token, simply follow the steps below: | ||
| ```sh | ||
| bundle add yourbase-rspec --git "https://${YOURBASE_DOWNLOAD_TOKEN?}:[email protected]/yourbase/yourbase-rspec-skipper-engine.git" && bundle install | ||
| ``` |
There was a problem hiding this comment.
sorry if I missed this in the first pass, but I think the 1,2,3 and the sh section below it assume different things about the the public/privateness of the repo.
If we're going to publish this today-ish for Gusto purposes, we should make step 1. include the token syntax,
gem 'yourbase-rspec', '~> 0.6.0, git: "https://yourbase-tokenbot:#{ENV.fetch(YOURBASE_DOWNLOAD_TOKEN){nil}}@github.com/yourbase/yourbase-rspec-skipper-engine", branch: 'main', and then lines 14-16 are redundant and can be removed.
There was a problem hiding this comment.
Agreed! Missed this as well. I think we should tune this for our launch which I believe means removing the "token" section. I'll update based on this assumption. We can always add it back.
Co-authored-by: Christina Austin <[email protected]>
Here is the first draft. There are a couple of things (like the token request) that I expect to change.
Expected changes: