-
Notifications
You must be signed in to change notification settings - Fork 1
feat: add activitylog docs and update provider #167
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| sidebar_label: Activity Log | ||
| sidebar_position: 14 | ||
| --- | ||
|
|
||
| import Zoom from 'react-medium-image-zoom'; | ||
| import 'react-medium-image-zoom/dist/styles.css'; | ||
|
|
||
| # Activity Log | ||
|
|
||
| The Activity Log provides a complete audit trail of all actions performed by users on the platform. It records every create, update, and delete operation across all resources, allowing you to track who did what and when. | ||
|
|
||
| ## FAQs | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### What actions are recorded in the Activity Log? | ||
| </summary> | ||
| The Activity Log records all three types of operations performed on platform | ||
| resources: | ||
| - **Create** — A new resource was created. | ||
| - **Update** — An existing resource was modified. | ||
| - **Delete** — A resource was deleted. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### What resources are tracked? | ||
| </summary> | ||
| The Activity Log tracks actions on all major platform resources, including: | ||
| - Clusters | ||
| - Projects | ||
| - Environments | ||
| - Services | ||
| - Jobs | ||
| - Deployments | ||
| - Dependencies | ||
| - Variable Groups | ||
| - Domains | ||
| - Node Pools | ||
| - Volumes | ||
| - Providers | ||
| - Users | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### Can I navigate to the resource from the Activity Log? | ||
| </summary> | ||
| Yes. Clicking on the resource icon in the **Name** column takes you directly | ||
| to that resource's detail page. If the resource has been deleted, the link is | ||
| disabled and navigation is not available. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### Can I filter the Activity Log? | ||
| </summary> | ||
| Yes. You can filter by user, action type (Create, Update, Delete), resource | ||
| type, and date range. See the [Filtering the Activity | ||
| Log](#filtering-the-activity-log) section for details. | ||
| </details> | ||
|
|
||
| ## Accessing the Activity Log | ||
|
|
||
| A summary of the most recent platform activity is visible on the main Dashboard as the **Last Activity** card. It shows the last actions. Click **View all** at the bottom of the card to open the full Activity Log page. | ||
|
|
||
| <Zoom overlayBgColorEnd='rgba(255, 255, 255, 0.8)'> | ||
| <img | ||
| src='/img/activitylog/activitylog-dashboard-card.png' | ||
| alt='activitylog-dashboard-card' | ||
| /> | ||
| </Zoom> | ||
|
|
||
| ## Understanding the Activity Log Table | ||
|
|
||
| The table displays four columns: | ||
|
|
||
| | **Column** | **Description** | | ||
| | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | **Name** | The name of the affected resource, along with an icon representing its type and the account it belongs to. Click the icon to navigate to the resource (unavailable for deleted resources). | | ||
| | **Action** | A badge showing the type of operation: **Create**, **Update**, or **Delete**. | | ||
| | **Created At** | The relative time when the action occurred. Hover over it to see the full date and time. | | ||
| | **User** | The full name of the user who performed the action. | | ||
|
|
||
| <Zoom overlayBgColorEnd='rgba(255, 255, 255, 0.8)'> | ||
| <img src='/img/activitylog/activitylog-table.png' alt='activitylog-table' /> | ||
| </Zoom> | ||
|
|
||
| ## Filtering the Activity Log | ||
|
|
||
| Use the search input and filter bar at the top of the page to narrow down the results. Filters can be combined. | ||
|
|
||
| <Zoom overlayBgColorEnd='rgba(255, 255, 255, 0.8)'> | ||
| <img | ||
| src='/img/activitylog/activitylog-filters.png' | ||
| alt='activitylog-filters' | ||
| /> | ||
| </Zoom> | ||
|
|
||
| | **Filter** | **Description** | | ||
| | -------------- | --------------------------------------------------------------------------------------- | | ||
| | **Search** | Free-text search by resource name or action type. | | ||
| | **User** | Show only activities performed by a specific user. | | ||
| | **Action** | Show only Create, Update, or Delete actions. | | ||
| | **Type** | Show only activities for a specific resource type (e.g., Cluster, Service, Deployment). | | ||
| | **Date Range** | Show only activities within a specific time period. | |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| sidebar_label: Registro de Actividad | ||
| sidebar_position: 14 | ||
| --- | ||
|
|
||
| import Zoom from 'react-medium-image-zoom'; | ||
| import 'react-medium-image-zoom/dist/styles.css'; | ||
|
|
||
| # Registro de Actividad | ||
|
|
||
| El Registro de Actividad proporciona un historial completo de todas las acciones realizadas por los usuarios en la plataforma. Registra cada operación de creación, actualización y eliminación en todos los recursos, permitiéndote rastrear quién hizo qué y cuándo. | ||
|
|
||
| ## Preguntas Frecuentes | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### ¿Qué acciones se registran en el Registro de Actividad? | ||
| </summary> | ||
| El Registro de Actividad registra los tres tipos de operaciones realizadas sobre los recursos de la plataforma: | ||
| - **Crear** — Se creó un nuevo recurso. | ||
| - **Actualizar** — Se modificó un recurso existente. | ||
| - **Eliminar** — Se eliminó un recurso. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### ¿Qué recursos se rastrean? | ||
| </summary> | ||
| El Registro de Actividad rastrea las acciones sobre todos los recursos principales de la plataforma, incluyendo: | ||
| - Clusters | ||
| - Proyectos | ||
| - Entornos | ||
| - Servicios | ||
| - Jobs | ||
| - Deployments | ||
| - Dependencias | ||
| - Grupos de Variables | ||
| - Dominios | ||
| - Node Pools | ||
| - Volúmenes | ||
| - Proveedores | ||
| - Usuarios | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### ¿Puedo navegar al recurso desde el Registro de Actividad? | ||
| </summary> | ||
| Sí. Al hacer clic en el ícono del recurso en la columna **Nombre**, accederás directamente a la página de detalle de ese recurso. Si el recurso ha sido eliminado, el enlace está deshabilitado y la navegación no está disponible. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### ¿Puedo filtrar el Registro de Actividad? | ||
| </summary> | ||
| Sí. Puedes filtrar por usuario, tipo de acción (Crear, Actualizar, Eliminar), tipo de recurso y rango de fechas. Consulta la sección [Filtrando el Registro de Actividad](#filtrando-el-registro-de-actividad) para más detalles. | ||
| </details> | ||
|
|
||
| ## Accediendo al Registro de Actividad | ||
|
|
||
| Un resumen de la actividad más reciente de la plataforma es visible en el Dashboard principal como la tarjeta **Última Actividad**. Muestra las últimas acciones. Haz clic en **Ver todos** en la parte inferior de la tarjeta para abrir la página completa del Registro de Actividad. | ||
|
|
||
| <Zoom overlayBgColorEnd='rgba(255, 255, 255, 0.8)'> | ||
| <img | ||
| src='/img/activitylog/activitylog-dashboard-card.png' | ||
| alt='activitylog-dashboard-card' | ||
| /> | ||
| </Zoom> | ||
|
|
||
| ## Entendiendo la Tabla del Registro de Actividad | ||
|
|
||
| La tabla muestra cuatro columnas: | ||
|
|
||
| | **Columna** | **Descripción** | | ||
| | --- | --- | | ||
| | **Nombre** | El nombre del recurso afectado, junto con un ícono que representa su tipo y la cuenta a la que pertenece. Haz clic en el ícono para navegar al recurso (no disponible para recursos eliminados). | | ||
| | **Acción** | Una etiqueta que muestra el tipo de operación: **Crear**, **Actualizar** o **Eliminar**. | | ||
| | **Creado el** | El tiempo relativo en que ocurrió la acción. Pasa el cursor sobre él para ver la fecha y hora completa. | | ||
| | **Usuario** | El nombre completo del usuario que realizó la acción. | | ||
|
|
||
| <Zoom overlayBgColorEnd='rgba(255, 255, 255, 0.8)'> | ||
| <img src='/img/activitylog/activitylog-table.png' alt='activitylog-table' /> | ||
| </Zoom> | ||
|
|
||
| ## Filtrando el Registro de Actividad | ||
|
|
||
| Usa el campo de búsqueda y la barra de filtros en la parte superior de la página para reducir los resultados. Los filtros se pueden combinar. | ||
|
|
||
| <Zoom overlayBgColorEnd='rgba(255, 255, 255, 0.8)'> | ||
| <img | ||
| src='/img/activitylog/activitylog-filters.png' | ||
| alt='activitylog-filters' | ||
| /> | ||
| </Zoom> | ||
|
|
||
| | **Filtro** | **Descripción** | | ||
| | --- | --- | | ||
| | **Búsqueda** | Búsqueda de texto libre por nombre del recurso o tipo de acción. | | ||
| | **Usuario** | Muestra solo las actividades realizadas por un usuario específico. | | ||
| | **Acción** | Muestra solo acciones de Crear, Actualizar o Eliminar. | | ||
| | **Tipo** | Muestra solo actividades de un tipo de recurso específico (ej. Cluster, Servicio, Deployment). | | ||
| | **Rango de Fechas** | Muestra solo actividades dentro de un período de tiempo específico. | |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -19,7 +19,7 @@ Para proporcionarte una vista clara de tus costos y recursos en AWS, SleakOps ac | |||||
|
|
||||||
| ### 1. Navega a la sección de providers | ||||||
|
|
||||||
| En el *Panel Izquierdo*, accede a la opción *Configuración* y luego *Providers*. En la esquina superior derecha, haz clic en el botón *Crear*. | ||||||
| En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y por último, en la esquina superior derecha, haz clic en el botón *Crear*. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Pulir puntuación del inciso para que quede redondo Aquí conviene escribir “y, por último,” (coma antes y después del inciso) para que la instrucción fluya mejor. En docs, estos detalles evitan ambigüedad, a las piñas y sin vueltas. ✍️ Ajuste propuesto-En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y por último, en la esquina superior derecha, haz clic en el botón *Crear*.
+En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y, por último, en la esquina superior derecha, haz clic en el botón *Crear*.📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~22-~22: Agrega un signo de puntuación. (QB_NEW_ES_OTHER_ERROR_IDS_MISSING_PUNCTUATION) 🤖 Prompt for AI Agents |
||||||
|
|
||||||
| <Zoom overlayBgColorEnd="rgba(255, 255, 255, 0.8)"> | ||||||
| <img | ||||||
|
|
@@ -86,6 +86,8 @@ Este proceso tomará unos minutos. | |||||
| /> | ||||||
| </Zoom> | ||||||
|
|
||||||
| Luego de completado el proceso, serás redirigido al dashboard. | ||||||
|
|
||||||
| ### 5. Conoce la arquitectura de infraestructura creada por SleakOps para ti. | ||||||
|
|
||||||
| Para entender lo que se creó en tu cuenta de AWS, consulta [Cuentas](/docs/provider/accounts). | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar redacción en inglés para instrucción de navegación
La frase suena poco natural. Recomiendo una versión más directa para UX de lectura, a las piñas:
✍️ Ajuste propuesto
📝 Committable suggestion
🤖 Prompt for AI Agents