Skip to content

Commit 18ee206

Browse files
committed
Fix title capitalization in guides according to guidelines [ci skip]
According to the guide guidelines, all words except for prepositions, conjunctions, internal articles, and forms of the verb "to be" should be capitalized. This commit fixes some titles.
1 parent d2ae2c3 commit 18ee206

File tree

10 files changed

+32
-32
lines changed

10 files changed

+32
-32
lines changed

guides/source/configuring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1212,7 +1212,7 @@ Imagine you have a server which mirrors the production environment but is only u
12121212
That environment is no different than the default ones, start a server with `rails server -e staging`, a console with `rails console -e staging`, `Rails.env.staging?` works, etc.
12131213
12141214
1215-
### Deploy to a subdirectory (relative URL root)
1215+
### Deploy to a Subdirectory (relative URL root)
12161216
12171217
By default Rails expects that your application is running at the root
12181218
(e.g. `/`). This section explains how to run your application inside a directory.

guides/source/contributing_to_ruby_on_rails.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ $ bundle exec ruby -w -Itest test/mail_layout_test.rb -n test_explicit_class_lay
356356

357357
The `-n` option allows you to run a single method instead of the whole file.
358358

359-
#### Running tests with a specific seed
359+
#### Running Tests with a Specific Seed
360360

361361
Test execution is randomized with a randomization seed. If you are experiencing random
362362
test failures you can more accurately reproduce a failing test scenario by specifically
@@ -609,7 +609,7 @@ the same way that you appreciate feedback on your patches.
609609

610610
It's entirely possible that the feedback you get will suggest changes. Don't get discouraged: the whole point of contributing to an active open source project is to tap into the knowledge of the community. If people are encouraging you to tweak your code, then it's worth making the tweaks and resubmitting. If the feedback is that your code doesn't belong in the core, you might still think about releasing it as a gem.
611611

612-
#### Squashing commits
612+
#### Squashing Commits
613613

614614
One of the things that we may ask you to do is to "squash your commits", which
615615
will combine all of your commits into a single commit. We prefer pull requests
@@ -632,7 +632,7 @@ $ git push fork my_new_branch --force-with-lease
632632
You should be able to refresh the pull request on GitHub and see that it has
633633
been updated.
634634

635-
#### Updating a pull request
635+
#### Updating a Pull Request
636636

637637
Sometimes you will be asked to make some changes to the code you have
638638
already committed. This can include amending existing commits. In this

