Commit Graph

218 Commits

Author SHA1 Message Date
Javi Martín
19e12d9053 Update documentation to customize components 2024-09-10 14:07:43 +02:00
Javi Martín
7a1f78ddf3 Update documentation to customize views 2024-09-10 14:07:43 +02:00
Javi Martín
a4063d0ec0 Update documentation to customize the application config 2024-09-09 16:44:51 +02:00
Javi Martín
0b928e52b1 Add documentation to customize controllers 2024-09-09 16:41:08 +02:00
Javi Martín
fce300a11a Update models customization documentation 2024-09-09 16:41:08 +02:00
Javi Martín
d3fa99332c Update files and folders used to customize the application 2024-09-04 13:20:00 +02:00
Javi Martín
f45ad68407 Move user translations docs to the features section
The documentation of user content translations doesn't really belong in
the customization introduction.
2024-09-02 15:18:13 +02:00
Javi Martín
497c542082 Upgrade Ruby to version 3.2.5
So get the latest fixes in the 3.2.x series.

We're also updating the parser gem so we don't get any warnings.
2024-08-19 16:04:38 +02:00
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
1b61e8e2e0 Add a more specific link for local installation docs
On our regular README, this link used to point to the documentation
site, which made sense because the documentation used to be on a
different repository. Now that the documentation is on this repository
as well, we can directly link to that file.

And, on the documentation README, we can also link to the local
installation instructions, just like we do in other places.
2024-08-06 15:48:14 +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
5d9f02ae30 Fix typo in Spanish README 2024-08-06 15:48:14 +02:00
Javi Martín
13d31b8668 Add ImageMagick to prerequisites
We include ImageMagick in the local installation instructions as well as
in the installer, but we forgot to add it to the list of prerequisites
in the README.
2024-08-06 15:47:46 +02:00
Javi Martín
5f20b5baac Remove dependency on shared-mime-info
We don't use mimemagic since commit 7212657c0, so we don't need
shared-mime-info anymore.
2024-08-06 12:46:49 +02:00
Javi Martín
f78e2bed94 Update documentation to load custom code
Just like mentioned in commit 6552e3197d, we need to use `load` instead
of `require_dependency` since we started using zeitwerk.
2024-06-28 03:49:20 +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
035bfeb3b1 Add and apply MD047 MDL rule
We weren't adding a newline character at the end of a couple of files.
2024-06-21 15:57:52 +02:00
Javi Martín
777781f361 Update documentation README files
These files are essentially the same as our README files, only our
README files contain information that only makes sense in the context
of a repository.
2024-06-18 23:39:42 +02:00
Javi Martín
0b9be27c8c Use one SUMMARY.md file per language
On GitBook, currently Spanish and English belong in different spaces, so
we're going to provide two different github integrations (one per
language).

So we're using a different SUMMARY.md file per language.

For consistency, since there was a link to the README file in the
Spanish summary, we're also adding it to the English one. It was working
in any case because on our current gitbook page the summary was
generated through gitbook.

Since we no longer have any of the files referenced in the
`.gitbook.yaml` file, we're removing it as well.

Note that there was a typo in the English summary, which pointed to the
Spanish license. It didn't matter, though, since the license file is
actually in English in both cases.
2024-06-18 23:38:46 +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
a76d2bba11 Fix broken link on translations page 2024-06-18 20:33:01 +02:00
cronopioelectronico
b536548cec Remove unnecessary texts in the README 2024-06-18 20:33:01 +02:00
cronopioelectronico
a4dbe1b413 Remove reference to old project team email address 2024-06-18 20:33:01 +02:00
Javi Martín
2638aba756 Link to our repository instead of Madrid's 2023-07-12 19:31:03 +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
Javi Martín
68d0ffe5ec Copy the README from the CONSUL DEMOCRACY repo
We took it from there years ago, but we haven't kept it up to date.
2023-07-12 15:33:14 +02:00
taitus
08c78688db MD038 Spaces inside code span elements 2023-04-21 11:00:02 +02:00
taitus
32f825b6a6 MD034 Bare URL used 2023-04-21 11:00:02 +02:00
taitus
0d6a88abca MD033 Inline HTML
This rule is broken in the Spanish files in which we have had to create the
headers with html in order to make the links work correctly.

These changes were made in commit: 3126fe769
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
3ed836f6af MD019 Multiple spaces after hash on atx style header 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