diff --git a/docs/assets/portal-andino-asig-recurso.png b/docs/assets/portal-andino-asig-recurso.png deleted file mode 100644 index 06e23706..00000000 Binary files a/docs/assets/portal-andino-asig-recurso.png and /dev/null differ diff --git a/docs/assets/portal-andino-asig-tags.png b/docs/assets/portal-andino-asig-tags.png deleted file mode 100644 index b2f3372d..00000000 Binary files a/docs/assets/portal-andino-asig-tags.png and /dev/null differ diff --git a/docs/assets/portal-andino-campos-avanzados.jpg b/docs/assets/portal-andino-campos-avanzados.jpg deleted file mode 100644 index c7a066b7..00000000 Binary files a/docs/assets/portal-andino-campos-avanzados.jpg and /dev/null differ diff --git a/docs/assets/portal-andino-campos-especiales.jpg b/docs/assets/portal-andino-campos-especiales.jpg deleted file mode 100644 index 4ffd0a71..00000000 Binary files a/docs/assets/portal-andino-campos-especiales.jpg and /dev/null differ diff --git a/docs/assets/portal-andino-comoveo-org.png b/docs/assets/portal-andino-comoveo-org.png deleted file mode 100644 index 7631da95..00000000 Binary files a/docs/assets/portal-andino-comoveo-org.png and /dev/null differ diff --git a/docs/assets/portal-andino-crear-dataset.png b/docs/assets/portal-andino-crear-dataset.png deleted file mode 100644 index 0cafc3f7..00000000 Binary files a/docs/assets/portal-andino-crear-dataset.png and /dev/null differ diff --git a/docs/assets/portal-andino-crear-org.png b/docs/assets/portal-andino-crear-org.png deleted file mode 100644 index 34d7b206..00000000 Binary files a/docs/assets/portal-andino-crear-org.png and /dev/null differ diff --git a/docs/assets/portal-andino-dat-tags.png b/docs/assets/portal-andino-dat-tags.png deleted file mode 100644 index d11bc58a..00000000 Binary files a/docs/assets/portal-andino-dat-tags.png and /dev/null differ diff --git a/docs/assets/portal-andino-form-temas.png b/docs/assets/portal-andino-form-temas.png deleted file mode 100644 index 863e0a1e..00000000 Binary files a/docs/assets/portal-andino-form-temas.png and /dev/null differ diff --git a/docs/assets/portal-andino-header.png b/docs/assets/portal-andino-header.png deleted file mode 100644 index c5cc60ed..00000000 Binary files a/docs/assets/portal-andino-header.png and /dev/null differ diff --git a/docs/assets/portal-andino-login.png b/docs/assets/portal-andino-login.png deleted file mode 100644 index 177cec9c..00000000 Binary files a/docs/assets/portal-andino-login.png and /dev/null differ diff --git a/docs/assets/portal-andino-metadatos.jpg b/docs/assets/portal-andino-metadatos.jpg deleted file mode 100644 index ee4906cd..00000000 Binary files a/docs/assets/portal-andino-metadatos.jpg and /dev/null differ diff --git a/docs/assets/portal-andino-sec-acerca-02.png b/docs/assets/portal-andino-sec-acerca-02.png deleted file mode 100644 index 1a330387..00000000 Binary files a/docs/assets/portal-andino-sec-acerca-02.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-acerca-03.png b/docs/assets/portal-andino-sec-acerca-03.png deleted file mode 100644 index e1387eb5..00000000 Binary files a/docs/assets/portal-andino-sec-acerca-03.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-acerca-04.png b/docs/assets/portal-andino-sec-acerca-04.png deleted file mode 100644 index fdac5fe7..00000000 Binary files a/docs/assets/portal-andino-sec-acerca-04.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-acerca.png b/docs/assets/portal-andino-sec-acerca.png deleted file mode 100644 index 875d24b0..00000000 Binary files a/docs/assets/portal-andino-sec-acerca.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-config.png b/docs/assets/portal-andino-sec-config.png deleted file mode 100644 index 2c9b8f39..00000000 Binary files a/docs/assets/portal-andino-sec-config.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-org-02.png b/docs/assets/portal-andino-sec-org-02.png deleted file mode 100644 index be9f3222..00000000 Binary files a/docs/assets/portal-andino-sec-org-02.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-org.png b/docs/assets/portal-andino-sec-org.png deleted file mode 100644 index 63afca86..00000000 Binary files a/docs/assets/portal-andino-sec-org.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-temas-02.png b/docs/assets/portal-andino-sec-temas-02.png deleted file mode 100644 index a69be9ec..00000000 Binary files a/docs/assets/portal-andino-sec-temas-02.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-temas-03.png b/docs/assets/portal-andino-sec-temas-03.png deleted file mode 100644 index f19afc37..00000000 Binary files a/docs/assets/portal-andino-sec-temas-03.png and /dev/null differ diff --git a/docs/assets/portal-andino-sec-temas.png b/docs/assets/portal-andino-sec-temas.png deleted file mode 100644 index 3df389c6..00000000 Binary files a/docs/assets/portal-andino-sec-temas.png and /dev/null differ diff --git a/docs/assets/portal-andino-user.png b/docs/assets/portal-andino-user.png deleted file mode 100644 index f37beb15..00000000 Binary files a/docs/assets/portal-andino-user.png and /dev/null differ diff --git a/docs/guia_uso_portal_andino.md b/docs/guia_uso_portal_andino.md index ff5f132a..2d1e0e45 100644 --- a/docs/guia_uso_portal_andino.md +++ b/docs/guia_uso_portal_andino.md @@ -1,399 +1,4 @@ ![alt text](assets/portal-andino-header.png "Header") # Guía de uso Portal Andino - - - - -- [Primeros pasos](#primeros-pasos) -- [Entrar y salir de tu portal](#entrar-y-salir-de-tu-portal) -- [Permisos de usuarios](#permisos-de-usuario) -- [Elementos de tu portal](#elementos-de-tu-portal) - - [Organizaciones](#organizaciones) - - [Sección Organizaciones con datos](#secci%C3%B3n-organizaciones-con-datos) - - [Sección Acerca](#acerca) - - [Temas](#temas) - - [Datasets](#datasets) - - [Recursos](#recursos) - - [Campos de un recurso](#campos-de-un-recurso) - - [Series de tiempo](#series-de-tiempo) - - [Etiquetas](#etiquetas) -- [Personalizar el portal](#personalizar-el-portal) -- [Integrar Andino con Google Analytics](#integrar-andino-con-google-analytics) -- [Consultas sobre Andino](#consultas-sobre-andino) -- [Otros contenidos útiles](#otros-contenidos-%C3%BAtiles) - - - -## Primeros pasos - -**¡Un aplauso, ya estás abriendo tus datos!** - -Esta guía te ayudará a: - -* Conocer los elementos del catálogo e identificar dónde se ven en el portal. -* Personalizar el portal. -* Crear datasets, recursos, organizaciones y temas. -* Asignar permisos de usuarios. -* Integrar con Google Analytics. - - -

