Document how we generate documentation to rspec.github.io #2306
Conversation
This file contains hidden or 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
benoittgt
commented
Mar 30, 2020
| to [`rspec.github.io`](https://github.com/rspec/rspec.github.io) you | ||
| need to git clone in the parent folder of rspec-rails the `rspec.github.io` | ||
| repository. You also need from [source branch](https://github.com/rspec/rspec.github.io/tree/source) | ||
| 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). |
Member
Author
There was a problem hiding this comment.
Maybe the commands are not needed. We just need to refer to other repo?
pirj
approved these changes
Mar 30, 2020
Member
pirj
left a comment
pirj
left a comment
There was a problem hiding this comment.
Looks good. Might need some proofreading, but that's not a user-facing doc, so would do as is.
DEVELOPMENT.md
Outdated
|
|
||
| Then navigate to `localhost:8808` to view the rendered docs. | ||
|
|
||
| ### Publish documentation to rspec.github.io |
Member
There was a problem hiding this comment.
Does it make sense to mention that rspec.github.io is the same as rspec.info?
Member
Author
There was a problem hiding this comment.
| to [`rspec.github.io`](https://github.com/rspec/rspec.github.io) you | ||
| need to git clone in the parent folder of rspec-rails the `rspec.github.io` | ||
| repository. You also need from [source branch](https://github.com/rspec/rspec.github.io/tree/source) | ||
| 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). |
benoittgt
force-pushed
the
add-info-about-generating-documentation
branch
from
d48db33 to
56f6c59
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Dependent: