Commit Graph

313 Commits

Author SHA1 Message Date
Sebastia
4114dcfb9d Merge pull request #5696 from consuldemocracy/servers-docs
Update documentation for Production and Staging servers
2024-09-30 19:19:06 +02:00
taitus
ff74960ba3 Update mail server configuration instructions 2024-09-30 18:25:07 +02:00
taitus
c267679aeb Update Heroku instructions
Note that the variable related with the "hostname" is removed
from the Heroku instructions as it is not necessary to configure
the Bucket.
2024-09-30 18:25:07 +02:00
taitus
c27a32a5f3 Update digital ocean instructions 2024-09-30 18:25:07 +02:00
taitus
6316938e3b Update manual installation instructions 2024-09-30 18:25:07 +02:00
taitus
cee4f3f027 Update ssh key instructions 2024-09-30 18:25:07 +02:00
taitus
d425b88f26 Update create deploy user instructions 2024-09-30 18:25:07 +02:00
taitus
81ab194831 Update installer installation instructions 2024-09-30 18:25:07 +02:00
taitus
ac23dc162f Update servers installation instructions 2024-09-30 18:25:07 +02:00
Javi Martín
d00b431f58 Move GraphQL code examples to the GraphQL docs
While this leads to a bit of duplication, since now the same code is in
both the Spanish and English texts, and it makes it harder to actually
run the code, it'll make it easier for people reading the documentation
to find the code, and we get rid of the confusingly-named `doc/` folder.
2024-09-30 12:09:08 +02:00
Javi Martín
a5aa39f6e2 Update GraphQL documentation
We don't use the `config/api.yml` file since commit c984e666f, and the
`.delete("\n").delete(" ")` in the code examples isn't necessary (we
should have probably added it in commit 56e42f209).

We're also changing the responses so there are no references to any
specific city.
2024-09-30 12:09:08 +02:00
cyrillefr
18323a36c3 Add new GraphQL type for milestones
- added the milestone type to be displayed with investments
- the corresponding spec
2024-09-30 11:14:01 +02:00
cyrillefr
5ec6337d47 Add new GraphQL types for budget investments
- added 2 new types
- modified the models to get data through graphQL
- modified the corresponding spec
- also testing that hidden comments do not show up
- modified comments specs bc now it returns comments on budget
  investments
2024-09-30 11:14:01 +02:00
Javi Martín
08cceceed8 Update multitenancy documentation
Most of it was up-to-date, except for the fact that Consul Democracy
already uses Rails 7.0 and that it's possible to use different languages
per tenant since commit 6de4737b7.
2024-09-24 18:47:13 +02:00
Javi Martín
32d9118d1e Fix typos in multitenancy documentation 2024-09-24 18:47:13 +02:00
Javi Martín
8277336a7e Merge pull request #5697 from consuldemocracy/recommendation_docs
Update recommendations documentation
2024-09-20 14:32:27 +02:00
Javi Martín
d86299f44d Add documentation to run tests with Docker 2024-09-19 15:41:32 +02:00
Javi Martín
b3facb39bf Don't use an image to show the results of docker ps
The alternative text of the image was useless, and we were depending on
an external server in order to display it. Furthermore, the text inside
the image was pretty small.

So we're displaying the output of the command as plain text.
2024-09-19 15:20:38 +02:00
Javi Martín
d88ea7f26d Use build+create in Docker installation instructions
There was a typo where we said we were creating the containers but we
were building the image.

While none of these commands are necessary because they're run
automatically when first running the `db:create` rake task, I think it's
better to show them separately, since the `build` command might be used
to rebuild the image, and running the `create` command separately makes
it easier to know what's going on.

We're also removing the "start database service" step, since it's
automatically started because the app service depends on it.

Finally, we're updating one command for macOS.
2024-09-19 15:20:38 +02:00
Javi Martín
2f5ddfd77e Simplify documentation to install Docker
Docker and Docker Compose are included in most Linux distributions, and
we don't know whether the windows error we talked about is still
relevant in 2024. In any case, the Docker documentation to install
windows is a better resource for that than our documentation.

We're also using the same Docker commands for every operating system.
2024-09-19 15:20:14 +02:00
Javi Martín
148ff3c2be Move Docker documentation to the local installation section
Having it under the production installation section was confusing, since
it contains instructions for local development.
2024-09-19 15:18:06 +02:00
Javi Martín
9342ad757b Update links to user documentation and guides 2024-09-19 14:33:41 +02:00
Javi Martín
f133bc14a8 Add documentation to change the admin credentials
This is something really important, and we weren't mentioning it.
2024-09-19 14:33:41 +02:00
Javi Martín
71da9f4cda Update basic configuration guide
Other than checking typos and styling, we're removing references to
"Main URL" (which isn't used since commit f87165851), and updating the
process to configure the map.
2024-09-19 14:33:38 +02:00
Javi Martín
a693258e41 Update recommendations documentation
No big changes here, other than adding proper alternative texts in
Spanish.
2024-09-19 13:35:58 +02:00
Sebastia
6991bf08df Merge pull request #5655 from consuldemocracy/getting-started-docs
Update getting started instructions
2024-09-11 16:24:55 +02:00
taitus
d6efd4edb3 Update communication instructions 2024-09-11 14:13:11 +02:00
taitus
0a83661e95 Update 'Keep your fork updated' instructions 2024-09-11 14:13:11 +02:00
taitus
e858e226cd Update configuration instructions 2024-09-11 14:13:11 +02:00
Javi Martín
9d818b4ec2 Make it easier to add custom routes
Until now, people had to edit the original route files in order to add
custom routes.

This was inconsistent with the other customizations, since we use custom
folders or files for customizing controllers, components, views, ...
(which you usually customize as well when adding a new route).

So now we're providing a file for custom routes, which will make it
easier to know which routes are not present in Consul Democracy by
default.
2024-09-11 13:27:48 +02:00
Javi Martín
ee089a5209 Update customization docs introduction 2024-09-11 13:27:48 +02:00
Javi Martín
136edb97e9 Update documentation to customize translations 2024-09-11 13:27:48 +02:00
taitus
6f692abdf8 Update getting started and create instructions 2024-09-11 09:47:56 +02:00
Javi Martín
3a01e171b8 Add documentation about tests customization 2024-09-10 14:54:20 +02:00
Javi Martín
64d6460215 Update documentation to customize images 2024-09-10 14:54:20 +02:00
Javi Martín
9b08a73156 Update documentation for CSS customization 2024-09-10 14:29:51 +02:00
Javi Martín
ced834200a Update documentation to customize JavaScript
Note that, while it doesn't really affect the way the application
behaves (as long as the JavaScript code doesn't rely on the order it's
loaded) we're requiring `app/assets/javascripts/custom.js` after
requiring any files in the `app/assets/javascripts/custom/` folder. This
is done for consistency, since we load the content of
`app/assets/javascripts/application.js` after requiring everything else.
2024-09-10 14:29:51 +02:00
Javi Martín
a8250a6f46 Fix typos in gemfile customization docs 2024-09-10 14:07:43 +02:00
Javi Martín
58a5b7e627 Add documentation to customize other Ruby classes 2024-09-10 14:07:43 +02:00
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