Merge pull request #80 from rockandror/docs-local-census
Add local census management documentation
@@ -41,6 +41,7 @@
|
||||
* [OAuth](en/features/oauth.md)
|
||||
* [GraphQL](en/features/graphql.md)
|
||||
* [Recommendations](en/features/recommendations.md)
|
||||
* [Local Census](en/features/local_census.md)
|
||||
|
||||
* [Open Source project](en/open_source/open_source.md)
|
||||
* [Code of conduct](en/open_source/code_of_conduct.md)
|
||||
@@ -90,6 +91,7 @@
|
||||
* [OAuth](es/features/oauth.md)
|
||||
* [GraphQL](es/features/graphql.md)
|
||||
* [Recomendaciones](es/features/recommendations.md)
|
||||
* [Local Census](es/features/local_census.md)
|
||||
|
||||
* [Proyecto Open Source](es/open_source/open_source.md)
|
||||
* [Código de conducta](es/open_source/code_of_conduct.md)
|
||||
|
||||
@@ -3,3 +3,4 @@
|
||||
* [OAuth](oauth.md)
|
||||
* [GraphQL](graphql.md)
|
||||
* [Recommendations](recommendations.md)
|
||||
* [Local Census](local_census.md)
|
||||
|
||||
30
docs/en/features/local_census.md
Normal file
@@ -0,0 +1,30 @@
|
||||
##Local Census
|
||||
|
||||
To provide to administrator users a way to manage the local census database through the administration panel **Settings > Manage local census**. Currently the only way to manipulate this table records is through the rails console.
|
||||
|
||||
Allow adiministrators users to manage this table in two different ways:
|
||||
|
||||
- **Manually**: one by one through a CRUD interface.
|
||||
- **Automatically**: through an importation process.
|
||||
|
||||
#### Manually
|
||||
Provide a way to manage local census records to administrator users through administration interface.
|
||||
|
||||
- Local Census Page
|
||||

|
||||
- Add new record
|
||||

|
||||
|
||||
Features:
|
||||
|
||||
1. Search by document_number: As local_census_records could contain a lot of records we have added a search feature to allow administrators to find existing records by document_number.
|
||||
1. Avoid the introduction of duplicated records: A model validation has been added to the following attributes pair [:document_number, :document_type]
|
||||
|
||||
#### Automatically
|
||||
Allow administrator users to import local census records though CSV file.
|
||||
|
||||
- Local Census Page
|
||||

|
||||
|
||||
- Import CSV
|
||||

|
||||
@@ -3,3 +3,4 @@
|
||||
* [OAuth](oauth.md)
|
||||
* [GraphQL](graphql.md)
|
||||
* [Recomendaciones](recommendations.md)
|
||||
* [Censo Local](local_census.md)
|
||||
|
||||
30
docs/es/features/local_census.md
Normal file
@@ -0,0 +1,30 @@
|
||||
##Censo Local
|
||||
|
||||
Proporcionar a los usuarios administradores una forma de gestionar la base de datos del censo local a través del panel de administración **Configuración > Gestionar censo local**. Actualmente la única manera de manipular los registros de esta tabla es a través de la consola de rails.
|
||||
|
||||
Permitir a los usuarios de administradores gestionar esta tabla de dos maneras diferentes:
|
||||
|
||||
- **Manualmente**: uno por uno a través de una interfaz CRUD.
|
||||
- **Automáticamente**: a través de un proceso de importación.
|
||||
|
||||
#### Manualmente
|
||||
Provide a way to manage local census records to administrator users through administration interface.
|
||||
|
||||
- Página de censo local
|
||||

|
||||
- Añadir un nuevo registro
|
||||

|
||||
|
||||
Funcionalidades:
|
||||
|
||||
1. Búsqueda por número_de_documento: Como local_census_records podría contener muchos registros, hemos añadido una función de búsqueda para permitir a los administradores encontrar los registros existentes por número de documento.
|
||||
1. Evitar la introducción de registros duplicados: Se ha añadido una validación de modelo al siguiente par de atributos [:número_de_documento, :tipo_de_documento]
|
||||
|
||||
#### Automáticamente
|
||||
Permite a los usuarios administradores importar registros del censo local a través de un archivo CSV.
|
||||
|
||||
- Página de censo local
|
||||

|
||||
|
||||
- Página para importar un CSV
|
||||

|
||||
BIN
docs/img/local_census/add-local-census-record-en.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
docs/img/local_census/add-local-census-record-es.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
docs/img/local_census/add-local-census-records-csv-en.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/img/local_census/add-local-census-records-csv-es.png
Normal file
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/img/local_census/manage-local-census-csv-en.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
docs/img/local_census/manage-local-census-csv-es.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/img/local_census/manage-local-census-en.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/img/local_census/manage-local-census-es.png
Normal file
|
After Width: | Height: | Size: 22 KiB |