taitus
e46fc35d31
Update macOS local installation instructions
2024-08-07 16:46:07 +02:00
Javi Martín
996885b8c8
Fix typos in local installation instructions
2024-08-07 16:34:41 +02:00
Javi Martín
37f737192e
Add Docker as an option to develop using windows
...
For some people, this is easier than installing a virtual machine.
2024-08-07 15:48:50 +02:00
Javi Martín
b686489652
Update Debian local installation instructions
...
So now we install a specific version of Node.js and use the packages
required for Debian Bookworm.
For consistency, we're also making them similar to the Ubuntu
instructions and installing rbenv instead of RVM. Since we now suggest
rbenv in both cases as well as in the macOS instructions, we're also
listing rbenv as the first option in the generic local installation
instructions.
2024-08-07 15:48:50 +02:00
taitus
7845c7f78d
Update ubuntu local installation instructions
...
So now we install a specific version of Node.js and use the packages
required for Ubuntu 24.04.
2024-08-07 15:48:50 +02:00
Javi Martín
0a3cabd8c8
Add rspec note to local installation instructions
...
This note was already present in the README, and it makes sense that we
mention it again in the other place where we recommend running the test
suite.
2024-08-07 15:48:50 +02:00
Javi Martín
9f5f0b3cf4
Remove UTF-8 PostgreSQL configuration instructions
...
Modern systems already use UTF-8 and so these instructions aren't
necessary.
2024-08-07 15:48:50 +02:00
Javi Martín
5b50040995
Simplify instructions to install rbenv
...
Some of these steps are no longer necessary since the rbenv installer
automatically configures the `~/.bashrc` file.
2024-08-07 15:48:50 +02:00
Javi Martín
9e3bbfd3aa
Simplify wget command in Ubuntu instructions
2024-08-07 15:48:50 +02:00
Javi Martín
97c59afb0e
Update instructions to install Node.js
...
We're using a specific version of Node.js since commit 55ed40e18 .
2024-08-07 15:48:47 +02:00
Javi Martín
e666c28c5c
Update instructions for the bin/setup command
...
This command simplifies some of the steps. However, there's a gotcha: it
might fail if the database requires username and password and they
haven't been configured before executing it.
2024-08-07 15:48:21 +02:00
Javi Martín
4c5e446d02
Remove step to install the bundler gem
...
Bundler is included in Ruby since Ruby 2.6, so we don't have to
manually install the gem since commit 8e64d6c1a .
2024-08-06 15:48:14 +02:00
Javi Martín
819485eb80
Re-add and apply MDL rule MD040
...
We were following it about half of the time and we even added it to our
former `.mdlrc` file. However, for some reason, MDL doesn't detect this
rule when specified in the `.mdlrc` file, so we didn't notice we weren't
following it in many cases.
Now that we're using a style file to configure MDL, we can enable this
rule again and apply it, since now MDL correctly includes it in its
report.
2024-06-21 15:57:52 +02:00
Javi Martín
3875503ea5
Update rbenv installation script URL
...
Their master branch was renamed to main.
2024-06-18 20:33:01 +02:00
Javi Martín
b4af3392cd
Update URLs for other Consul Democracy projects
2023-07-12 16:03:17 +02:00
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