Carlos Antonio da Silva
979c6b0366
Fix broken anchor in Rails Guides Guidelines
...
Use american english word as per the guidelines
[ci skip]
2024-01-30 11:01:56 -03:00
Noah Gibbs
0501555800
Note that guide text should wrap at 80 columns
2023-09-08 13:22:28 +01:00
Mike Munroe
67e1e1f901
Clean up bundler install directions
2023-04-27 21:57:00 -04:00
Petrik
9eeaba64a7
Add missing language to markdown code blocks in guides [ci-skip]
2023-02-02 19:01:05 +01:00
Eugene Kenny
2f87589630
Remove references to WARNINGS environment variable [ci skip]
...
This has had no effect since 771a802c374ebe7b2931ba6cf8ffa3b7bf0e92e0.
2020-07-05 16:40:52 +01:00
Jonathan Hefner
481035fba0
Use bash code fences and prompts for shell code [ci skip]
...
Follow-up to #39594 , which added CSS in order to select shell commands
sans prompts on triple-click.
This commit adds several bash code fences and prompts where they were
missing, and removes a few where they were inappropriate.
2020-06-13 19:27:30 -05:00
Petrik
9a57cd3d66
Add preposition and conjunction example to title guideline [ci skip]
2019-12-23 10:51:11 +01:00
Kasper Timm Hansen
eca6c273fe
[ci skip] switch eg. to proper e.g.
2019-10-07 02:18:36 +02:00
Takayuki Nakata
4db23d0b31
Fix documents to replace http with https in reference URL [ci skip]
2019-09-10 09:29:21 +09:00
Nathaniel Suchy
d9f1cc05b5
Update links and code examples in the guides to use HTTPS where the host supports it.
2019-03-06 15:21:07 -05:00
Viktor Fonic
a6b0c4a2d2
Docs: Update Development Dependencies Install
...
* Move all the testing related stuff to the contributing guide and
redirect the reader to this guide once the installation process
is finished as running tests is the logical next step.
* Group documentation instructions by OS, not by gem
* It eases the installation process and lessen the need to scroll
through the guide
* There's still a list of all additional services required for each
of the gems above the instructions for each OS.
* Also update a bit the instructions
* Update some package names
* Add `yarn` to the package list for Arch Linux and FreeBSD
* Use `dnf` instead of `yum` for Fedora and CentOS
* Advise the user to use `brew bundle` on macOS to lessen the
maintenance burden for this OS and ease the process for the user.
[ci skip]
2018-11-09 14:31:02 +01:00
Paul McMahon
7b9c19d94b
Rails guides are now served over https
...
http links will be redirected to the https version, but still better to
just directly link to the https version.
2018-07-24 11:29:31 +09:00
Xavier Noria
b61a029782
document link processing in guides generation [ci skip]
2017-02-12 11:41:01 +01:00
Achilleas Pipinellis
86b6c77337
Update instructions to build guides locally [ci skip]
...
1. Make clear where rake rdoc is executed
2. Make clear where the generated HTML files for the guides are stored
3. Use bundler 1.3.5 or later
2015-04-28 15:33:13 +03:00
Vipul A M
5cfaf5a46e
- Changed IN
to ON
in markdown renderer condition
...
- Changed `IN` to `ON` in all note sentences in guides.
2015-01-14 11:52:13 +05:30
Xavier Noria
7702974281
warn about reading guides in GitHub
...
References #18148 .
2014-12-23 23:32:50 +01:00
Dave Powers
95b0e396cc
Add link to API Documentation Guidelines
...
Link to the "English" section to specify American English be used for the Guides
[ci skip]
2014-11-01 18:39:28 -04:00
Robert Eshleman
d71433d7d4
Cleanup Guides Guidelines [ci skip]
...
* Copy editing for clarity in several locations
* Rename "Titles" section to "Headings"
* Fix incorrect anchor in link to API Documentation Guidelines for filenames
2014-08-10 19:53:00 -04:00
Juanito Fatas
7981f06952
[ci skip] Update GFM link in guides guidelines.
...
Also remove a duplicated sentence.
2014-05-25 23:36:02 +08:00
Harshad Sabne
eb67aa976b
API Documentation Guidelines link correction [ci skip]
2013-11-23 10:45:07 +05:30
Sunny Ripert
666d028bb8
End-of-line whitespace hunt
2013-05-28 14:38:01 +02:00
aditya-kapoor
73fece000f
Added instructions of latest bundler install + modified the on: :save option description in validations
2013-04-22 16:16:44 +05:30
Jonathan Roes
d083193c99
Extraneous syntax on guides path.
2013-03-27 23:28:36 -03:00
Vijay Dev
729798068a
copy edits [ci skip]
2012-12-08 23:10:38 +05:30
Ian C. Anderson
70b809436f
Added overview items to Guides Guidelines prologue
2012-12-07 12:00:48 -05:00
Pablo Torres
1ba6cddf89
List instructions in the order to be executed
2012-12-02 14:28:29 -05:00
Steve Klabnik
d16a1b9e8b
Normalize on 'After reading this guide, you will know:'
...
We have three or four different introduction sentences to the guides.
After this commit, we use the same one everywhere.
2012-11-29 14:25:02 -08:00
Prem Sichanugrist
5e2866cc34
No more Textile guide generation support
2012-09-17 15:55:17 -04:00
Prem Sichanugrist
460c2eec24
Update Guides Guideline for Markdown
2012-09-17 15:54:23 -04:00
Prem Sichanugrist
41dbb58e2d
Fix the usage of *
in Markdown
...
In Textile `*` would convert to `<strong>`, but in Markdown we have to
use `**` instead.
2012-09-17 15:54:23 -04:00
Prem Sichanugrist
9873dd800b
Convert all the links into Markdown format
2012-09-17 15:54:23 -04:00
Prem Sichanugrist
31ef4cf656
Convert all inline codes to Markdown syntax
2012-09-17 15:54:23 -04:00
Prem Sichanugrist
c89c163a0e
Convert inline code tags to Markdown
2012-09-17 15:54:22 -04:00
Prem Sichanugrist
872b7af337
Convert heading tags and heading section
2012-09-17 15:54:22 -04:00
Prem Sichanugrist
7bc1ca3515
Convert code blocks into GFM style
2012-09-17 15:54:22 -04:00
Prem Sichanugrist
5137d03cc5
Rename the rest of the guides to Markdown
2012-09-17 15:54:22 -04:00