Commit Graph

62 Commits

Author SHA1 Message Date
Javi Martín
10e2a9713f Update references to GitHub repositories 2023-07-12 16:03:17 +02:00
Javi Martín
13c641eedc Update application name
Note that, in order to have some consistency, we're always writing
"Consul Democracy", instead of using capital letters sometimes (but not
always), like we did until now.
2023-07-12 15:36:49 +02:00
taitus
32f825b6a6 MD034 Bare URL used 2023-04-21 11:00:02 +02:00
taitus
ab4fcf7e0c MD032 Lists should be surrounded by blank lines 2023-04-21 11:00:02 +02:00
taitus
31efa97076 MD031 Fenced code blocks should be surrounded by blank lines 2023-04-21 11:00:02 +02:00
taitus
e5a8f06049 MD026 Trailing punctuation in header
This rule is broken when we have ".,;::!?" in the headers.
We have removed the ones with ":" but kept the ones
with "?", so this rule will always warn in these cases.
2023-04-21 11:00:02 +02:00
taitus
d8786fd66a MD025 Multiple top level headers in the same document 2023-04-21 11:00:02 +02:00
taitus
1b0246e505 MD022 Headers should be surrounded by blank lines 2023-04-21 11:00:02 +02:00
taitus
6ab85d4f19 MD012 Multiple consecutive blank lines 2023-04-21 11:00:02 +02:00
taitus
16a3189e0d MD009 Trailing spaces 2023-04-21 11:00:02 +02:00
taitus
1006940de5 MD006 Consider starting bulleted lists at the beginning of the line 2023-04-21 11:00:02 +02:00
taitus
65837049a2 MD002 First header should be a top level header
Adapt the rest of the headers.
2023-04-21 10:40:21 +02:00
Pietro Monticone
f62cd1129b Clean docs 2022-11-01 15:20:25 +01:00
Javi Martín
b2cb72ae81 Merge pull request #82 from LucasCioffi/patch-2
Add instructions for SendGrid + Heroku
2021-12-13 16:06:14 +01:00
Javi Martín
e2ec47ae4d Use the same URL to clone the repo everywhere
We were using the SSH URL in the Docker documentation, while using the
HTTPS URL everywhere else. The HTTPS URL is the right one in this case
because it's meant for people who won't have write access to the
repository.
2021-12-13 14:35:49 +01:00
Javi Martín
7ac5443006 Recommend building the image with docker-compose
If we used the `docker build` to build the image and then
`docker-compose`, we'd build two images.
2021-12-10 20:04:37 +01:00
LucasCioffi
92446306ab Add instructions for how to turn on SendGrid
Instructions like these are necessary to prevent developers from
wondering why their emails aren't getting sent.
2021-12-10 18:21:10 +01:00
João Pimentel Ferreira
140fd80b23 Create manual_installation_production.md
I think it's this. Please review to be sure that I am not missing anything.
I was a bit confused with the directory links in the installer instructions, because in unix you don't create directories to then link them, since the command `ln -s` already creates the linked directory. But I think it's this. Please review and amend it accordingly
2021-12-10 13:27:39 +01:00
Javi Martín
69f9738902 Update Puma installation on Heroku
CONSUL now uses Puma on production as well.
2021-11-30 17:59:29 +01:00
Javi Martín
9820a2ce07 Remove obsolete warning regarding images in S3
This issue was fixed in Consul 1.4.0.
2021-11-30 17:59:27 +01:00
Pierre Mesure
f4c932b269 Adding missing link 2021-11-30 17:59:21 +01:00
Pierre
6fcbd414f5 Updating the heroku guide for CONSUL v1.0.0 2021-11-30 17:54:46 +01:00
João Pimentel Ferreira
7674434943 Rename dev_mailserver.md to mail_server_configuration.md 2021-11-10 13:33:39 +01:00
João Pimentel Ferreira
45449f5556 Update dev_mailserver.md
Mail server configuration now is done on `config/secrets.yml` and thus
documentation should be updated accordingly.
2021-11-10 13:33:37 +01:00
Javi Martín
63f23852f5 Improve markdown style in Docker documentation files 2021-09-12 21:37:32 +02:00
Vaibhav Ariyur
c6a273b620 Update docker.md
added "under Docker Desktop " to specify installing docker instructions more
2021-08-26 18:08:34 -04:00
Vaibhav Ariyur
b54b81e147 Update docker.md
Added installation instructions for Docker on Windows.
2021-08-26 18:03:53 -04:00
Javi Martín
6240f4c313 Specify password in Docker commands
This is needed since pull request 4478 in the consul/consul repository.
2021-04-23 12:32:30 +02:00
Javi Martín
68ff36685d Simplify instructions to populate Docker database 2021-04-22 19:04:50 +02:00
Javi Martín
bec0da8ca4 Update command to execute rake tasks
This command might fail if developers have several different versions of
the `rake` gem on their system.
2021-04-14 16:21:44 +02:00
Javi Martín
b5eff7ba69 Fix typo 2020-07-08 14:22:22 +02:00
Javi Martín
4cda1724d2 Specify the Bundler version we install
By, default, Bundler will install its latest version (2.x.y), and we're
using the 1.x.y series.
2020-07-08 14:22:22 +02:00
Javi Martín
127ada280f Install Ruby based on CONSUL's .ruby-version 2020-07-08 14:22:22 +02:00
taitus
c0a2a481e2 Update bashrc path for 'as a local user' section 2020-02-24 14:48:13 +01:00
taitus
5334179cad Unify doc on installation debian section 2020-02-24 11:05:36 +01:00
taitus
7635f0271a Fix links to documentation on basic configuration section 2019-12-17 16:22:43 +01:00
taitus
9f2c7f85e5 Fix links to images on dev mailserver section 2019-12-17 16:22:43 +01:00
taitus
e30ccf4689 Fix links on Docker section 2019-12-17 16:22:42 +01:00
taitus
84912d9f13 Fix links on Windows section 2019-12-17 16:22:42 +01:00
taitus
c7dbd8306c Fix macos section
Add missing information on english version. Fix links on spanish and english version
2019-12-17 16:22:42 +01:00
taitus
265992931a Fix debian section
Add missing information on english version. Fix text on spanish version
2019-12-17 16:22:42 +01:00
Javier Martín
eeeb674fbf Merge pull request #81 from LucasCioffi/patch-1
Adding missing character
2019-11-24 03:03:47 +01:00
Javi Martín
d49df794f7 Update installation instructions for Ruby 2.4.9
This is the Ruby version CONSUL uses now. Thanks to that, we no longer
need to install an old version of libssl-dev for Ubuntu 18.04.