guides/source/debugging_rails_applications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -956,7 +956,7 @@ For further information on how to install Valgrind and use with Ruby, refer to
956956
[Valgrind and Ruby](https://blog.evanweaver.com/2008/02/05/valgrind-and-ruby/)
957957
by Evan Weaver.
958958

959-
### Find a memory leak
959+
### Find a Memory Leak
960960
There is an excellent article about detecting and fixing memory leaks at Derailed, [which you can read here](https://github.com/schneems/derailed_benchmarks#is-my-app-leaking-memory).
961961

962962

guides/source/engines.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ After reading this guide, you will know:
1818

1919
--------------------------------------------------------------------------------
2020

21-
What are engines?
21+
What are Engines?
2222
-----------------
2323

2424
Engines can be considered miniature applications that provide functionality to
@@ -69,7 +69,7 @@ Finally, engines would not have been possible without the work of James Adam,
6969
Piotr Sarnacki, the Rails Core Team, and a number of other people. If you ever
7070
meet them, don't forget to say thanks!
7171

72-
Generating an engine
72+
Generating an Engine
7373
--------------------
7474

7575
To generate an engine, you will need to run the plugin generator and pass it
@@ -328,7 +328,7 @@ integration tests for the engine should be placed. Other directories can be
328328
created in the `test` directory as well. For example, you may wish to create a
329329
`test/models` directory for your model tests.
330330
331-
Providing engine functionality
331+
Providing Engine Functionality
332332
------------------------------
333333
334334
The engine that this guide covers provides submitting articles and commenting
@@ -707,7 +707,7 @@ you specify custom helpers (such as `devise_for`) in the routes. These helpers
707707
do exactly the same thing, mounting pieces of the engines's functionality at a
708708
pre-defined path which may be customizable.
709709

710-
### Engine setup
710+
### Engine Setup
711711

712712
The engine contains migrations for the `blorgh_articles` and `blorgh_comments`
713713
table which need to be created in the application's database so that the
@@ -1031,7 +1031,7 @@ application. The same thing goes if you want to use a standard initializer.
10311031
For locales, simply place the locale files in the `config/locales` directory,
10321032
just like you would in an application.
10331033

1034-
Testing an engine
1034+
Testing an Engine
10351035
-----------------
10361036

10371037
When an engine is generated, there is a smaller dummy application created inside
@@ -1094,7 +1094,7 @@ there, rather than the application's one.
10941094
This also ensures that the engine's URL helpers will work as expected in your
10951095
tests.
10961096

1097-
Improving engine functionality
1097+
Improving Engine Functionality
10981098
------------------------------
10991099

11001100
This section explains how to add and/or override engine MVC functionality in the

guides/source/getting_started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ create and read. The form for doing this will look like this:
389389
It will look a little basic for now, but that's ok. We'll look at improving the
390390
styling for it afterwards.
391391

392-
### Laying down the groundwork
392+
### Laying down the Groundwork
393393

394394
Firstly, you need a place within the application to create a new article. A
395395
great place for that would be at `/articles/new`. With the route already
@@ -591,7 +591,7 @@ NOTE: By default `form_with` submits forms using Ajax thereby skipping full page
591591
redirects. To make this guide easier to get into we've disabled that with
592592
`local: true` for now.
593593

594-
### Creating articles
594+
### Creating Articles
595595

596596
To make the "Unknown action" go away, you can define a `create` action within
597597
the `ArticlesController` class in `app/controllers/articles_controller.rb`,
@@ -643,7 +643,7 @@ This action is now displaying the parameters for the article that are coming in
643643
from the form. However, this isn't really all that helpful. Yes, you can see the
644644
parameters but nothing in particular is being done with them.
645645

646-
### Creating the Article model
646+
### Creating the Article Model
647647

648648
Models in Rails use a singular name, and their corresponding database tables
649649
use a plural name. Rails provides a generator for creating models, which most
@@ -725,7 +725,7 @@ command will apply to the database defined in the `development` section of your
725725
environment, for instance in production, you must explicitly pass it when
726726
invoking the command: `rails db:migrate RAILS_ENV=production`.
727727

728-
### Saving data in the controller
728+
### Saving Data in the Controller
729729

730730
Back in `ArticlesController`, we need to change the `create` action
731731
to use the new `Article` model to save the data in the database.
@@ -870,7 +870,7 @@ Visit <http://localhost:3000/articles/new> and give it a try!
870870

871871
![Show action for articles](images/getting_started/show_action_for_articles.png)
872872

873-
### Listing all articles
873+
### Listing all Articles
874874

875875
We still need a way to list all our articles, so let's do that.
876876
The route for this as per output of `rails routes` is:
@@ -926,7 +926,7 @@ And then finally, add the view for this action, located at
926926
Now if you go to <http://localhost:3000/articles> you will see a list of all the
927927
articles that you have created.
928928

929-
### Adding links
929+
### Adding Links
930930

931931
You can now create, show, and list articles. Now let's add some links to
932932
navigate through pages.

guides/source/i18n.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ So that would give you:
537537

538538
TIP: Right now you might need to add some more date/time formats in order to make the I18n backend work as expected (at least for the 'pirate' locale). Of course, there's a great chance that somebody already did all the work by **translating Rails' defaults for your locale**. See the [rails-i18n repository at GitHub](https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale) for an archive of various locale files. When you put such file(s) in `config/locales/` directory, they will automatically be ready for use.
539539

540-
### Inflection Rules For Other Locales
540+
### Inflection Rules for Other Locales
541541

542542
Rails allows you to define inflection rules (such as rules for singularization and pluralization) for locales other than English. In `config/initializers/inflections.rb`, you can define these rules for multiple locales. The initializer contains a default example for specifying additional rules for English; follow that format for other locales as you see fit.
543543

guides/source/routing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ The comments resource here will have the following routes generated for it:
405405
| PATCH/PUT | /comments/:id(.:format) | comments#update | sekret_comment_path |
406406
| DELETE | /comments/:id(.:format) | comments#destroy | sekret_comment_path |
407407

408-
### Routing concerns
408+
### Routing Concerns
409409

410410
Routing concerns allow you to declare common routes that can be reused inside other resources and routes. To define a concern:
411411

@@ -448,7 +448,7 @@ namespace :articles do
448448
end
449449
```
450450

451-
### Creating Paths and URLs From Objects
451+
### Creating Paths and URLs from Objects
452452

453453
In addition to using the routing helpers, Rails can also create paths and URLs from an array of parameters. For example, suppose you have this set of routes:
454454

@@ -868,15 +868,15 @@ end
868868
root to: "home#index"
869869
```
870870

871-
### Unicode character routes
871+
### Unicode Character Routes
872872

873873
You can specify unicode character routes directly. For example:
874874

875875
```ruby
876876
get 'こんにちは', to: 'welcome#index'
877877
```
878878

879-
### Direct routes
879+
### Direct Routes
880880

881881
You can create custom URL helpers directly. For example:
882882

guides/source/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1171,7 +1171,7 @@ Environmental Security
11711171

11721172
It is beyond the scope of this guide to inform you on how to secure your application code and environments. However, please secure your database configuration, e.g. `config/database.yml`, master key for `credentials.yml`, and other unencrypted secrets. You may want to further restrict access, using environment-specific versions of these files and any others that may contain sensitive information.
11731173

1174-
### Custom credentials
1174+
### Custom Credentials
11751175

11761176
Rails stores secrets in `config/credentials.yml.enc`, which is encrypted and hence cannot be edited directly. Rails uses `config/master.key` or alternatively looks for environment variable `ENV["RAILS_MASTER_KEY"]` to encrypt the credentials file. The credentials file can be stored in version control, as long as master key is kept safe.
11771177

guides/source/testing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ we ensured that our test passes. This approach to software development is
224224
referred to as
225225
[_Test-Driven Development_ (TDD)](http://c2.com/cgi/wiki?TestDrivenDevelopment).
226226

227-
#### What an error looks like
227+
#### What an Error Looks Like
228228

229229
To see how an error gets reported, here's a test containing an error:
230230

@@ -470,7 +470,7 @@ Parallel testing allows you to parallelize your test suite. While forking proces
470470
default method, threading is supported as well. Running tests in parallel reduces the time it
471471
takes your entire test suite to run.
472472

473-
### Parallel testing with processes
473+
### Parallel Testing with Processes
474474

475475
The default parallelization method is to fork processes using Ruby's DRb system. The processes
476476
are forked based on the number of workers provided. The default number is the actual core count
@@ -522,7 +522,7 @@ end
522522

523523
These methods are not needed or available when using parallel testing with threads.
524524

525-
### Parallel testing with threads
525+
### Parallel Testing with Threads
526526

527527
If you prefer using threads or are using JRuby, a threaded parallelization option is provided. The threaded
528528
parallelizer is backed by Minitest's `Parallel::Executor`.
@@ -574,7 +574,7 @@ For good tests, you'll need to give some thought to setting up test data.
574574
In Rails, you can handle this by defining and customizing fixtures.
575575
You can find comprehensive documentation in the [Fixtures API documentation](https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html).
576576

577-
#### What Are Fixtures?
577+
#### What are Fixtures?
578578

579579
_Fixtures_ is a fancy word for sample data. Fixtures allow you to populate your testing database with predefined data before your tests run. Fixtures are database independent and written in YAML. There is one file per model.
580580

@@ -787,7 +787,7 @@ Rails.
787787
The `take_screenshot` helper method can be included anywhere in your tests to
788788
take a screenshot of the browser.
789789

790-
### Implementing a system test
790+
### Implementing a System Test
791791

792792
Now we're going to add a system test to our blog application. We'll demonstrate
793793
writing a system test by visiting the index page and creating a new blog article.
@@ -832,7 +832,7 @@ rails test:system
832832
NOTE: By default, running `rails test` won't run your system tests.
833833
Make sure to run `rails test:system` to actually run them.
834834

835-
#### Creating articles system test
835+
#### Creating Articles System Test
836836

837837
Now let's test the flow for creating a new article in our blog.
838838

@@ -1710,7 +1710,7 @@ your jobs are performed inline. It will also ensure that all previously performe
17101710
and enqueued jobs are cleared before any test run so you can safely assume that
17111711
no jobs have already been executed in the scope of each test.
17121712

1713-
### Custom Assertions And Testing Jobs Inside Other Components
1713+
### Custom Assertions and Testing Jobs inside Other Components
17141714

17151715
Active Job ships with a bunch of custom assertions that can be used to lessen the verbosity of tests. For a full list of available assertions, see the API documentation for [`ActiveJob::TestHelper`](https://api.rubyonrails.org/classes/ActiveJob/TestHelper.html).
17161716

guides/source/working_with_javascript_in_rails.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ follow this pattern.
142142
Built-in Helpers
143143
----------------
144144

145-
### Remote elements
145+
### Remote Elements
146146

147147
Rails provides a bunch of view helper methods written in Ruby to assist you
148148
in generating HTML. Sometimes, you want to add a little Ajax to those elements,
@@ -253,7 +253,7 @@ this generates
253253

254254
Since it's just a `<form>`, all of the information on `form_with` also applies.
255255

256-
### Customize remote elements
256+
### Customize Remote Elements
257257

258258
It is possible to customize the behavior of elements with a `data-remote`
259259
attribute without writing a line of JavaScript. You can specify extra `data-`

0 commit comments

Comments
 (0)