From 31efa97076323ef98e975d0619e3b53661f7ecd0 Mon Sep 17 00:00:00 2001 From: taitus Date: Tue, 21 Mar 2023 16:14:43 +0100 Subject: [PATCH] MD031 Fenced code blocks should be surrounded by blank lines --- docs/en/customization/introduction.md | 2 ++ docs/en/features/census_configuration.md | 1 + docs/en/features/oauth.md | 3 ++- docs/en/getting_started/update.md | 2 ++ docs/en/installation/create_deploy_user.md | 3 +++ docs/en/installation/deploying-on-heroku.md | 1 + docs/es/customization/introduction.md | 2 ++ docs/es/features/census_configuration.md | 1 + docs/es/getting_started/update.md | 1 + docs/es/installation/create_deploy_user.md | 3 +++ docs/es/installation/deploying-on-heroku.md | 1 + 11 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/en/customization/introduction.md b/docs/en/customization/introduction.md index 3b6de8a24..30cb51118 100644 --- a/docs/en/customization/introduction.md +++ b/docs/en/customization/introduction.md @@ -71,9 +71,11 @@ We attach some screenshots of how the application interacts with our users: ### Available languages for remote translation Currently these are all the [available languages](https://api.cognitive.microsofttranslator.com/languages?api-version=3.0) in the translation service: + ```yml ["af", "am", "ar", "as", "az", "ba", "bg", "bn", "bo", "bs", "ca", "cs", "cy", "da", "de", "dv", "el", "en", "es", "et", "eu", "fa", "fi", "fil", "fj", "fo", "fr", "fr-CA", "ga", "gl", "gu", "ha", "he", "hi", "hr", "hsb", "ht", "hu", "hy", "id", "ig", "ikt", "is", "it", "iu", "iu-Latn", "ja", "ka", "kk", "km", "kmr", "kn", "ko", "ku", "ky", "ln", "lo", "lt", "lug", "lv", "lzh", "mg", "mi", "mk", "ml", "mn-Cyrl", "mn-Mong", "mr", "ms", "mt", "mww", "my", "nb", "ne", "nl", "nso", "nya", "or", "otq", "pa", "pl", "prs", "ps", "pt", "pt-PT", "ro", "ru", "run", "rw", "sk", "sl", "sm", "sn", "so", "sq", "sr-Cyrl", "sr-Latn", "st", "sv", "sw", "ta", "te", "th", "ti", "tk", "tlh-Latn", "tlh-Piqd", "tn", "to", "tr", "tt", "ty", "ug", "uk", "ur", "uz", "vi", "xh", "yo", "yua", "yue", "zh-Hans", "zh-Hant", "zu"] ``` + Of all the languages that Consul currently has defined (`available_locales`) in `config/application.rb` the only one that is not listed above and therefore no translation service is offered is Valencian `["val"]`. ### Pricing diff --git a/docs/en/features/census_configuration.md b/docs/en/features/census_configuration.md index 5feb0d79b..6a4f5d64e 100644 --- a/docs/en/features/census_configuration.md +++ b/docs/en/features/census_configuration.md @@ -36,6 +36,7 @@ The information to be filled in is divided into three sections: ![Request Data](../../img/remote_census/request-data-en.png) To help you understand how to fill in each of the fields, we will rely on a supposed WebService that receives a method called `:get_habita_datos` with the following structure: + ``` { request: { diff --git a/docs/en/features/oauth.md b/docs/en/features/oauth.md index 92e63f210..097571a2f 100644 --- a/docs/en/features/oauth.md +++ b/docs/en/features/oauth.md @@ -9,7 +9,8 @@ For each platform, go to their developers section and follow their guides to cre ## 2. Set your CONSUL's url They'll ask you for your CONSUL's auth URL, and as you can see running `rake routes` at your CONSUL repo locally: - ```bash + +```bash user_omniauth_authorize GET|POST /users/auth/:provider(.:format) users/omniauth_callbacks#passthru {:provider=>/twitter|facebook|google_oauth2/} ``` diff --git a/docs/en/getting_started/update.md b/docs/en/getting_started/update.md index 1c312dd7a..0d48fcdab 100644 --- a/docs/en/getting_started/update.md +++ b/docs/en/getting_started/update.md @@ -3,6 +3,7 @@ ## Configuring your git remotes If you created your fork correctly and cloned it locally, running: + ```bash git remote -v ``` @@ -42,6 +43,7 @@ git checkout -b upstream ``` Then we can fetch all changes from **consul** remote server with: + ```bash git fetch upstream ``` diff --git a/docs/en/installation/create_deploy_user.md b/docs/en/installation/create_deploy_user.md index 1aedbd7b2..48fd6c4db 100644 --- a/docs/en/installation/create_deploy_user.md +++ b/docs/en/installation/create_deploy_user.md @@ -20,11 +20,13 @@ Let's create a `wheel` group and add the user `jupiter` to this group. Now let's give sudo privileges to the `wheel` group and allow it to not use a password, this is important so that the installer doesn't get stalled waiting for a password. First we open the sudoers file: + ``` sudo visudo -f /etc/sudoers ``` And we add this line at the end: + ``` %wheel ALL=(ALL) NOPASSWD: ALL ``` @@ -32,6 +34,7 @@ And we add this line at the end: Now we need to give the keys of the server to the new user. Don’t close the server terminal window, because you can lock yourself out of your server if there is a mistake. Let's create the necessary directory in the server to upload the public key: + ``` su jupiter cd ~ diff --git a/docs/en/installation/deploying-on-heroku.md b/docs/en/installation/deploying-on-heroku.md index 714814624..e04efb507 100644 --- a/docs/en/installation/deploying-on-heroku.md +++ b/docs/en/installation/deploying-on-heroku.md @@ -179,6 +179,7 @@ heroku config:set RAILS_MAX_THREADS=3 ``` I also recommend to set the following: + ```bash heroku config:set RAILS_SERVE_STATIC_FILES=enabled heroku config:set RAILS_ENV=production diff --git a/docs/es/customization/introduction.md b/docs/es/customization/introduction.md index aaa36416b..f2256991c 100644 --- a/docs/es/customization/introduction.md +++ b/docs/es/customization/introduction.md @@ -71,9 +71,11 @@ Para aclarar el funcionamiento, se adjuntan unos pantallazos de como interactua ### Idiomas disponibles para la traducción remota Actualmente estos son todos los [idiomas disponibles](https://api.cognitive.microsofttranslator.com/languages?api-version=3.0) en el servicio de traducción: + ```yml ["af", "am", "ar", "as", "az", "ba", "bg", "bn", "bo", "bs", "ca", "cs", "cy", "da", "de", "dv", "el", "en", "es", "et", "eu", "fa", "fi", "fil", "fj", "fo", "fr", "fr-CA", "ga", "gl", "gu", "ha", "he", "hi", "hr", "hsb", "ht", "hu", "hy", "id", "ig", "ikt", "is", "it", "iu", "iu-Latn", "ja", "ka", "kk", "km", "kmr", "kn", "ko", "ku", "ky", "ln", "lo", "lt", "lug", "lv", "lzh", "mg", "mi", "mk", "ml", "mn-Cyrl", "mn-Mong", "mr", "ms", "mt", "mww", "my", "nb", "ne", "nl", "nso", "nya", "or", "otq", "pa", "pl", "prs", "ps", "pt", "pt-PT", "ro", "ru", "run", "rw", "sk", "sl", "sm", "sn", "so", "sq", "sr-Cyrl", "sr-Latn", "st", "sv", "sw", "ta", "te", "th", "ti", "tk", "tlh-Latn", "tlh-Piqd", "tn", "to", "tr", "tt", "ty", "ug", "uk", "ur", "uz", "vi", "xh", "yo", "yua", "yue", "zh-Hans", "zh-Hant", "zu"] ``` + De todos los idiomas que actualmente tiene Consul definidos (`available_locales`) en `config/application.rb` el único que no está en la lista anterior y por lo tanto no se ofrece servicio de traducción es el valenciano `["val"]`. ### Costes diff --git a/docs/es/features/census_configuration.md b/docs/es/features/census_configuration.md index 844df85d3..8a571ab4e 100644 --- a/docs/es/features/census_configuration.md +++ b/docs/es/features/census_configuration.md @@ -36,6 +36,7 @@ La información a rellenar esta dividida en tres apartados: ![Request Data](../../img/remote_census/request-data-es.png) Para ayudar a entender como rellenar cada uno de los campos, nos basaremos en un supuesto WebService que recibe un método llamado `:get_habita_datos` con la siguiente estructura: + ``` { request: { diff --git a/docs/es/getting_started/update.md b/docs/es/getting_started/update.md index 209e80978..05763ee78 100644 --- a/docs/es/getting_started/update.md +++ b/docs/es/getting_started/update.md @@ -43,6 +43,7 @@ git checkout -b upstream ``` Y actualiza la información del repositorio de consul con las referencias a las ramas, tags, etc..: + ```bash git fetch upstream ``` diff --git a/docs/es/installation/create_deploy_user.md b/docs/es/installation/create_deploy_user.md index 6abaa5165..5187a2541 100644 --- a/docs/es/installation/create_deploy_user.md +++ b/docs/es/installation/create_deploy_user.md @@ -22,11 +22,13 @@ Creemos un grupo `wheel` y añadamos al usuario `jupiter` al grupo. Ahora démosle al grupo `wheel` derechos de superadministración sin necesidad de usar contraseña, esto es importante para que el instalador no se quede parado esperando una contraseña. Primero debemos abrir el archivo `sudoers`: + ``` sudo visudo -f /etc/sudoers ``` Y añadimos esta línea al final del archivo: + ``` %wheel ALL=(ALL) NOPASSWD: ALL ``` @@ -34,6 +36,7 @@ Y añadimos esta línea al final del archivo: Ahora tenemos que dar las claves del servidor al nuevo usuario. No cierre la ventana de la terminal del servidor, porque puede bloquearse si hay un error. Y escriba los siguientes comandos para crear el archivo necesario donde subir la clave pública: + ``` su jupiter cd ~ diff --git a/docs/es/installation/deploying-on-heroku.md b/docs/es/installation/deploying-on-heroku.md index c21b2f0d9..6f839234f 100644 --- a/docs/es/installation/deploying-on-heroku.md +++ b/docs/es/installation/deploying-on-heroku.md @@ -179,6 +179,7 @@ heroku config:set RAILS_MAX_THREADS=3 ``` También es recomendable configurar las siguientes variables: + ```bash heroku config:set RAILS_SERVE_STATIC_FILES=enabled heroku config:set RAILS_ENV=production