We could probably simplify the documentation using:

```bash
rbenv install `cat .ruby_version`
```

However, this would require downloading consul before installing Ruby,
which could be harder to document.
2019-10-21 22:10:16 +02:00
LucasCioffi
ff28501eb0 Adding missing character
I think there was a missing character on this line.
2019-07-19 16:10:12 -04:00
Aidan Feldman
7a429a2b41 spelling fix around operating systems 2019-04-29 13:45:11 -04:00
voodoorai2000
69411173b5 Fix language mismatch 2019-04-11 15:16:26 +02:00
voodoorai2000
ac0cd015e7 Update Postgres instructions for Ubuntu
We were getting an enconding exception when running `rake db:create`.

This post from stackoverlow seems to fix it
https://stackoverflow.com/questions/13115692/encoding-utf8-does-not-match-locale-en-us-the-chosen-lc-ctype-setting-requires
2019-04-11 14:50:41 +02:00
voodoorai2000
e5924bc98f Update Node.js installation
The previous way of installing Node.js does not seem to be picked up correctly. When running `rails server` it was raising an exception.
2019-04-11 14:50:34 +02:00
voodoorai2000
57c8d6a218 Add general system update and Imagemagick for Ubuntu 2019-04-11 14:50:29 +02:00
voodoorai2000
ffcc413e86 Add general system update and Imagemagick for Debian 2019-04-11 14:50:23 +02:00