From 6668f08a683bac6f850a148a5284e1aee48f317a Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 06:22:30 -0300 Subject: [PATCH 01/16] docs: add how to logi in to backoffice --- docs/index.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..6694478 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,32 @@ +# 🛠️ Guía del Usuario – Backoffice + +## 📌 Índice + +1. [Introducción](#introducción) +2. [Inicio de Sesión](#inicio-de-sesión) +3. [Registro de Administradores](#registro-de-administradores) +4. [Gestión de Usuarios y Permisos](#gestión-de-usuarios-y-permisos) +5. [Configuración de Reglas y Normativas](#configuración-de-reglas-y-normativas) +6. [Preguntas Frecuentes](#preguntas-frecuentes) +7. [Soporte](#soporte) + +--- + +## Introducción + +El backoffice es una herramienta diseñada para que los administradores puedan gestionar usuarios, accesos, configuraciones y normativas dentro de la plataforma. Esta guía tiene como objetivo brindar una referencia clara sobre cómo utilizar las principales funcionalidades del sistema. + +--- + +## Inicio de Sesión + +### ¿Cómo acceder? + +1. Ingresar a la URL del backoffice: `https://classconnect-backoffice.vercel.app/` +2. Completar los campos de correo electrónico y contraseña. +3. Hacer clic en **Iniciar Sesión**. + +### Mensajes posibles + +* ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. +* ❌ **Error en las credenciales:** Se mostrará un mensaje indicando que los datos ingresados no son válidos. From 24d95c5b5420907227e6e4b8cfa286f44b9f3478 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 06:37:54 -0300 Subject: [PATCH 02/16] docs: add more backoffice docs --- docs/index.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 87 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6694478..34ac72a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,8 +7,7 @@ 3. [Registro de Administradores](#registro-de-administradores) 4. [Gestión de Usuarios y Permisos](#gestión-de-usuarios-y-permisos) 5. [Configuración de Reglas y Normativas](#configuración-de-reglas-y-normativas) -6. [Preguntas Frecuentes](#preguntas-frecuentes) -7. [Soporte](#soporte) +6. [Soporte](#soporte) --- @@ -30,3 +29,89 @@ El backoffice es una herramienta diseñada para que los administradores puedan g * ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. * ❌ **Error en las credenciales:** Se mostrará un mensaje indicando que los datos ingresados no son válidos. + +--- + +## Registro de Administradores + +### ¿Cómo registrar a un nuevo administrador? + +1. Ingresar con una cuenta de administrador. +2. Hacer clic donde dice "Register an Admin here". +3. Completar el formulario con los datos requeridos. +4. Hacer clic en **Register**. + +### Resultados esperados + +* ✅ **Registro exitoso:** El nuevo administrador podrá acceder al sistema utilizando sus credenciales. +* ⚠️ **Datos faltantes o inválidos:** Se indicarán los errores para su corrección. +* ❌ **Fallo del servicio:** El sistema informará si no se puede procesar la solicitud. + +--- + +## Gestión de Usuarios y Permisos + +### Visualización del listado de usuarios + +* En la página de inicio, se mostrará un listado con nombre, rol, estado (activo/bloqueado) y fecha de registro de cada usuario.. + +### Edición de roles y permisos + +1. Para cada usuario, se visualizará la opción de modificar su rol según corresponda. +2. Se mostrará una opción para confirmar los cambios realizados.. +3. El sistema confirmará que la actualización fue realizada con éxito. + +### Bloqueo y desbloqueo de usuarios + +1. Desde el listado, para cada usuario se podra utilizar el botón correspondiente para **Bloquear** o **Desbloquear**. +2. Se mostrará una opción para confirmar los cambios realizados. +3. El sistema confirmará que la actualización fue realizada con éxito. + +### Registro de auditoría + +* Toda modificación será registrada automáticamente, incluyendo: + + * Usuario afectado + * Acción realizada + * Fecha y hora + +--- + +## Configuración de Reglas y Normativas + +### Creación y modificación de reglas + +1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas. +2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en **Add rule*. +3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit". +4. Completar o modificar los campos requeridos: + + * Título + * Descripción + * Fecha de vigencia + * Condiciones de aplicación + +### Validaciones + +* El sistema validará la integridad de los datos. No será posible guardar reglas con información incompleta. + +### Publicación y notificaciones + +* Una vez guardadas, las normativas se publicarán y se notificará a los usuarios relevantes mediante correo electrónico y/o notificaciones push. + +### Registro de cambios + +* Todas las acciones realizadas quedarán registradas: + + * Usuario que efectuó el cambio + * Tipo de modificación + * Fecha y hora + + +## Soporte + +Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte: +📧 **[classconnect.team.uba@gmail.com](mailto:classconnect.team.uba@gmail.com)** + +--- + From 1628ba84caf79abe2ed4bbff177eeed208bf6ffd Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 06:42:50 -0300 Subject: [PATCH 03/16] docs: add GitHub Pages link to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3c5ec03..007c1a5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - [Getting Started]() - [Project Structure]() - [License]() +- [Github Pages]() - [Codecov](README#codecov) ## 🔧 Features @@ -124,6 +125,11 @@ classconnect-backoffice/ MIT License. +## Github Pages + +You can access the published backoffice user guide at the following link: +https://is2-class-connect.github.io/classconnect-backoffice/ + ## Codecov [![codecov](https://codecov.io/gh/IS2-Class-Connect/classconnect-backoffice/graph/badge.svg?token=6QwXr8HFIm)](https://codecov.io/gh/IS2-Class-Connect/classconnect-backoffice) From 10dd6466881faab35e82b4ac8255bcce19d5ebcb Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:00:16 -0300 Subject: [PATCH 04/16] docs: add a css style --- docs/index.md | 69 +++++++++++++++++++++++++++----------------------- docs/style.css | 50 ++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 32 deletions(-) create mode 100644 docs/style.css diff --git a/docs/index.md b/docs/index.md index 34ac72a..84c8c3d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,18 @@ +--- +layout: default +--- + + + # 🛠️ Guía del Usuario – Backoffice ## 📌 Índice -1. [Introducción](#introducción) -2. [Inicio de Sesión](#inicio-de-sesión) -3. [Registro de Administradores](#registro-de-administradores) -4. [Gestión de Usuarios y Permisos](#gestión-de-usuarios-y-permisos) -5. [Configuración de Reglas y Normativas](#configuración-de-reglas-y-normativas) +1. [Introducción](#introducción) +2. [Inicio de Sesión](#inicio-de-sesión) +3. [Registro de Administradores](#registro-de-administradores) +4. [Gestión de Usuarios y Permisos](#gestión-de-usuarios-y-permisos) +5. [Configuración de Reglas y Normativas](#configuración-de-reglas-y-normativas) 6. [Soporte](#soporte) --- @@ -27,7 +33,7 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### Mensajes posibles -* ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. +* ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. * ❌ **Error en las credenciales:** Se mostrará un mensaje indicando que los datos ingresados no son válidos. --- @@ -36,15 +42,15 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### ¿Cómo registrar a un nuevo administrador? -1. Ingresar con una cuenta de administrador. -2. Hacer clic donde dice "Register an Admin here". -3. Completar el formulario con los datos requeridos. +1. Ingresar con una cuenta de administrador. +2. Hacer clic donde dice "Register an Admin here". +3. Completar el formulario con los datos requeridos. 4. Hacer clic en **Register**. ### Resultados esperados -* ✅ **Registro exitoso:** El nuevo administrador podrá acceder al sistema utilizando sus credenciales. -* ⚠️ **Datos faltantes o inválidos:** Se indicarán los errores para su corrección. +* ✅ **Registro exitoso:** El nuevo administrador podrá acceder al sistema utilizando sus credenciales. +* ⚠️ **Datos faltantes o inválidos:** Se indicarán los errores para su corrección. * ❌ **Fallo del servicio:** El sistema informará si no se puede procesar la solicitud. --- @@ -53,27 +59,27 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### Visualización del listado de usuarios -* En la página de inicio, se mostrará un listado con nombre, rol, estado (activo/bloqueado) y fecha de registro de cada usuario.. +* En la página de inicio, se mostrará un listado con nombre, rol, estado (activo/bloqueado) y fecha de registro de cada usuario. ### Edición de roles y permisos -1. Para cada usuario, se visualizará la opción de modificar su rol según corresponda. -2. Se mostrará una opción para confirmar los cambios realizados.. +1. Para cada usuario, se visualizará la opción de modificar su rol según corresponda. +2. Se mostrará una opción para confirmar los cambios realizados. 3. El sistema confirmará que la actualización fue realizada con éxito. ### Bloqueo y desbloqueo de usuarios -1. Desde el listado, para cada usuario se podra utilizar el botón correspondiente para **Bloquear** o **Desbloquear**. -2. Se mostrará una opción para confirmar los cambios realizados. +1. Desde el listado, para cada usuario se podrá utilizar el botón correspondiente para **Bloquear** o **Desbloquear**. +2. Se mostrará una opción para confirmar los cambios realizados. 3. El sistema confirmará que la actualización fue realizada con éxito. ### Registro de auditoría * Toda modificación será registrada automáticamente, incluyendo: - * Usuario afectado - * Acción realizada - * Fecha y hora + * Usuario afectado + * Acción realizada + * Fecha y hora --- @@ -81,15 +87,15 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### Creación y modificación de reglas -1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas. -2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en **Add rule*. -3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit". +1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas. +2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en **Add rule**. +3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit". 4. Completar o modificar los campos requeridos: - * Título - * Descripción - * Fecha de vigencia - * Condiciones de aplicación + * Título + * Descripción + * Fecha de vigencia + * Condiciones de aplicación ### Validaciones @@ -103,15 +109,14 @@ El backoffice es una herramienta diseñada para que los administradores puedan g * Todas las acciones realizadas quedarán registradas: - * Usuario que efectuó el cambio - * Tipo de modificación - * Fecha y hora + * Usuario que efectuó el cambio + * Tipo de modificación + * Fecha y hora +--- ## Soporte -Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte: +Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte: 📧 **[classconnect.team.uba@gmail.com](mailto:classconnect.team.uba@gmail.com)** ---- - diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 0000000..195cf6e --- /dev/null +++ b/docs/style.css @@ -0,0 +1,50 @@ +body { + font-family: 'Segoe UI', 'Helvetica Neue', sans-serif; + background-color: #f9f9f9; + color: #222; + max-width: 900px; + margin: auto; + padding: 2rem; + line-height: 1.8; +} + +h1, h2, h3 { + color: #003366; +} + +a { + color: #007bff; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +code { + background-color: #eee; + padding: 0.2rem 0.4rem; + border-radius: 4px; + font-family: 'Courier New', monospace; +} + +ul, ol { + padding-left: 1.5rem; +} + +hr { + border: none; + border-top: 1px solid #ccc; + margin: 2rem 0; +} + +strong { + font-weight: bold; +} + +.markdown-body { + background-color: white; + padding: 2rem; + border-radius: 8px; + box-shadow: 0 0 10px rgba(0,0,0,0.05); +} From c5535722581d7a37bb53034e6764c9a591ad8566 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:03:35 -0300 Subject: [PATCH 05/16] docs: add more css style --- docs/index.md | 17 ++++++----- docs/style.css | 77 +++++++++++++++++++++++++++++++++++++------------- 2 files changed, 68 insertions(+), 26 deletions(-) diff --git a/docs/index.md b/docs/index.md index 84c8c3d..f0c1a16 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,8 @@ layout: default +
+ # 🛠️ Guía del Usuario – Backoffice ## 📌 Índice @@ -27,14 +29,14 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### ¿Cómo acceder? -1. Ingresar a la URL del backoffice: `https://classconnect-backoffice.vercel.app/` -2. Completar los campos de correo electrónico y contraseña. +1. Ingresar a la URL del backoffice: `https://classconnect-backoffice.vercel.app/` +2. Completar los campos de correo electrónico y contraseña. 3. Hacer clic en **Iniciar Sesión**. ### Mensajes posibles -* ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. -* ❌ **Error en las credenciales:** Se mostrará un mensaje indicando que los datos ingresados no son válidos. +- ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. +- ❌ **Error en las credenciales:** Se mostrará un mensaje indicando que los datos ingresados no son válidos. --- @@ -49,9 +51,9 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### Resultados esperados -* ✅ **Registro exitoso:** El nuevo administrador podrá acceder al sistema utilizando sus credenciales. -* ⚠️ **Datos faltantes o inválidos:** Se indicarán los errores para su corrección. -* ❌ **Fallo del servicio:** El sistema informará si no se puede procesar la solicitud. +- ✅ **Registro exitoso:** El nuevo administrador podrá acceder al sistema utilizando sus credenciales. +- ⚠️ **Datos faltantes o inválidos:** Se indicarán los errores para su corrección. +- ❌ **Fallo del servicio:** El sistema informará si no se puede procesar la solicitud. --- @@ -120,3 +122,4 @@ El backoffice es una herramienta diseñada para que los administradores puedan g Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte: 📧 **[classconnect.team.uba@gmail.com](mailto:classconnect.team.uba@gmail.com)** +
diff --git a/docs/style.css b/docs/style.css index 195cf6e..c8d5676 100644 --- a/docs/style.css +++ b/docs/style.css @@ -1,15 +1,41 @@ body { - font-family: 'Segoe UI', 'Helvetica Neue', sans-serif; - background-color: #f9f9f9; - color: #222; - max-width: 900px; - margin: auto; - padding: 2rem; - line-height: 1.8; + margin: 0; + padding: 0; + background-color: #f4f6f8; + font-family: 'Inter', 'Segoe UI', sans-serif; + color: #333; } -h1, h2, h3 { - color: #003366; +.doc-container { + max-width: 800px; + margin: 3rem auto; + padding: 3rem; + background-color: #fff; + border-radius: 12px; + box-shadow: 0 0 15px rgba(0, 0, 0, 0.05); +} + +h1 { + color: #2a4d7c; + font-size: 2.2rem; + margin-bottom: 1.5rem; + border-bottom: 2px solid #e0e0e0; + padding-bottom: 0.5rem; +} + +h2 { + color: #2a4d7c; + font-size: 1.6rem; + margin-top: 2rem; + margin-bottom: 1rem; + border-left: 4px solid #2a4d7c; + padding-left: 0.75rem; +} + +h3 { + color: #374151; + font-size: 1.2rem; + margin-top: 1.5rem; } a { @@ -22,29 +48,42 @@ a:hover { } code { - background-color: #eee; - padding: 0.2rem 0.4rem; - border-radius: 4px; + background-color: #f1f3f5; + padding: 0.25rem 0.4rem; font-family: 'Courier New', monospace; + border-radius: 4px; } ul, ol { padding-left: 1.5rem; + margin-bottom: 1.5rem; } hr { border: none; - border-top: 1px solid #ccc; + border-top: 1px solid #ddd; margin: 2rem 0; } strong { - font-weight: bold; + font-weight: 600; } -.markdown-body { - background-color: white; - padding: 2rem; - border-radius: 8px; - box-shadow: 0 0 10px rgba(0,0,0,0.05); +@media screen and (max-width: 768px) { + .doc-container { + padding: 1.5rem; + margin: 1rem; + } + + h1 { + font-size: 1.8rem; + } + + h2 { + font-size: 1.4rem; + } + + h3 { + font-size: 1.1rem; + } } From 711be627841744eb75d46da128bd73a3d865dd4d Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:05:09 -0300 Subject: [PATCH 06/16] docs: fix typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f0c1a16..b7968aa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -71,7 +71,7 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### Bloqueo y desbloqueo de usuarios -1. Desde el listado, para cada usuario se podrá utilizar el botón correspondiente para **Bloquear** o **Desbloquear**. +1. Desde el listado, para cada usuario se podrá utilizar el botón correspondiente para **Block** o **Unblock**. 2. Se mostrará una opción para confirmar los cambios realizados. 3. El sistema confirmará que la actualización fue realizada con éxito. From 46480329d4de69fc8e86d6e466832dd4461b6ab5 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:09:13 -0300 Subject: [PATCH 07/16] docs: fix typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index b7968aa..d36ac18 100644 --- a/docs/index.md +++ b/docs/index.md @@ -90,7 +90,7 @@ El backoffice es una herramienta diseñada para que los administradores puedan g ### Creación y modificación de reglas 1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas. -2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en **Add rule**. +2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en "Add rule" 3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit". 4. Completar o modificar los campos requeridos: From 0b89b77a4cc080fa6ef6e5706cc5b92b08274c7d Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:10:25 -0300 Subject: [PATCH 08/16] docs: fix delete css --- docs/index.md | 10 ------ docs/style.css | 89 -------------------------------------------------- 2 files changed, 99 deletions(-) delete mode 100644 docs/style.css diff --git a/docs/index.md b/docs/index.md index d36ac18..a9b912b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,3 @@ ---- -layout: default ---- - - - -
- # 🛠️ Guía del Usuario – Backoffice ## 📌 Índice @@ -121,5 +113,3 @@ El backoffice es una herramienta diseñada para que los administradores puedan g Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte: 📧 **[classconnect.team.uba@gmail.com](mailto:classconnect.team.uba@gmail.com)** - -
diff --git a/docs/style.css b/docs/style.css deleted file mode 100644 index c8d5676..0000000 --- a/docs/style.css +++ /dev/null @@ -1,89 +0,0 @@ -body { - margin: 0; - padding: 0; - background-color: #f4f6f8; - font-family: 'Inter', 'Segoe UI', sans-serif; - color: #333; -} - -.doc-container { - max-width: 800px; - margin: 3rem auto; - padding: 3rem; - background-color: #fff; - border-radius: 12px; - box-shadow: 0 0 15px rgba(0, 0, 0, 0.05); -} - -h1 { - color: #2a4d7c; - font-size: 2.2rem; - margin-bottom: 1.5rem; - border-bottom: 2px solid #e0e0e0; - padding-bottom: 0.5rem; -} - -h2 { - color: #2a4d7c; - font-size: 1.6rem; - margin-top: 2rem; - margin-bottom: 1rem; - border-left: 4px solid #2a4d7c; - padding-left: 0.75rem; -} - -h3 { - color: #374151; - font-size: 1.2rem; - margin-top: 1.5rem; -} - -a { - color: #007bff; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -code { - background-color: #f1f3f5; - padding: 0.25rem 0.4rem; - font-family: 'Courier New', monospace; - border-radius: 4px; -} - -ul, ol { - padding-left: 1.5rem; - margin-bottom: 1.5rem; -} - -hr { - border: none; - border-top: 1px solid #ddd; - margin: 2rem 0; -} - -strong { - font-weight: 600; -} - -@media screen and (max-width: 768px) { - .doc-container { - padding: 1.5rem; - margin: 1rem; - } - - h1 { - font-size: 1.8rem; - } - - h2 { - font-size: 1.4rem; - } - - h3 { - font-size: 1.1rem; - } -} From 9f1e8c12e680daff9d94d90c31349352a5bc997a Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:21:30 -0300 Subject: [PATCH 09/16] docs: change theme --- docs/_config.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/_config.yml diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..c741881 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-slate \ No newline at end of file From 3c2a4d2e68eb476df2b818fa448e27da527f2e17 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:26:28 -0300 Subject: [PATCH 10/16] docs: change to cayman theme --- docs/_config.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index c741881..876981a 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,3 @@ -theme: jekyll-theme-slate \ No newline at end of file +remote_theme: pages-themes/cayman@v0.2.0 +plugins: +- jekyll-remote-theme \ No newline at end of file From fc751d0b7064bdfc2d5f0a92b6885d06a3b363d1 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:29:38 -0300 Subject: [PATCH 11/16] fix: bug when adding the theme --- docs/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.md b/docs/index.md index a9b912b..b907000 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,6 @@ +--- +--- + # 🛠️ Guía del Usuario – Backoffice ## 📌 Índice From 01ce3d4351400e87740966b40d029328e362cc05 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:38:32 -0300 Subject: [PATCH 12/16] fix; cayman not showing --- docs/_config.yml | 4 +--- docs/index.md | 1 + 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 876981a..c419263 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,3 +1 @@ -remote_theme: pages-themes/cayman@v0.2.0 -plugins: -- jekyll-remote-theme \ No newline at end of file +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index b907000..fdc89ea 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,5 @@ --- +layout: default --- # 🛠️ Guía del Usuario – Backoffice From 145d6c1ef2b1101c6d16538c6a7158b56b0273e1 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 07:43:09 -0300 Subject: [PATCH 13/16] fix: not displaying correctly theme --- docs/_config.yml | 7 ++++++- docs/index.md | 1 - 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index c419263..59a3c2c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,6 @@ -theme: jekyll-theme-cayman \ No newline at end of file +title: ClassConnect Backoffice +description: Guía del usuario – Backoffice +remote_theme: pages-themes/cayman@v0.2.0 +plugins: + - jekyll-remote-theme +show_downloads: false diff --git a/docs/index.md b/docs/index.md index fdc89ea..b907000 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,4 @@ --- -layout: default --- # 🛠️ Guía del Usuario – Backoffice From 8a5123068b0fb9a7b1a6b16f2a3b4d3c99ac2c32 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 08:02:58 -0300 Subject: [PATCH 14/16] fix: doesnt show theme --- docs/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.md b/docs/index.md index b907000..e09b93d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,6 @@ --- +layout: page +title: "Guía del Usuario – Backoffice" --- # 🛠️ Guía del Usuario – Backoffice From 71ec5e241f56ed490f4c2c020ee051651e769669 Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 08:26:30 -0300 Subject: [PATCH 15/16] fix: delete unnecesasry files --- docs/_config.yml | 6 ------ docs/index.md | 5 ----- 2 files changed, 11 deletions(-) delete mode 100644 docs/_config.yml diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 59a3c2c..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1,6 +0,0 @@ -title: ClassConnect Backoffice -description: Guía del usuario – Backoffice -remote_theme: pages-themes/cayman@v0.2.0 -plugins: - - jekyll-remote-theme -show_downloads: false diff --git a/docs/index.md b/docs/index.md index e09b93d..a9b912b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,3 @@ ---- -layout: page -title: "Guía del Usuario – Backoffice" ---- - # 🛠️ Guía del Usuario – Backoffice ## 📌 Índice From 05995dafb59bfdd481527506ea574e5b98c4201b Mon Sep 17 00:00:00 2001 From: Sol Urbano Date: Fri, 20 Jun 2025 08:38:44 -0300 Subject: [PATCH 16/16] fix: github pages style --- docs/index.html | 280 ++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 115 -------------------- 2 files changed, 280 insertions(+), 115 deletions(-) create mode 100644 docs/index.html delete mode 100644 docs/index.md diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..e9c8d23 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,280 @@ + + + + + +Guía del Usuario – Backoffice + + + + +

🛠️ Guía del Usuario – Backoffice

+ +
+

📌 Índice

+
    +
  1. Introducción
    2. +
  2. Inicio de Sesión
    3. +
  3. Registro de Administradores
    4. +
  4. Gestión de Usuarios y Permisos
    5. +
  5. Configuración de Reglas y Normativas
    6. +
  6. Soporte
    7. +
+
+ +
+ +
+

📌 Introducción

+

El backoffice es una herramienta diseñada para que los administradores puedan gestionar usuarios, accesos, configuraciones y normativas dentro de la plataforma. Esta guía tiene como objetivo brindar una referencia clara sobre cómo utilizar las principales funcionalidades del sistema.

+
+ +
+ +
+

🔑 Inicio de Sesión

+ +

¿Cómo acceder?

+
    +
  1. Ingresar a la URL del backoffice: https://classconnect-backoffice.vercel.app/
    2. +
  2. Completar los campos de correo electrónico y contraseña.
    3. +
  3. Hacer clic en Iniciar Sesión.
    4. +
+ +

Mensajes posibles

+
    +
  • ✅ Inicio exitoso: El sistema redirigirá al panel principal.
    • +
  • ❌ Error en las credenciales: Se mostrará un mensaje indicando que los datos ingresados no son válidos.
    • +
+
+ +
+ +
+

📝 Registro de Administradores

+ +

¿Cómo registrar a un nuevo administrador?

+
    +
  1. Ingresar con una cuenta de administrador.
    2. +
  2. Hacer clic donde dice "Register an Admin here".
    3. +
  3. Completar el formulario con los datos requeridos.
    4. +
  4. Hacer clic en Register.
    5. +
+ +

Resultados esperados

+
    +
  • ✅ Registro exitoso: El nuevo administrador podrá acceder al sistema utilizando sus credenciales.
    • +
  • ⚠️ Datos faltantes o inválidos: Se indicarán los errores para su corrección.
    • +
  • ❌ Fallo del servicio: El sistema informará si no se puede procesar la solicitud.
    • +
+
+ +
+ +
+

👥 Gestión de Usuarios y Permisos

+ +

Visualización del listado de usuarios

+
    +
  • En la página de inicio, se mostrará un listado con nombre, rol, estado (activo/bloqueado) y fecha de registro de cada usuario.
    • +
+ +

Edición de roles y permisos

+
    +
  1. Para cada usuario, se visualizará la opción de modificar su rol según corresponda.
    2. +
  2. Se mostrará una opción para confirmar los cambios realizados.
    3. +
  3. El sistema confirmará que la actualización fue realizada con éxito.
    4. +
+ +

Bloqueo y desbloqueo de usuarios

+
    +
  1. Desde el listado, para cada usuario se podrá utilizar el botón correspondiente para Block o Unblock.
    2. +
  2. Se mostrará una opción para confirmar los cambios realizados.
    3. +
  3. El sistema confirmará que la actualización fue realizada con éxito.
    4. +
+ +

Registro de auditoría

+
    +
  • Toda modificación será registrada automáticamente, incluyendo:
    • +
      +
    • Usuario afectado
      • +
    • Acción realizada
      • +
    • Fecha y hora
      • +
    +
+
+ +
+ +
+

📋 Configuración de Reglas y Normativas

+ +

Creación y modificación de reglas

+
    +
  1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas.
    2. +
  2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en "Add rule".
    3. +
  3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit".
    4. +
  4. Completar o modificar los campos requeridos: +
      +
    • Título
      • +
    • Descripción
      • +
    • Fecha de vigencia
      • +
    • Condiciones de aplicación
      • +
    +
    5. +
+ +

Validaciones

+
    +
  • El sistema validará la integridad de los datos. No será posible guardar reglas con información incompleta.
    • +
+ +

Publicación y notificaciones

+
    +
  • Una vez guardadas, las normativas se publicarán y se notificará a los usuarios relevantes mediante correo electrónico y/o notificaciones push.
    • +
+ +

Registro de cambios

+
    +
  • Todas las acciones realizadas quedarán registradas: +
      +
    • Usuario que efectuó el cambio
      • +
    • Tipo de modificación
      • +
    • Fecha y hora
      • +
    +
    • +
+
+ +
+ +
+

📞 Soporte

+

Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte:
+📧 classconnect.team.uba@gmail.com

+
+ + + diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index a9b912b..0000000 --- a/docs/index.md +++ /dev/null @@ -1,115 +0,0 @@ -# 🛠️ Guía del Usuario – Backoffice - -## 📌 Índice - -1. [Introducción](#introducción) -2. [Inicio de Sesión](#inicio-de-sesión) -3. [Registro de Administradores](#registro-de-administradores) -4. [Gestión de Usuarios y Permisos](#gestión-de-usuarios-y-permisos) -5. [Configuración de Reglas y Normativas](#configuración-de-reglas-y-normativas) -6. [Soporte](#soporte) - ---- - -## Introducción - -El backoffice es una herramienta diseñada para que los administradores puedan gestionar usuarios, accesos, configuraciones y normativas dentro de la plataforma. Esta guía tiene como objetivo brindar una referencia clara sobre cómo utilizar las principales funcionalidades del sistema. - ---- - -## Inicio de Sesión - -### ¿Cómo acceder? - -1. Ingresar a la URL del backoffice: `https://classconnect-backoffice.vercel.app/` -2. Completar los campos de correo electrónico y contraseña. -3. Hacer clic en **Iniciar Sesión**. - -### Mensajes posibles - -- ✅ **Inicio exitoso:** El sistema redirigirá al panel principal. -- ❌ **Error en las credenciales:** Se mostrará un mensaje indicando que los datos ingresados no son válidos. - ---- - -## Registro de Administradores - -### ¿Cómo registrar a un nuevo administrador? - -1. Ingresar con una cuenta de administrador. -2. Hacer clic donde dice "Register an Admin here". -3. Completar el formulario con los datos requeridos. -4. Hacer clic en **Register**. - -### Resultados esperados - -- ✅ **Registro exitoso:** El nuevo administrador podrá acceder al sistema utilizando sus credenciales. -- ⚠️ **Datos faltantes o inválidos:** Se indicarán los errores para su corrección. -- ❌ **Fallo del servicio:** El sistema informará si no se puede procesar la solicitud. - ---- - -## Gestión de Usuarios y Permisos - -### Visualización del listado de usuarios - -* En la página de inicio, se mostrará un listado con nombre, rol, estado (activo/bloqueado) y fecha de registro de cada usuario. - -### Edición de roles y permisos - -1. Para cada usuario, se visualizará la opción de modificar su rol según corresponda. -2. Se mostrará una opción para confirmar los cambios realizados. -3. El sistema confirmará que la actualización fue realizada con éxito. - -### Bloqueo y desbloqueo de usuarios - -1. Desde el listado, para cada usuario se podrá utilizar el botón correspondiente para **Block** o **Unblock**. -2. Se mostrará una opción para confirmar los cambios realizados. -3. El sistema confirmará que la actualización fue realizada con éxito. - -### Registro de auditoría - -* Toda modificación será registrada automáticamente, incluyendo: - - * Usuario afectado - * Acción realizada - * Fecha y hora - ---- - -## Configuración de Reglas y Normativas - -### Creación y modificación de reglas - -1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas. -2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en "Add rule" -3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit". -4. Completar o modificar los campos requeridos: - - * Título - * Descripción - * Fecha de vigencia - * Condiciones de aplicación - -### Validaciones - -* El sistema validará la integridad de los datos. No será posible guardar reglas con información incompleta. - -### Publicación y notificaciones - -* Una vez guardadas, las normativas se publicarán y se notificará a los usuarios relevantes mediante correo electrónico y/o notificaciones push. - -### Registro de cambios - -* Todas las acciones realizadas quedarán registradas: - - * Usuario que efectuó el cambio - * Tipo de modificación - * Fecha y hora - ---- - -## Soporte - -Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte: -📧 **[classconnect.team.uba@gmail.com](mailto:classconnect.team.uba@gmail.com)**