¡Arranquemos!

- -*** - -## Entrar y salir de tu portal - -**Cada vez que quieras entrar al portal, podrás hacerlo desde http://*tu-url.com*/ingresar**. - -![alt text](assets/portal-andino-login.png "login") - -*** - -## Permisos de usuario - -Desde agosto de 2017, en Andino **hay dos tipos de usuarios: los administradores y los colaboradores**. El primer usuario administrador siempre es creado por el técnico en sistemas que instaló Andino. - -**Los administradores de Andino pueden invitar a más personas a colaborar** en la apertura de datos, **eligiendo el tipo que quieren asignar**: - -* **Administrador**: podrá crear usuarios, editar la configuración general del portal; crear, actualizar y borrar todos los datasets; y gestionar temas y organizaciones. - -* **Colaborador**: podrá crear, actualizar y borrar datasets sólo de las organizaciones que tenga asignadas (por eso es importante que primero crees en tu Andino las organizaciones en las que necesitás colaboradores). - -**Asigná permisos desde Mi cuenta > Crear usuarios**. - -![alt text](assets/portal-andino-user.png "user") - -*** - -## Elementos de tu portal - -### Organizaciones - -Son los organismos que abren o mantienen cada dataset. **Es muy importante que crees las organizaciones antes de que generes un dataset** que esté asociado a ella. - -##### ¿Dónde lo veo en el portal? - -* Como uno de los filtros de la vista de Datasets. - -* Como número agregado, en la Página principal de tu portal, en caso de que hayas elegido la vista que muestra el número de Organizaciones con datos. - -![alt text](assets/portal-andino-comoveo-org.png "comoveo-org") - -##### Buenas prácticas al crear Organizaciones con datos - -Tené en cuenta que **siempre que borres una organización, todos los conjuntos de datos (y también los recursos), se borrarán** definitivamente. - -##### ¿Cómo los creo? - -Andá a **Página principal > Crear Organizaciones**. - -![alt text](assets/portal-andino-crear-org.png "crear-org") - -En caso de que hayas elegido que tu portal tenga una sección de Organizaciones con datos, también se mostrarán allí. - -![alt text](assets/portal-andino-sec-org.png "sec-org") - -*** -### Sección Organizaciones con datos - -**Esta sección es opcional**. Te permite armar un árbol de jerarquías con las organizaciones que abrieron datos en tu portal. Los organismos que se muestran en esta parte de tu portal son los mismos que asignás a los datasets y que creas antes de generar estos últimos. - -##### ¿Dónde lo veo en el portal? - -En Página principal > **Organizaciones con datos**. - -##### Buenas prácticas al crear la sección Organizaciones con datos - -Es importante que tengas bien en claro qué organizaciones dependenden de otras, para que el árbol de jerarquías represente bien las correspondencias. - -##### ¿Cómo las creo? - -Como la sección Organizaciones con datos es opcional, podés elegir que se vea en tu portal. Para eso, **andá a Configuraciones > Organizaciones con datos** y tildá la habilitación. - -![alt text](assets/portal-andino-sec-org-02.png "sec-op-org") - -*** -### Sección Acerca - -**Esta sección es opcional**. Te permite darle la oportunidad a los usuarios que naveguen tu portal de leer información del mismo para un mejor entendimiento. - -#### Tipos de Acerca - -Existen tres tipos diferentes que vas a poder elegir: - -* **Sin sección de acerca**: para cuando se decida no mostrar información. - -* **Sección con información básica**: existirá un botón que lleve al usuario a una página donde encontrará información básica sobre el portal (un título y una descripción). Estará ubicado en Página Principal > **Acerca**. - -* **Secciones personalizadas**: se crearán varias secciones personalizadas que vas a poder modificar a gusto. El botón Acerca ahora desplegará un menú que contendrá todas y cada una de las secciones que hayas añadido al portal. Para cada sección, se necesitará un archivo (de formato .html) con el contenido que quieras mostrar. - -#### ¿Cómo elijo el tipo de Acerca? - -Andá a Página Principal > Usuario > Configuración > **Otras secciones del portal > Acerca (opcional)** - -![alt text](assets/portal-andino-sec-acerca.png "sec-acerca") - -![alt text](assets/portal-andino-sec-acerca-02.png "sec-acerca-02") - -#### ¿Cómo puedo escribir y mostrar información básica? - -Habiendo elegido la **segunda opción**, podés modificar el título y la descripción. - -![alt text](assets/portal-andino-sec-acerca-03.png "sec-acerca-03") - -#### ¿Cómo puedo crear y mostrar mis secciones personalizadas? - -Habiendo elegido la **tercera opción**, podrás ir creando tus secciones escribiendo un título y un nombre de archivo. Recordá que, para cada sección, será necesario guardar un archivo (de formato .html) para que el portal pueda mostrar su contenido. - -![alt text](assets/portal-andino-sec-acerca-04.png "sec-acerca-04") - -#### ¿Dónde añado los archivos requeridos para las secciones? - -Dentro del container, dichos archivos deben ser guardados en el directorio **/var/lib/ckan/theme_config/templates/** . - -De no existir la carpeta **/templates**, se deberá crearla utilizando dos comandos: - -* mkdir /var/lib/ckan/theme_config/templates - -* chown www-data:www-data /var/lib/ckan/theme_config/templates/ - -(www-data es el usuario con el que se corre el proceso apache en el sistema operativo **Ubuntu**) - -Dentro de cada archivo deberá estar el contenido de su sección correspondiente. Por favor, **no te olvides** de que el nombre del archivo **debe coincidir** con lo escrito en el campo 'Nombre del archivo' de la sección. - -#### ¿Dónde y cómo puedo guardar imágenes para mostrarlas en mis secciones? ¿Cómo las muestro en mis templates? - -Dentro del container, las imágenes deben ser guardadas en una carpeta llamada "user_images". - -Para poder copiar y pegar una imagen en dicha carpeta existe un comando que podés usar, pero primero tenés que hacer tres cosas: - -* Dentro del contenedor, ejecutar este comando: -``` -chown www-data:www-data /usr/lib/ckan/default/src/ckanext-gobar-theme/ckanext/gobar_theme/public/user_images/ -``` - -* En caso de que hayas cambiado manualmente el puerto del contenedor, saber cuál es (el default es 8080) - -* Tener preparado el nombre del contenedor (ya que queremos decirle al comando en qué lugar vamos a guardar la imagen) - -El nombre del contenedor se consigue escribiendo en una terminal dentro del host: -``` -sudo docker-compose -f latest.yml ps |grep -``` - -Sólo nos queda guardar la imagen: -``` -docker cp :/usr/lib/ckan/default/src/ckanext-gobar-theme/ckanext/gobar_theme/public/user_images/ -``` - -Supongamos que guardaste una imagen llamada 'mi_imagen.png'; para poder utilizarla, podés escribir dentro de tu template esta línea (completa): -``` - -``` - -*** -### Temas - -Son las categorías en las que se pueden clasificar todos los datasets de tu portal. Hay dos taxonomías de temas: - -* **Temas globales**, que ya vienen con Andino, y que necesitás elegir para cada dataset. Estos temas no se ven en tu portal, pero es necesario que lo elijas para que el portal nacional datos.gob.ar pueda republicar el dataset según esta clasificación. Por ejemplo: “Economía y finanzas”. - -* **Temas específicos**, que son opcionales, pero que te recomendamos con énfasis que agregues a todos tus conjuntos de datos porque son los temas que van a ver tus usuarios. Por ejemplo, si el tema global era “Economía y finanzas”, un tema específico podría ser “Compras”. - - -##### ¿Dónde lo veo en el portal? - -* En la Página principal de tu catálogo de datos. - -* También como detalle de cada dataset específico. - -![alt text](assets/portal-andino-sec-temas.png "sec-temas") - -##### Buenas prácticas al crear Temas específicos - -* Intentá crear los temas específicos a conciencia para poder reutilizarlos a futuro. -* No crees un tema específico por cada dataset. -* Asegurate de que cada tema específico sea un aparte más pequeña dentro de los Temas globales. - -##### ¿Cómo los creo? - -**Andá a Página principal > Crear tema**. - -![alt text](assets/portal-andino-sec-temas-03.png "sec-temas-03") - -##### ¿Cómo los asigno? - -**Cada vez que generes un nuevo dataset**, el formulario te pedirá que asignes temas. Recordá siempre reutilizar los que ya hayas creado y no repetirlos. - -![alt text](assets/portal-andino-form-temas.png "form-temas") -*** -### Datasets - -También los llamamos “conjuntos de datos”. Son la pieza principal de tu portal o catálogo de datos. Cada dataset está formado por uno o más recursos. - -##### ¿Dónde los veo en el portal? - -Todos los datasets que subas al portal se verán **en la sección Datasets**. Además, **podrás destacar** los que creas más importantes en la Página principal. - -![alt text](assets/portal-andino-sec-temas-02.png "sec-temas-2") - -##### Buenas prácticas al crear datasets - -* **Títulos de los datasets**: es el primer vistazo que los usuarios tendrán sobre su contenido. Por eso, intentá no superar los 100 caracteres. Prestá especial atención a las mayúsculas. Sólo los sustantivos propios las necesitan. - -* **Descripción de los datasets**: es el detalle que le contás a los usuarios. Por esa razón, es importante que trates de dar una explicación general de los datos con los que se va a encontrar. Intentá no superar los 500 caracteres. - -##### ¿Cómo los creo? - -Ingresá a tu cuenta y andá a **Página principal > Crear dataset**. - -![alt text](assets/portal-andino-crear-dataset.png "crear-dat") - -**Siempre podrás editar los dataset** que hayas creado. Para eso, ingresá a tu cuenta > Página principal > Datasets > **Editar dataset**. -*** -### Recursos - -Cada dataset está formado por, al menos, un recurso. Por eso decimos que los recursos son la pieza de información más pequeña del catálogo y los verdaderos activos de datos del portal. - -#### ¿Dónde los veo en el portal? - -Página principal > Datasets > Clic en el recurso específico. - -#### Buenas prácticas al crear recursos -Seguí los mismos criterios de escritura que con los datasets. - -* **Títulos de los recursos**: intentá no superar los 150 caracteres. - -* **Descripción de los recursos**: intentá no superar los 200 caracteres. - -#### ¿Cómo los creo? - -Ingresá a tu cuenta y andá a Página principal > Crear dataset. Una vez que completes el dataset, podrás agregar recursos. - -![alt text](assets/portal-andino-asig-recurso.png "crear-recurso") - -Al igual que con los datasets, siempre podrás editar los recursos que hayas creado. Para eso, ingresá a tu cuenta > Página principal > Datasets > Editar dataset > Editar recursos. -*** -### Campos de un recurso - -Los recursos pueden tener mucha información y ser difíciles de comprender, para ayudar a los usuarios que ven nuestros recursos, Andino permite documentar qué contiene cada campo. - -#### ¿Dónde los veo en el portal? - -Los recursos que tengan información sobre sus campos se visualizarán en la vista de un recurso. - -![alt text](assets/portal-andino-metadatos.jpg "metadatos") - -#### Buenas prácticas al cargar campos de un recurso - -Puede ser de mucha ayuda para los usuarios que siempre cargues al menos los siguientes campos: -- Título de la columna -- Tipo de dato -- Descripción - -También podés usar estos campos para documentar aspectos más avanzados de las columnas de un recurso: -- Unidad de medida -- Identificador -- Tipo de dato especial -- Detalle de tipo especial - -*** - -### Series de tiempo - -Andino permite documentar recursos que publican ** series de tiempo **. - -#### ¿Cómo documento una serie de tiempo? -En el formulario de carga de un recurso vas a encontrar campos avanzados y especiales que necesitás usar para documentar las columnas de una tabla que contiene series de tiempo. - -Los campos **Tipo de dato especial** y **Detalle de tipo especial** te permiten marcar la columna del índice de tiempo y qué frecuencia tiene. - -![alt text](assets/portal-andino-campos-especiales.jpg "campos-especiales") - -Los campos **Unidad de medida **e** Identificador** te permiten documentar cada una de las columnas que son series de tiempo. - -![alt text](assets/portal-andino-campos-avanzados.jpg "campos-avanzados") - -Para conocer más sobre series de tiempo mirá la [documentación completa](http://paquete-apertura-datos.readthedocs.io/es/stable/guia_metadatos.html#series-de-tiempo "documentación completa") en el perfil de metadatos. - -*** - -### Etiquetas - -Son las palabras que ayudan a los usuarios a filtrar y encontrar los datasets. Cuanto más amplia y uniforme sea la lista de Etiquetas, mayor es su poder de ayuda. - -##### ¿Dónde las veo en el portal? - -En cada dataset específico. - -![alt text](assets/portal-andino-dat-tags.png "dat-tags") - -##### Buenas prácticas al crear etiquetas - -* Usá mayúsculas sólo donde corresponda. -* Identificá palabras claves. -* Respetá las etiquetas anteriores. -* Agregá sinónimos y usá lenguaje natural. -* Tratá de usar una sola palabra, siempre en plural. -* Si la etiqueta tiene más de una palabra, separalas por un espacio. Por ejemplo: “declaraciones juradas”. - -Estas son algunas preguntas útiles a la hora de pensar las etiquetas: - -* ¿Cuál es el tema? -* ¿Qué aspectos serán de interés para los usuarios? -* ¿De qué otro modo buscaría el usuario esta información? -* ¿De qué tipo de información se trata? -* ¿Qué área la provee? - -##### ¿Cómo los creo? - -Al igual que con los Temas, cada vez que generes un nuevo dataset, el formulario te pedirá que asignes un etiqueta. Recordá siempre reutilizar las que ya hayas creado y no repetirlas. - -![alt text](assets/portal-andino-asig-tags.png "crear-etiquetas") - -*** -### Personalizar el portal - -Hacer que tu portal represente tu organización es muy fácil. Por favor, **andá a la Página principal > Configuración**. Llegarás a la sección que te permite cambiar cómo luce la portada de tu catálogo de datos y cada sección en particular. - -![alt text](assets/portal-andino-sec-config.png "sec-config") - -*** - -## Integrar Andino con Google Analytics - -Por favor, [escribinos](mailto:datos@modernizacion.gob.ar) y contanos con qué casilla de e-mail querés tener permisos para ver las métricas de tu Andino. - -*** - -## Consultas sobre Andino - -**Andino es un portal abierto en constante desarrollo** para ser usado por toda la comunidad de datos. Por eso, cuando incorporamos una nueva mejora, **cuidamos mucho su compatibilidad con la versión anterior**. - -Como la comunidad de datos es grande, **por ahora no podemos dar soporte técnico frente a modificaciones particulares del código**. Sin embargo, **podés contactarnos para despejar dudas**. - -Te invitamos a crear issues o enviarnos sugerencias en caso de que encuentren algún _bug_ o _tengas feedback_. También podés mandarnos tu comentario o consulta a datos@modernizacion.gob.ar - -*** - -## Otros contenidos útiles - -* Guía para el uso y la publicación de metadatos - -* Guía para la identificación y uso de entidades interoperables - -* Guía para la publicación de datos en formatos abiertos - - - - - - - - - - - - - +Ver la guía de uso en la documentación oficial de [Portal Andino](http://portal-andino.readthedocs.io/es/latest/). \ No newline at end of file