Skip to content

Commit

Permalink
Add admin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertoMoreta committed Mar 7, 2024
1 parent be82ea3 commit 8ad2031
Show file tree
Hide file tree
Showing 14 changed files with 169 additions and 5 deletions.
7 changes: 7 additions & 0 deletions documentation/admin/docs/assets/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
h2 {
color: #BD74CC;
}

.header-icon {
display: none; /* Hide the icon in the navigation bar */
}
Binary file added documentation/admin/docs/assets/editar_perfil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/admin/docs/assets/prerregistro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions documentation/admin/docs/es/guia_de_usuario.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Guía de usuario
La guía que estás leyendo contiene información relaccionada con la administración de mercados. Si quieres consultar la
guía de usuario puedes acceder pulsando [aquí](/docs/user/).
16 changes: 16 additions & 0 deletions documentation/admin/docs/es/menu_lateral/categorias.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,20 @@ icon: material/label
---

# Gestionar categorías
Desde esta pantalla podrás gestionar las categorías relacionadas con el Mercado que gestionas.


## :fontawesome-solid-plus: Añadir categoría
Haciendo click en el botón "Nueva Categoría" accederás a la pantalla para añadir una nueva categoría.
En esta pantalla se te pedirán varios datos:

- Nombre de la categoría
- Color de la etiqueta: Puedes utilizar el selector de color que se encuentra a la derecha del campo.
- Descripción de la categoría

Una vez rellenados los campos obligatorios, pulsa el botón "Crear categoría" para añadir la categoría.


## :fontawesome-solid-pen: :fontawesome-solid-trash: Editar o eliminar categorías
Para editar o eliminar una categoría ponte en contacto con el equipo de administración.

6 changes: 4 additions & 2 deletions documentation/admin/docs/es/menu_lateral/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

# Menú lateral

![Menú Lateral](../../assets/menu_lateral_mercado.png){ align=left width=200px loading=lazy }

El Menú Lateral de la aplicación proporciona acceso rápido y sencillo a las distintas secciones del Mercado Social que estás administrando. A continuación, se detallan los elementos presentes en el menú, dispuestos de arriba a abajo:

/// admonition | Versión móvil
Expand All @@ -22,13 +24,13 @@ En la sección de Noticias, podrás gestionar las novedades y comunicados del Me
Para la organización de las entidades del mercado, esta sección te permite gestionar las categorías asociadas a las proveedoras. Puedes añadir, editar o eliminar categorías, las cuales son fundamentales para indicar el tipo de servicios ofrecidos o el sector al que pertenecen.

## :material-store: [Proveedoras](proveedoras.md)
En esta área, puedes administrar las entidades proveedoras, ya sean empresas o comercios presentes en el mercado. Añade, edita o elimina proveedoras para mantener actualizada la lista de participantes.
En esta sección puedes administrar las entidades proveedoras. Añade, edita o elimina proveedoras para mantener actualizada la lista de participantes.

## :material-walk: [Consumidoras](consumidoras.md)
Aquí se gestiona la información relacionada con las entidades consumidoras. Puedes llevar a cabo acciones como añadir, editar o eliminar perfiles de consumidoras, reflejando así la base de clientes que participan en el mercado.

## :material-basket: [Ofertas](ofertas.md)
La sección de Ofertas te permite gestionar las promociones ofrecidas por las entidades proveedoras. Añade, edita o elimina ofertas para informar a las consumidoras sobre beneficios y descuentos disponibles en el mercado.
La sección de Ofertas te permite gestionar las promociones ofrecidas por las entidades proveedoras. Las ofertas sirven para informar sobre beneficios y descuentos disponibles que ofrecen las entidades proveedoras.

## :material-ticket: [Ventajas](ventajas.md)
En esta área, puedes gestionar las ventajas exclusivas ofrecidas a las personas socias del Mercado Social, tanto proveedoras como consumidoras. Administra las ventajas asociadas a la membresía para fomentar la participación y lealtad en la comunidad.
20 changes: 18 additions & 2 deletions documentation/admin/docs/es/menu_lateral/noticias.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,25 @@ icon: material/newspaper
---

# Gestionar noticias
Desde esta pantalla podrás gestionar las noticias relacionadas con el Mercado que gestionas.


