From 0b9be27c8c1223d0a42eb6f58a1cc31de9534cb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javi=20Mart=C3=ADn?= Date: Tue, 18 Jun 2024 21:48:26 +0200 Subject: [PATCH] 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. --- docs/.gitbook.yaml | 5 --- docs/SUMMARY.md | 106 --------------------------------------------- docs/en/SUMMARY.md | 52 ++++++++++++++++++++++ docs/es/SUMMARY.md | 52 ++++++++++++++++++++++ 4 files changed, 104 insertions(+), 111 deletions(-) delete mode 100644 docs/.gitbook.yaml delete mode 100644 docs/SUMMARY.md create mode 100644 docs/en/SUMMARY.md create mode 100644 docs/es/SUMMARY.md diff --git a/docs/.gitbook.yaml b/docs/.gitbook.yaml deleted file mode 100644 index 6acdd6ab6..000000000 --- a/docs/.gitbook.yaml +++ /dev/null @@ -1,5 +0,0 @@ -root: ./ - -structure: - readme: README.md - summary: SUMMARY.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md deleted file mode 100644 index 2cd32b362..000000000 --- a/docs/SUMMARY.md +++ /dev/null @@ -1,106 +0,0 @@ -# Summary - -## ENGLISH Documentation - -* [Getting started](en/getting_started/getting_started.md) - * [Fork Consul Democracy](en/getting_started/create.md) - * [Configure your fork](en/getting_started/configuration.md) - * [Keep your fork updated](en/getting_started/update.md) - * [Communication](en/getting_started/communication.md) - -* [Installation](en/installation/introduction.md) - * [Local installation](en/installation/local_installation.md) - * [Prerequisites](en/installation/prerequisites.md) - * [Ubuntu Linux](en/installation/ubuntu.md) - * [Debian Linux](en/installation/debian.md) - * [MacOS](en/installation/macos.md) - * [Windows](en/installation/windows.md) - * [Vagrant](en/installation/vagrant.md) - * [Production and Staging servers](en/installation/servers.md) - * [Installer](en/installation/installer.md) - * [Create a deploy user](en/installation/create_deploy_user.md) - * [Generating SSH Key](en/installation/generating_ssh_key.md) - * [Manual installation (not recommended)](en/installation/manual_installation_production.md) - * [Digital Ocean](en/installation/digital_ocean.md) - * [Heroku](en/installation/deploying-on-heroku.md) - * [Docker](en/installation/docker.md) - * [Mail Server Configuration](en/installation/mail_server_configuration.md) - * [Basic configuration](en/installation/basic_configuration.md) - * [Consul Democracy Documentation and guides](en/installation/documentation_and_guides.md) - -* [Customization](en/customization/customization.md) - * [Introduction](en/customization/introduction.md) - * [Translations and Texts](en/customization/translations.md) - * [Images](en/customization/images.md) - * [Views and Styles](en/customization/views_and_styles.md) - * [Javascript](en/customization/javascript.md) - * [Models](en/customization/models.md) - * [Components](en/customization/components.md) - * [Gems](en/customization/gems.md) - * [Overwriting Application](en/customization/overwriting.md) - -* [Technical Features](en/features/features.md) - * [OAuth](en/features/oauth.md) - * [GraphQL](en/features/graphql.md) - * [Recommendations](en/features/recommendations.md) - * [Configure Census Connection](en/features/census_configuration.md) - * [Local Census](en/features/local_census.md) - * [Multitenancy](en/features/multitenancy.md) - -* [Open Source project](en/open_source/open_source.md) - * [Code of conduct](en/open_source/code_of_conduct.md) - * [Contributing](en/open_source/contributing.md) - * [License](es/open_source/license.md) - -## SPANISH Documentation - -* [Introducción](es/README.md) -* [Primeros pasos](es/getting_started/getting_started.md) - * [Crea tu fork](es/getting_started/create.md) - * [Configura tu fork](es/getting_started/configuration.md) - * [Manten tu fork actualizado](es/getting_started/update.md) - * [Comunicación](es/getting_started/communication.md) - -* [Instalación](es/installation/introduction.md) - * [Instalación local](es/installation/local_installation.md) - * [Prerrequisitos](es/installation/prerequisites.md) - * [Ubuntu Linux](es/installation/ubuntu.md) - * [Debian Linux](es/installation/debian.md) - * [MacOS](es/installation/macos.md) - * [Windows](es/installation/windows.md) - * [Vagrant](es/installation/vagrant.md) - * [Servidores de producción y pruebas](es/installation/servers.md) - * [Instalador](es/installation/installer.md) - * [Crear usuario](es/installation/create_deploy_user.md) - * [Generación de claves SSH](es/installation/generating_ssh_key.md) - * [Instalación manual (no recomendada)](es/installation/manual_installation_production.md) - * [Digital Ocean](es/installation/digital_ocean.md) - * [Heroku](es/installation/deploying-on-heroku.md) - * [Docker](es/installation/docker.md) - * [Configuración del servidor de correo](es/installation/mail_server_configuration.md) - * [Configuración básica](es/installation/basic_configuration.md) - * [Documentación y guías sobre Consul Democracy](es/installation/documentation_and_guides.md) - -* [Personalización](es/customization/customization.md) - * [Introducción](es/customization/introduction.md) - * [Traducciones y Textos](es/customization/translations.md) - * [Imágenes](es/customization/images.md) - * [Vistas y Estilos](es/customization/views_and_styles.md) - * [Javascript](es/customization/javascript.md) - * [Modelos](es/customization/models.md) - * [Componentes](es/customization/components.md) - * [Gemas](es/customization/gems.md) - * [Adaptar la aplicación](es/customization/overwriting.md) - -* [Funcionalidades Técnicas](es/features/features.md) - * [OAuth](es/features/oauth.md) - * [GraphQL](es/features/graphql.md) - * [Recomendaciones](es/features/recommendations.md) - * [Configurar conexión con el Censo](es/features/census_configuration.md) - * [Local Census](es/features/local_census.md) - * [Multitenancy](es/features/multitenancy.md) - -* [Proyecto Open Source](es/open_source/open_source.md) - * [Código de conducta](es/open_source/code_of_conduct.md) - * [Contribuciones](es/open_source/contributing.md) - * [Licencia](es/open_source/license.md) diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md new file mode 100644 index 000000000..2df22b916 --- /dev/null +++ b/docs/en/SUMMARY.md @@ -0,0 +1,52 @@ +# Summary + +* [Introduction](README.md) +* [Getting started](getting_started/getting_started.md) + * [Fork Consul Democracy](getting_started/create.md) + * [Configure your fork](getting_started/configuration.md) + * [Keep your fork updated](getting_started/update.md) + * [Communication](getting_started/communication.md) + +* [Installation](installation/introduction.md) + * [Local installation](installation/local_installation.md) + * [Prerequisites](installation/prerequisites.md) + * [Ubuntu Linux](installation/ubuntu.md) + * [Debian Linux](installation/debian.md) + * [MacOS](installation/macos.md) + * [Windows](installation/windows.md) + * [Vagrant](installation/vagrant.md) + * [Production and Staging servers](installation/servers.md) + * [Installer](installation/installer.md) + * [Create a deploy user](installation/create_deploy_user.md) + * [Generating SSH Key](installation/generating_ssh_key.md) + * [Manual installation (not recommended)](installation/manual_installation_production.md) + * [Digital Ocean](installation/digital_ocean.md) + * [Heroku](installation/deploying-on-heroku.md) + * [Docker](installation/docker.md) + * [Mail Server Configuration](installation/mail_server_configuration.md) + * [Basic configuration](installation/basic_configuration.md) + * [Consul Democracy Documentation and guides](installation/documentation_and_guides.md) + +* [Customization](customization/customization.md) + * [Introduction](customization/introduction.md) + * [Translations and Texts](customization/translations.md) + * [Images](customization/images.md) + * [Views and Styles](customization/views_and_styles.md) + * [Javascript](customization/javascript.md) + * [Models](customization/models.md) + * [Components](customization/components.md) + * [Gems](customization/gems.md) + * [Overwriting Application](customization/overwriting.md) + +* [Technical Features](features/features.md) + * [OAuth](features/oauth.md) + * [GraphQL](features/graphql.md) + * [Recommendations](features/recommendations.md) + * [Configure Census Connection](features/census_configuration.md) + * [Local Census](features/local_census.md) + * [Multitenancy](features/multitenancy.md) + +* [Open Source project](open_source/open_source.md) + * [Code of conduct](open_source/code_of_conduct.md) + * [Contributing](open_source/contributing.md) + * [License](open_source/license.md) diff --git a/docs/es/SUMMARY.md b/docs/es/SUMMARY.md new file mode 100644 index 000000000..7b22c338f --- /dev/null +++ b/docs/es/SUMMARY.md @@ -0,0 +1,52 @@ +# Summary + +* [Introducción](README.md) +* [Primeros pasos](getting_started/getting_started.md) + * [Crea tu fork](getting_started/create.md) + * [Configura tu fork](getting_started/configuration.md) + * [Manten tu fork actualizado](getting_started/update.md) + * [Comunicación](getting_started/communication.md) + +* [Instalación](installation/introduction.md) + * [Instalación local](installation/local_installation.md) + * [Prerrequisitos](installation/prerequisites.md) + * [Ubuntu Linux](installation/ubuntu.md) + * [Debian Linux](installation/debian.md) + * [MacOS](installation/macos.md) + * [Windows](installation/windows.md) + * [Vagrant](installation/vagrant.md) + * [Servidores de producción y pruebas](installation/servers.md) + * [Instalador](installation/installer.md) + * [Crear usuario](installation/create_deploy_user.md) + * [Generación de claves SSH](installation/generating_ssh_key.md) + * [Instalación manual (no recomendada)](installation/manual_installation_production.md) + * [Digital Ocean](installation/digital_ocean.md) + * [Heroku](installation/deploying-on-heroku.md) + * [Docker](installation/docker.md) + * [Configuración del servidor de correo](installation/mail_server_configuration.md) + * [Configuración básica](installation/basic_configuration.md) + * [Documentación y guías sobre Consul Democracy](installation/documentation_and_guides.md) + +* [Personalización](customization/customization.md) + * [Introducción](customization/introduction.md) + * [Traducciones y Textos](customization/translations.md) + * [Imágenes](customization/images.md) + * [Vistas y Estilos](customization/views_and_styles.md) + * [Javascript](customization/javascript.md) + * [Modelos](customization/models.md) + * [Componentes](customization/components.md) + * [Gemas](customization/gems.md) + * [Adaptar la aplicación](customization/overwriting.md) + +* [Funcionalidades Técnicas](features/features.md) + * [OAuth](features/oauth.md) + * [GraphQL](features/graphql.md) + * [Recomendaciones](features/recommendations.md) + * [Configurar conexión con el Censo](features/census_configuration.md) + * [Local Census](features/local_census.md) + * [Multitenancy](features/multitenancy.md) + +* [Proyecto Open Source](open_source/open_source.md) + * [Código de conducta](open_source/code_of_conduct.md) + * [Contribuciones](open_source/contributing.md) + * [Licencia](open_source/license.md)