Skip to content

Commit

Permalink
Update documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
JonRowe committed Mar 30, 2023
1 parent 6482e4f commit bd3564f
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 55 deletions.
5 changes: 2 additions & 3 deletions BUILD_DETAIL.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ DO NOT modify it by hand as your changes will get lost the next time it is gener

# The CI build, in detail

The [Travis CI build](https://travis-ci.org/rspec/rspec-rails)
runs many verification steps to prevent regressions and
The CI build runs many verification steps to prevent regressions and
ensure high-quality code. To run the Travis build locally, run:

```
Expand Down Expand Up @@ -50,7 +49,7 @@ project-specific threshold, the build will fail.
## Cukes

RSpec uses [cucumber](https://cucumber.io/) for both acceptance testing
and [documentation](https://relishapp.com/rspec). Since we publish our cukes
and [documentation](https://rspec.info/documentation). Since we publish our cukes
as documentation, please limit new cucumber scenarios to user-facing examples
that help demonstrate usage. Any tests that exist purely to prevent regressions
should be written as specs, even if they are written in an acceptance style.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you'd like to help make RSpec better, here are some ways you can contribute:
- by running RSpec HEAD to help us catch bugs before new releases
- by [reporting bugs you encounter](https://github.com/rspec/rspec-rails/issues/new?template=bug_report.md)
- by [suggesting new features](https://github.com/rspec/rspec-rails/issues/new?template=feature_request.md)
- by improving RSpec's [Relish](https://relishapp.com/rspec) or [API](https://rspec.info/documentation/) documentation
- by improving RSpec's [Gherkin](https://rspec.info/documentation/) or [API](https://rspec.info/documentation/) documentation
- by improving [RSpec's website](https://rspec.info/) ([source](https://github.com/rspec/rspec.github.io))
- by taking part in [feature and issue discussions](https://github.com/rspec/rspec-rails/issues)
- by adding a failing test for reproducible [reported bugs](https://github.com/rspec/rspec-rails/issues)
Expand Down
5 changes: 2 additions & 3 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,8 @@ gem declarations. The `Gemfile` evaluates that file if it exists, and it is git-

# Running the build

The [Travis CI build](https://travis-ci.org/rspec/rspec-rails)
runs many verification steps to prevent regressions and
ensure high-quality code. To run the Travis build locally, run:
The CI build runs many verification steps to prevent regressions and
ensure high-quality code. To run the build locally, run:

```
$ script/run_build
Expand Down
60 changes: 29 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ According to [RSpec Rails new versioning strategy][] use:
* **[`rspec-rails` 3.x][]** for Rails earlier than 5.0.
* **[`rspec-rails` 1.x][]** for Rails 2.x.

[Build Status]: https://secure.travis-ci.org/rspec/rspec-rails.svg?branch=main
[travis-ci]: https://travis-ci.org/rspec/rspec-rails
[Code Climate]: https://codeclimate.com/github/rspec/rspec-rails.svg
[code-climate]: https://codeclimate.com/github/rspec/rspec-rails
[Gem Version]: https://badge.fury.io/rb/rspec-rails.svg
Expand Down Expand Up @@ -88,8 +86,8 @@ read the [`rspec-rails` upgrade notes][] to find out what to watch out for.

Be sure to check the general [RSpec upgrade notes][] as well.

[`rspec-rails` upgrade notes]: https://www.relishapp.com/rspec/rspec-rails/docs/upgrade
[RSpec upgrade notes]: https://relishapp.com/rspec/docs/upgrade
[`rspec-rails` upgrade notes]: https://rspec.info/features/6-0/rspec-rails/upgrade
[RSpec upgrade notes]: https://rspec.info/upgrading-from-rspec-2/

## Usage

Expand Down Expand Up @@ -183,7 +181,7 @@ rspec ./spec/models/post_spec.rb:3 # Post before publication cannot have comment
For an in-depth look at the RSpec DSL, including lots of examples,
read the official Cucumber documentation for [RSpec Core][].
[RSpec Core]: https://relishapp.com/rspec/rspec-core/docs
[RSpec Core]: https://rspec.info/features/3-12/rspec-core
### Helpful Rails Matchers
Expand All @@ -209,23 +207,23 @@ to test the various parts of a Rails system:
Follow the links above for examples of how each matcher is used.
[the matchers that come standard in RSpec]: https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
[`be_a_new`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/be-a-new-matcher
[`render_template`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/render-template-matcher
[`redirect_to`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/redirect-to-matcher
[`route_to`]: https://relishapp.com/rspec/rspec-rails/docs/routing-specs/route-to-matcher
[`be_routable`]: https://relishapp.com/rspec/rspec-rails/docs/routing-specs/be-routable-matcher
[`have_http_status`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/have-http-status-matcher
[`match_array`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/activerecord-relation-match-array
[`have_been_enqueued`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/have-been-enqueued-matcher
[`have_enqueued_job`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/have-enqueued-job-matcher
[the matchers that come standard in RSpec]: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
[`be_a_new`]: https://rspec.info/features/6-0/rspec-rails/matchers/new-record-matcher
[`render_template`]: https://rspec.info/features/6-0/rspec-rails/matchers/render-template-matcher
[`redirect_to`]: https://rspec.info/features/6-0/rspec-rails/matchers/redirect-to-matcher
[`route_to`]: https://rspec.info/features/6-0/rspec-rails/routing-specs/route-to-matcher
[`be_routable`]: https://rspec.info/features/6-0/rspec-rails/routing-specs/be-routable-matcher
[`have_http_status`]: https://rspec.info/features/6-0/rspec-rails/matchers/have-http-status-matcher
[`match_array`]: https://rspec.info/features/6-0/rspec-rails/matchers/relation-match-array
[`have_been_enqueued`]: https://rspec.info/features/6-0/rspec-rails/matchers/have-been-enqueued-matcher
[`have_enqueued_job`]: https://rspec.info/features/6-0/rspec-rails/matchers/have-enqueued-job-matcher
### What else does RSpec Rails add?
For a comprehensive look at RSpec Rails’ features,
read the [official Cucumber documentation][].
[official Cucumber documentation]: https://relishapp.com/rspec/rspec-rails/docs
[official Cucumber documentation]: https://rspec.info/features/6-0/rspec-rails
## What tests should I write?
Expand Down Expand Up @@ -270,20 +268,20 @@ RSpec.describe User, type: :model do
...
```

[request]: https://relishapp.com/rspec/rspec-rails/docs/request-specs/request-spec
[feature]: https://www.relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec
[system]: https://relishapp.com/rspec/rspec-rails/docs/system-specs/system-spec
[model]: https://www.relishapp.com/rspec/rspec-rails/docs/model-specs
[controller]: https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs
[mailer]: https://relishapp.com/rspec/rspec-rails/docs/mailer-specs
[job]: https://relishapp.com/rspec/rspec-rails/docs/job-specs/job-spec
[view]: https://www.relishapp.com/rspec/rspec-rails/docs/view-specs/view-spec
[routing]: https://www.relishapp.com/rspec/rspec-rails/docs/routing-specs
[helper]: https://www.relishapp.com/rspec/rspec-rails/docs/helper-specs/helper-spec
[request]: https://rspec.info/features/6-0/rspec-rails/request-specs/request-spec
[feature]: https://rspec.info/features/6-0/rspec-rails/feature-specs/feature-spec
[system]: https://rspec.info/features/6-0/rspec-rails/system-specs/system-specs
[model]: https://rspec.info/features/6-0/rspec-rails/model-specs
[controller]: https://rspec.info/features/6-0/rspec-rails/controller-specs
[mailer]: https://rspec.info/features/6-0/rspec-rails/mailer-specs
[job]: https://rspec.info/features/6-0/rspec-rails/job-specs/job-spec
[view]: https://rspec.info/features/6-0/rspec-rails/view-specs/view-spec
[routing]: https://rspec.info/features/6-0/rspec-rails/routing-specs
[helper]: https://rspec.info/features/6-0/rspec-rails/helper-specs/helper-spec
[`ActionDispatch::IntegrationTest`]: https://api.rubyonrails.org/classes/ActionDispatch/IntegrationTest.html
[`ActionDispatch::SystemTestCase`]: https://api.rubyonrails.org/classes/ActionDispatch/SystemTestCase.html
[`ActionController::TestCase`]: https://api.rubyonrails.org/classes/ActionController/TestCase.html
[in the appropriate folder]: https://relishapp.com/rspec/rspec-rails/docs/directory-structure
[in the appropriate folder]: https://rspec.info/features/6-0/rspec-rails/directory-structure

### System specs, feature specs, request specs–what’s the difference?

Expand Down Expand Up @@ -366,10 +364,10 @@ you can run the specs and Cucumber features, or submit a pull request.

### RSpec base libraries

* <https://github.com/rspec/rspec>
* <https://github.com/rspec/rspec-core>
* <https://github.com/rspec/rspec-expectations>
* <https://github.com/rspec/rspec-mocks>
* https://github.com/rspec/rspec
* https://github.com/rspec/rspec-core
* https://github.com/rspec/rspec-expectations
* https://github.com/rspec/rspec-mocks

### Recommended third-party extensions

Expand Down
14 changes: 0 additions & 14 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -112,20 +112,6 @@ namespace :clobber do
end
end

desc "Push docs/cukes to relishapp using the relish-client-gem"
task :relish, :version do |_t, args|
raise "rake relish[VERSION]" unless args[:version]

sh "cp Changelog.md features/"
if `relish versions rspec/rspec-rails`.split.map(&:strip).include? args[:version]
puts "Version #{args[:version]} already exists"
else
sh "relish versions:add rspec/rspec-rails:#{args[:version]}"
end
sh "relish push rspec/rspec-rails:#{args[:version]}"
sh "rm features/Changelog.md"
end

namespace :no_active_record do
example_app_dir = './tmp/no_ar_example_app'

Expand Down
2 changes: 1 addition & 1 deletion features/upgrade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ RSpec Rails 4 is a major version under semantic versioning, it allowed us to cha

If you are using Rails 4.2 you can use RSpec Rails 4, but note that support for it is not maintained, we consider this a breaking change hence the version change, and you must be on Ruby 2.2 as a minimum.

If you are upgrading from an earlier version of RSpec Rails, please consult [the upgrading 2.x to 3.x guide](https://web.archive.org/web/20221206041517/https://relishapp.com/rspec/rspec-rails/v/3-9/docs/upgrade).
If you are upgrading from an earlier version of RSpec Rails, please consult [the upgrading 2.x to 3.x guide](https://web.archive.org/web/20220124160827/https://relishapp.com/rspec/rspec-rails/v/3-9/docs/upgrade).
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
# end
#
# The different available types are documented in the features, such as in
# https://relishapp.com/rspec/rspec-rails/docs
# https://rspec.info/features/6-0/rspec-rails
config.infer_spec_type_from_file_location!

# Filter lines from Rails gems in backtraces.
Expand Down
2 changes: 1 addition & 1 deletion rfcs/versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This RFC captures a proposal for RSpec Rails' new versioning strategy. Specifica

## Need

Currently, the RSpec Rails [build matrix](https://travis-ci.org/rspec/rspec-rails)
Currently, the RSpec Rails build matrix
has 63 entries. This permutes rubies since 1.8.7 and Rails versions since 3.0.
As of right now the full build takes over an hour to run, and this makes cycling
for PRs and quick iterative development very difficult.
Expand Down

0 comments on commit bd3564f

Please sign in to comment.