## :fontawesome-solid-plus: Publicar noticia
Haciendo click en el botón "Publicar Noticia" accederás a la pantalla para añadir una nueva noticia.
En esta pantalla se te pedirán varios datos:

- Título de la noticia
- Imágen de portada de la noticia
- URL con más información
- Texto del botón de info: Solo visible si se indica una URL de más información.
- Descripción corta
- Descripción larga

Una vez rellenados los campos obligatorios, pulsa el botón "Publicar" para hacer pública la noticia.

## :fontawesome-solid-pen: Editar usuario
## :fontawesome-solid-pen: Editar noticia
Para editar una noticia puedes hacer click en la fila correspondiente a la noticia que se quiera editar, o haciendo click en el icono :material-pencil:.
En esta pantalla podrás modificar la información de la noticia y pulsar el botón "Guardar cambios" cuando estés satisfecha.

## :fontawesome-solid-trash: Eliminar usuario
## :fontawesome-solid-trash: Eliminar noticia
Para eliminar una noticia, haz click en el icono :material-delete: de la fila que quieras eliminar. Se te abrirá una ventana de confirmación.
63 changes: 63 additions & 0 deletions documentation/admin/docs/es/menu_lateral/proveedoras.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,67 @@ icon: material/store
---

# Gestionar proveedoras
Desde esta pantalla podrás gestionar las entidades proveedoras relacionadas con el Mercado que gestionas.

## Ver detalles de la proveedora
Para ver en detalle una proveedora, haz click en la fila de la proveedora que quieres consultar. Esto te llevará a otra
pantalla donde se muestran los detalles principales de la proveedora. Además desde esta pantalla podrás editar los datos
de la proveedora y añadir una ventaja.

## :fontawesome-solid-plus: Añadir proveedora
Haciendo click en el botón "Añadir nueva" accederás a la pantalla para añadir una nueva entidad proveedora.
En esta pantalla se te pedirán varios datos referentes a la proveedora divididas en las siguientes secciones:

### Información de la entidad
- Foto de perfil
- Nombre
- Email
- NIF/CIF/Pasaporte
- Número de socia
- Dirección postal
- Descripción
- Categorías a las que pertenece. [Ver cómo gestionar categorías](categorias.md)
- Número de personas trabajadoras

### Galería
- Fotografías de la proveedora

### Geolocalización
- Usa el mapa interactivo para colocar el pin en la localización donde se encuentra la proveedora.
Esta localización será visible en el mapa general de proveedoras.

### Visibilidad
- Oculta en listado público
- Activa

### Redes sociales
- Enlaces de la entidad a distintas redes sociales, incluyendo enlace a la página web.

/// admonition | Redes sociales admitidas
type: info
Actualmente, las redes sociales admitidas son: Facebook, Fediverso, Instagram, LinkedIn, Pinterest,
Telegram, TikTok, Whatsapp, X, Youtube.
///

### Crear usuaria asociada a la proveedora

![Crear usuaria y mandar email de prerregistro](../../assets/prerregistro.png){ align=right width=50% loading=lazy}
Cuando creamos una entidad proveedora tenemos la opción de crear paralelamente una cuenta de usuaria.
Si seleccionas esta opción, se enviará automáticamente un correo a la dirección de email de la proveedora,
desde el cual podrá crear una contraseña para acceder a la aplicación móvil.

Si no seleccionamos la opción podremos enviar el mail de prerregistro más adelante.

Una vez rellenados los campos obligatorios, pulsa el botón "Crear entidad" para crear la entidad proveedoras.

## :fontawesome-solid-pen: Editar proveedora
Para editar una proveedora puedes hacer click en la fila correspondiente a la usuaria que se quiera editar, o haciendo
click en el icono :material-pencil:.
En esta pantalla podrás modificar la información de la proveedora y pulsar el botón "Guardar cambios" cuando estés satisfecha.

## :material-basket: Consultar ofertas de la proveedora
Para consultar las ofertas de una provedora puedes hacer click en el icono :material-basket: que se encuentra en la fila
de la provedora de la que quieres consultar las ofertas.

