Skip to content

Commit 2ebebff

Browse files
authored
Reword documentation instructions.
1 parent c1d1e24 commit 2ebebff

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

DEVELOPMENT.md

+21-16
Original file line numberDiff line numberDiff line change
@@ -130,20 +130,25 @@ $ bin/yard server --reload
130130

131131
Then navigate to `localhost:8808` to view the rendered docs.
132132

133-
### Publish the documentation
134-
135-
In other documented rspec gems, we use a rake command from rspec-dev
136-
to generate documentation to [rspec.info](https://rspec.info/).
137-
`rspec-rails` is no more synced with other gems in term of version
138-
since `rspec-rails` 4.
139-
If you want to publish updated documentation you need to git clone
140-
in the parent folder of rspec-rails the `rspec.github.io`
141-
repository. You also need from [source branch](https://github.com/rspec/rspec.github.io/tree/source)
142-
the gem that will be needed as yard plugin: [rspec-docs-template](https://github.com/rspec/rspec.github.io#install-rspec-docs-template-yard-plugin).
143-
144-
* `git clone https://github.com/rspec/rspec.github.io && cd rspec.github.io`
145-
* `git checkout source`
146-
* `gem build yard-rspec-docs-template.gemspec`
147-
* `cd ../rspec-rails`
148-
* `bundle exec rake "update_docs[4.0, 4-0-maintenance]`
133+
### Publishing the documentation
149134

135+
In the other documented rspec gems, we use a rake command in rspec-dev
136+
to generate documentation for [rspec.info](https://rspec.info/).
137+
As `rspec-rails` is no longer sync with the other gems in terms of versioning
138+
since `rspec-rails` 4, if you want to publish updated documentation you will
139+
need to run the rake task from this repository.
140+
141+
1) First clone the `rspec.github.io` repository into a sibling folder.
142+
`cd .. && git clone https://github.com/rspec/rspec.github.io && cd rspec.github.io`
143+
144+
2) Check out the [source branch](https://github.com/rspec/rspec.github.io/tree/source)
145+
`git checkout source`
146+
147+
3) Install the template gem that will be needed as yard plugin: [rspec-docs-template](https://github.com/rspec/rspec.github.io#install-rspec-docs-template-yard-plugin).
148+
`gem build yard-rspec-docs-template.gemspec`
149+
150+
4) Change back to the `rspec-rails` directory
151+
`cd ../rspec-rails`
152+
153+
5) Generate the docs for the version you want, ensuring you are on the appropriate (released) commit.
154+
`bundle exec rake "update_docs[4.0, 4-0-maintenance]`

0 commit comments

Comments
 (0)