Commit Graph

73 Commits

Author SHA1 Message Date
John Bampton
eef63e05fb chore: fix case of CSS and JavaScript 2021-04-15 21:52:58 +10:00
Gerard (Gerry) Caulfield
c14da7be22 Fix highlighting for mostly SQL block
When using Rouge's Console lexer it expects all ignored line breaks to
be proceeded by a backslash. In this code block as we are switching to
Mysql's command line which doesn't need a backslash. This leads to the
lexer breaking and all the lines ending up in a confusing mess.

However the sql syntax actually works much better for this block
anyway.

This line here shows why what we were trying to do wouldn't work with
Rouge:
844c0eeddf/lib/rouge/lexers/console.rb (L106)
2020-07-26 18:27:07 +02:00
aminamos
7bb0706f2c update from PR #36222 2020-02-12 13:31:43 -05:00
Keeyan Nejad
45bb17333d Update "The Hard Way" setup for Arch Linux
MariaDB cannot be started on Arch Linux before running a command to create the database files

See https://wiki.archlinux.org/index.php/MariaDB#Installation

It also appears that memcached is not started by default on Arch Linux,
so it has been added to the systemctl startup step.

This PR adds that step when setting up on Arch Linux
2020-01-04 01:29:51 +00:00
Louis-Michel Couture
467e79bb8b
Update MySQL links to the current version of the manual [ci skip]
Accessing the MySQL manual without a specific version number will redirect to the latest version of the manual.
Remove non functional id from a comment in favor an explicit message
2019-10-03 20:22:29 -04:00
David Rodríguez
34d426b4e5 Add missing OS dependency (#37263)
* Add missing OS dependency

Otherwise the `libxml-ruby` gem does not install in ubuntu and `bundle install`
errors out with the following error:

```
Fetching libxml-ruby 3.1.0
Installing libxml-ruby 3.1.0 with native extensions
Gem::Ext::BuildError: ERROR: Failed to build gem native extension.

    current directory: /home/deivid/.rbenv/versions/2.6.4/lib/ruby/gems/2.6.0/gems/libxml-ruby-3.1.0/ext/libxml
/home/deivid/.rbenv/versions/2.6.4/bin/ruby -I /home/deivid/.rbenv/versions/2.6.4/lib/ruby/site_ruby/2.6.0 -r ./siteconf20190921-8482-194nrkq.rb extconf.rb
/home/deivid/.rbenv/versions/2.6.4/bin/ruby: warning: shebang line ending with \r may cause problems
checking for libxml/xmlversion.h in /opt/include/libxml2,/opt/local/include/libxml2,/usr/local/include/libxml2,/usr/include/libxml2... no
*** extconf.rb failed ***
Could not create Makefile due to some reason, probably lack of necessary
libraries and/or headers.  Check the mkmf.log file for more details.  You may
need configuration options.

Provided configuration options:
	--with-opt-dir
	--without-opt-dir
	--with-opt-include
	--without-opt-include=${opt-dir}/include
	--with-opt-lib
	--without-opt-lib=${opt-dir}/lib
	--with-make-prog
	--without-make-prog
	--srcdir=.
	--curdir
	--ruby=/home/deivid/.rbenv/versions/2.6.4/bin/$(RUBY_BASE_NAME)
	--with-xml2-config
	--without-xml2-config
	--with-xml2-dir
	--without-xml2-dir
	--with-xml2-include
	--without-xml2-include=${xml2-dir}/include
	--with-xml2-lib
	--without-xml2-lib=${xml2-dir}/lib
 extconf failure: need libxml2.

    Install the library or try one of the following options to extconf.rb:

      --with-xml2-config=/path/to/xml2-config
      --with-xml2-dir=/path/to/libxml2
      --with-xml2-lib=/path/to/libxml2/lib
      --with-xml2-include=/path/to/libxml2/include

To see why this extension failed to compile, please check the mkmf.log which can be found here:

  /home/deivid/.rbenv/versions/2.6.4/lib/ruby/gems/2.6.0/extensions/x86_64-linux/2.6.0-static/libxml-ruby-3.1.0/mkmf.log

extconf failed, exit code 1

Gem files will remain installed in /home/deivid/.rbenv/versions/2.6.4/lib/ruby/gems/2.6.0/gems/libxml-ruby-3.1.0 for inspection.
Results logged to /home/deivid/.rbenv/versions/2.6.4/lib/ruby/gems/2.6.0/extensions/x86_64-linux/2.6.0-static/libxml-ruby-3.1.0/gem_make.out

An error occurred while installing libxml-ruby (3.1.0), and Bundler cannot continue.
Make sure that `gem install libxml-ruby -v '3.1.0' --source 'https://rubygems.org/'` succeeds before bundling.

In Gemfile:
  libxml-ruby
```

* Add missing libxml2 dependency to remaining platforms
2019-09-23 07:20:56 +09:00
David Rodríguez
166a7fb78b
Prefer one liners OS requirement install commands
I was getting some problems when running `bundle install` on a fresh
clone. It was due to some extension building errors that usually point
out to missing OS dependencies.

So I run "rg apt-get" hoping to find some suggestion to install
requirements for my OS. However, the result was misleading, because
dependencies are split across several lines, so I missed many of them.

I think a one liner is better and it's also slightly easier to
copy-paste.
2019-09-21 00:02:10 +02:00
bogdanvlviv
535af8798c
Fix "Development Dependencies Install" guide [ci skip]
Since we use [workspaces](https://yarnpkg.com/lang/en/docs/workspaces/)
`yarn install` from the root should install all the javascript dependencies.
2019-01-19 23:28:25 +00:00
Alfonso Jiménez
d8611eba35 Fix typo in development_dependencies_install.md [ci skip] 2018-11-20 16:36:47 +01: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
George Claghorn
14ecf58b54 Add missing newline [ci skip] 2018-08-21 22:35:09 -04:00
Mr. Outis
63f63fe67b [ci skip] Add ImageMagick to ActiveStorage dependencies
In order to run ActiveStorage's tests successfully, you need
imagemagick.
2018-08-21 20:48:04 -05:00
Anton Rieder
852b688669
Harmonize shell commands in dev guide [ci skip] 2018-08-16 12:31:49 +02:00
Robin Dupret
74ce503fa9 Add missing instructions for FreeBSD [ci skip]
The development dependencies installation guides have the installation
instructions for FreeBSD in other sections so let's be consistent
regarding the dependencies for Active Storage setup.

Also fix a few typos.
2018-08-09 20:12:11 +02: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
utilum
b2d9c3f9ca Remove backticks around proejct names
[ci skip]
2018-06-11 22:57:03 +02:00
utilum
0af43ac7f6 Dev-Dep guide: mention AST third party requirements
Avoid the likes of:

```
Error:
ActiveStorage::RepresentationTest#test_representing_an_MP4_video:
Errno::ENOENT: No such file or directory - ffmpeg
    test/models/representation_test.rb:27:in `block in <class:RepresentationTest>'
```

Also note additiona macOS requirements in ActiveStorage guide.

[ci skip]
2018-06-08 11:28:04 +02:00
Yoshiyuki Hirano
bf48e90e69 Use https instead of http in guide [ci skip] 2017-08-23 09:39:45 +09:00
Koichi ITO
1450abcd19 Fix doc format in Active Storage Setup [ci skip]
Follow up of 2ebb284ef5bf2c36bd8ba0a4524cab83810f12ab.
2017-08-19 22:11:51 +09:00
Yoshiyuki Hirano
948c2c48df Use ssl in guide and comment [ci skip] 2017-08-19 08:23:37 +09:00
Yoshiyuki Hirano
e34fef30f9 Use https instead of http or git in guide [ci skip]
* Update url in Development Dependencies Install
2017-08-19 01:55:46 +09:00
Jon Moss
c268c9be05 Cleanup development_dependencies_install.md
Lots of grammar cleanup, and also changing to use macOS.

[ci skip]
2017-08-18 11:39:25 -04:00
Jon Moss
2ebb284ef5 Add Yarn installation instructions for Active Storage
This is a requirement when working on the JS portions of ASt. Using
npm instead of Yarn is a bad idea here since the lockfile is in Yarn's
format.

[ci skip]
2017-08-18 11:33:32 -04:00
utilum
133236fa0a [ci skip] Update fedora SQLite3 package name 2017-06-17 12:37:42 +02:00
Vitali Tatarintev
7718d470e9 [ci skip] Update Guides to use macOS instead of Mac OS X 2017-02-20 15:12:51 +01:00
utilum
7d62e27dd5 Mention JS Runtime dependency in dev dependencies guide [ci skip]. 2016-12-14 16:08:44 +01:00
Rafael Reggiani Manzo
65b5960759 [ci skip] Update docs with Action Cable Redis dependency
Action Cable's test `test/subscription_adapter/redis_test.rb` fail if
Redis is not installed and running.

Following the guides `development_dependen there's no mention to this.
2016-08-22 14:44:46 -03:00
Mohamad Abras
8eca8d5808 remove old-dead link 2016-03-27 09:19:56 +00:00
Scott Bronson
8c629bf463 remove legacy mysql from guides to match #22715 2016-01-09 09:10:49 -08:00
Ignatius Reza
7a11b10e3d [ci skip] fix invalid package name for libmysqlclient-dev
tested on Ubuntu Desktop 15.04
2015-09-02 18:30:03 +09:00
Robin Dupret
068ab23a33 Tiny documentation fixes [ci skip] 2015-06-18 11:38:08 +02:00
Vijay Dev
423f14183f Merge branch 'master' of github.com:rails/docrails 2015-06-05 19:49:44 +00:00
yui-knk
de74fe74a8 [ci skip] Add . 2015-06-01 13:55:37 +09:00
yui-knk
20ee4d0862 [ci skip] Fix above -> below 2015-06-01 13:52:51 +09: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
Robin Dupret
53cc3ab46b Whoops, duplicated word [ci skip] 2014-08-24 19:44:03 +02:00
Robin Dupret
7fc404ab0d Some tweaks to the development set-up guide
* Remove the libxml2 and libxslt part ; Nokogiri ships now with these
  libraries bundled.
* Add the missing installation instructions for either Arch Linux,
  FreeBSD or Mac OS X.
* Use the new `pkg install` syntax over `pkg_add -r` for FreeBSD 10+
  users.
* Point to the up-to-date version of PostgreSQL as for the BSD port.
* Make the platform installation instructions order consistent
  throughout the guide.
* Remove useless duplicated links to Homebrew's home.

[ci skip]
2014-08-24 19:40:36 +02:00
Akira Matsuda
abbf7bfa70 http://gembundler.com/ => http://bundler.io/ 2014-08-19 16:49:15 +09:00
Arun Agrawal
da4d841e16 Reorganize ActiveRecord tasks [Arun Agrawal & Abd ar-Rahman Hamidi] 2014-05-16 23:09:05 +02:00
Yves Senn
b231825f3e Revert "Merge pull request #14940 from arunagw/hbakhtiyor-test-db-namespaces-ar"
This reverts commit fe9859600824268ff614cb3eb48b62c7165a1fbd, reversing
changes made to add9560643ef79830febf47fa1228752d1df3502.
2014-05-03 20:08:15 +02:00
Arun Agrawal
2de846852a Reorganize ActiveRecord tasks [Arun Agrawal & Abd ar-Rahman Hamidi] 2014-05-03 19:34:18 +02:00
Jarmo Isotalo
2bc0271e3d Added OS X specific commands to installation guide [ci skip]
Recommended using homebrew for installing MySQL and PostgreSQL
2014-04-07 00:07:46 +03:00
Yasuo Honda
eb9ced882d Update grant statement to address #13549 2014-01-01 09:25:47 +09:00
Vijay Dev
ab0cbff07e Merge branch 'master' of github.com:rails/docrails 2013-08-31 00:49:27 +05:30
Xavier Noria
b77f25cb84 cleans the guides sources from fancy non-ASCII stuff 2013-08-23 17:59:11 +02:00
wangjohn
de2043ade6 Document ability to run a single test. 2013-08-21 18:03:59 -05:00
wangjohn
ae54e41824 Removing merge conflict remnants in the guides. 2013-08-21 16:34:36 -04:00
Guillermo Iguaran
d1b618b50a Merge pull request #11914 from pawel2105/development-dependencies-guides-fix
Memcached note for Rails guides [ci skip]
2013-08-18 15:11:25 -07:00
Vijay Dev
9abe72c760 Merge branch 'master' of github.com:rails/docrails
Conflicts:
	actionview/README.rdoc
	activerecord/lib/active_record/migration.rb
	guides/source/development_dependencies_install.md
	guides/source/getting_started.md
2013-08-17 21:49:16 +05:30