Skip to content

Commit c896752

Browse files
committed
Document buildkite/docs-preview pipeline
1 parent 90b3f57 commit c896752

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed
9.47 KB
Loading
44.2 KB
Loading

guides/source/contributing_to_ruby_on_rails.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,17 @@ learn about Ruby on Rails, and the API, which serves as a reference.
138138
You can help improve the Rails guides or the API reference by making them more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest edge Rails.
139139

140140
To do so, make changes to Rails guides source files (located [here](https://github.com/rails/rails/tree/main/guides/source) on GitHub) or RDoc comments in source code. Then open a pull request to apply your changes to the main branch.
141+
141142
Use `[ci skip]` in your pull request title to avoid running the CI build for documentation changes.
142143

144+
Once you open a PR, a preview of the documentation will be deployed for easy review and collaboration. At the bottom of the Pull Request page, you should see a list of status checks, look for the `buildkite/docs-preview` and click "details".
145+
146+
![GitHub rails/rails Pull Request status checks](images/docs_preview/status_checks.png)
147+
148+
This will bring you to the Buildkite build page, if the job was successful there will be an annotation with links to the generated API and Guides above the job list.
149+
150+
![Buildkite rails/docs-preview annotation API & Guides links](images/docs_preview/annotation.png)
151+
143152
When working with documentation, please take into account the [API Documentation Guidelines](api_documentation_guidelines.html) and the [Ruby on Rails Guides Guidelines](ruby_on_rails_guides_guidelines.html).
144153

145154
Translating Rails Guides

0 commit comments

Comments
 (0)