Commit Graph

250 Commits

Author SHA1 Message Date
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
0710e3d542 Remove redundant files in docs subfolder
These files were both in the Consul Democracy repository and the
documentation repository. Since now both repositories have been merged
into one, we can remove the duplicate files.

Note there was a small difference in the `.mdlrc` file because we
changed it in commit b3a718ae6. We're keeping this change so we don't
get these syntax warnings in the documentation.
2024-06-18 20:33:01 +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
0c6cdfd321 Update README before archiving the repository
From now on changes will be done using the GitBook interface, so
changing this repository won't have any effects.

So we're archiving the repository and linking to the documentation site.
2023-07-17 19:08:25 +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
Javi Martín
69fd75d25e Use the logo with the new name 2023-07-10 19:19:27 +02:00
taitus
376f9ab568 Change "&" to "and"
Maybe using "&" is too informal for documentation.
2023-04-21 11:04:50 +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
taitus
78dfe298cb MD005 Inconsistent indentation for list items at the same level 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
taitus
dfcd7fe9f3 MD001 Header levels should only increment by one level at a time 2023-04-21 10:40:20 +02:00
taitus
b3a718ae64 Remove rule "MD029" Ordered list item prefix 2023-04-21 10:40:20 +02:00
taitus
c1529303e4 Use the same rules that we have defined in Consul 2023-03-22 11:13:56 +01:00
Sebastia
f1d0e41132 Merge pull request #119 from consul/update_remote_translations
Update remote translation docs
2023-03-22 09:05:15 +01:00
taitus
a5205cfda9 Update remote translation docs
Due to the change of the translator-text gem to the bing_translator gem,
the documentation has been reviewed and changes have been detected
in the links, prices and azure administration panel.

We removed the Google and DeepL prices, since we will not be reviewing
the prices of the different providers and they may be out of date.
2023-03-21 13:50:47 +01:00
Javi Martín
025f509400 Don't end headings with semicolons 2023-03-01 17:02:43 +01:00
Javi Martín
43ab93e756 Use one blank line around headings 2023-03-01 17:02:43 +01:00
Javi Martín
74c5589cb1 Fix format typos in graphql guide 2023-03-01 17:02:18 +01:00
Sebastia
3662172d21 Merge pull request #117 from pitmonticone/master
Clean docs
2023-02-23 15:23:59 +01:00
Pietro Monticone
763e8aeaf7 Update introduction.md 2023-02-22 19:22:48 +01:00
Pietro Monticone
80e40d1af4 Update graphql.md 2023-02-22 19:21:37 +01:00
Pietro Monticone
557d757679 Update en/customization/views_and_styles.md
Co-authored-by: Javi Martín <35156+javierm@users.noreply.github.com>
2023-02-22 19:15:17 +01:00
Pietro Monticone
cf9955ba43 Update graphql.md 2023-02-20 12:50:44 +01:00
Pietro Monticone
61eab1e023 Fix typos 2023-02-20 12:49:21 +01:00
Javi Martín
0b7ecb7d54 Add documentation for multitenancy 2023-01-11 16:10:48 +01: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