## :fontawesome-solid-trash: Eliminar proveedora
Para eliminar una proveedora ponte en contacto con el equipo de administración.
2 changes: 2 additions & 0 deletions documentation/admin/docs/es/menu_lateral/usuarias.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ En esta pantalla se te pedirán varios datos referentes a la usuaria:
- Idioma preferido de la interfaz
- "Es Staff": Si la nueva usuaria también gestionará este Mercado.

Una vez rellenados los campos obligatorios, pulsa el botón "Crear usuaria" para crear la usuaria.

## :fontawesome-solid-pen: Editar usuaria
Para editar una usuaria puedes hacer click en la fila correspondiente a la usuaria que se quiera editar, o haciendo click en el icono :material-pencil:.
En esta pantalla podrás modificar la información de la usuaria y pulsar el botón "Guardar cambios" cuando estés satisfecha.
Expand Down
26 changes: 26 additions & 0 deletions documentation/admin/docs/es/menu_lateral/ventajas.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,30 @@ icon: material/ticket
---

# Gestionar ventajas
Desde esta pantalla podrás gestionar las ventajas relacionadas con el Mercado que gestionas.


## :fontawesome-solid-plus: Añadir ventaja
Haciendo click en el botón "Añadir ventaja" accederás a la pantalla para añadir una nueva ventaja.
En esta pantalla se te pedirán varios datos:

- Entidad que ofrece la ventaja
- Descripción de la ventaja para entidades proveedoras
- Descripción de la ventaja para socias consumidoras
- Incluye socias Intercoop
- La solicitud se realiza de manera física.
- La solicitud se realiza de manera online.
- Código de descuento
- Link del descuento para entidades proveedoras
- Link del descuento para socias consumidoras
- Texto del botón del link de descuento
- Activa o inactiva

Una vez rellenados los campos obligatorios, pulsa el botón "Crear ventaja" para crear la ventaja.

## :fontawesome-solid-pen: Editar ventaja
Para editar una ventaja puedes hacer click en la fila correspondiente a la ventaja que se quiera editar, o haciendo click en el icono :material-pencil:.
En esta pantalla podrás modificar la información de la ventaja y pulsar el botón "Guardar cambios" cuando estés satisfecha.

## :fontawesome-solid-trash: Eliminar ventaja
Para eliminar una ventaja, haz click en el icono :material-delete: de la fila que quieras eliminar. Se te abrirá una ventana de confirmación.
22 changes: 22 additions & 0 deletions documentation/admin/docs/es/perfil.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
icon: material/account-circle
---

# Perfil
![Editar perfil](../assets/editar_perfil.png){ align=right width=50% loading=lazy}

Haciendo click en el botón que tiene el icono :material-account-circle: en la esquina superior derecha accedemos a la siguiente información:

##:fontawesome-solid-pen: [Editar perfil](#editar-perfil_1)
##:material-exit-to-app: [Cerrar sesión](#cerrar-sesion_1)

<br>

# Editar Perfil
Seleccionando la opción de editar perfil se abrirá una nueva pantalla donde podremos modificar información relacionada con nuestro perfil, como:
- Idioma preferido de la interfaz
- Actualizar contraseña


# Cerrar Sesión
Seleccionando la opción de cerrar sesión, la aplicación finalizará la sesión con la cuenta actual y nos redigirá a la pantalla de inicio de sesión.
4 changes: 4 additions & 0 deletions documentation/admin/docs/es/versiones.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

# Versiones

Para consultar el histórico de versiones y los cambios incluídos en cada version haz click [aquí](https://github.com/Mercado-Social-de-Madrid/appMES/releases).
5 changes: 4 additions & 1 deletion documentation/admin/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema

site_name: Guía de administración de la AppMES
site_url: https://0.0.0.0/docs/admin
extra_css:
- assets/css/extra.css

theme:
name: material
Expand Down Expand Up @@ -62,7 +64,7 @@ plugins:
build: true

nav:
- index.md
- perfil.md
- Menú lateral:
- menu_lateral/index.md
- menu_lateral/usuarias.md
Expand All @@ -72,4 +74,5 @@ nav:
- menu_lateral/consumidoras.md
- menu_lateral/ofertas.md
- menu_lateral/ventajas.md
- guia_de_usuario.md
- versiones.md

0 comments on commit 8ad2031

Please sign in to comment.